Erstellen eines eigenen Connectors

Der Nachrichtenmechanismus ist eine interne logische Schicht der StockSharp-Architektur, die die Interaktion zwischen verschiedenen Plattformelementen mithilfe eines Standardprotokolls ermöglicht.

Es gibt zwei Hauptklassen:

Message - eine Nachricht, die Informationen trägt.
AsyncMessageAdapter - ein Nachrichtenadapter (=Konverter).

Eine Nachricht fungiert als Agent, der Informationen übermittelt. Nachrichten haben ihren eigenen Typ MessageTypes. Jeder Nachrichtentyp entspricht einer bestimmten Klasse. Alle Nachrichtenklassen wiederum erben von der abstrakten Klasse Message, die den Nachfolgern Eigenschaften wie den Nachrichtentyp Message.Type und Message.LocalTime - die lokale Zeit der Erstellung/des Empfangs der Nachricht - verleiht.

Nachrichten können eingehend und ausgehend sein:

Eingehende Nachrichten - Nachrichten, die an ein externes System gesendet werden. Dies sind in der Regel vom Programm generierte Befehle, zum Beispiel die Nachricht ConnectMessage - ein Befehl, der eine Verbindung zum Server anfordert.
Ausgehende Nachrichten - Nachrichten, die von einem externen System kommen. Dies sind Nachrichten, die Informationen über Marktdaten, Transaktionen, Portfolios, Verbindungsereignisse usw. übertragen. Zum Beispiel überträgt die Nachricht QuoteChangeMessage Informationen über Änderungen im Orderbuch.

Der Nachrichtenadapter spielt die Rolle eines Vermittlers zwischen dem Handelssystem und dem Programm. Für jeden Connector-Typ gibt es eine separate Adapterklasse, die von der abstrakten Klasse AsyncMessageAdapter erbt.

Der Adapter erfüllt zwei Hauptfunktionen:

Konvertiert eingehende Nachrichten in Befehle eines bestimmten Handelssystems.
Konvertiert Informationen, die vom Handelssystem empfangen werden (Verbindung, Marktdaten, Transaktionen usw.), in ausgehende Nachrichten.

Im Folgenden wird der Prozess der Erstellung eines eigenen Adapters für Coinbase beschrieben (alle Connectoren mit Quellcode sind im StockSharp-Repository verfügbar und werden als Tutorial bereitgestellt).

Beispiel für das Erstellen eines Coinbase-Nachrichtenadapters

1. Erstellen einer Adapterklasse

Zunächst erstellen wir die Nachrichtenadapterklasse CoinbaseMessageAdapter, die von der abstrakten Klasse AsyncMessageAdapter erbt.

public partial class CoinbaseMessageAdapter : AsyncMessageAdapter
{
	private Authenticator _authenticator;
	private HttpClient _restClient;
	private SocketClient _socketClient;

	// Weitere Adapterfelder und -eigenschaften
}

2. Adapter-Konstruktor

Im Adapter-Konstruktor müssen die folgenden Aktionen durchgeführt werden:

Übergeben Sie den Transaktions-ID-Generator, der zur Erstellung von Nachrichten-IDs verwendet wird.
Geben Sie die unterstützten Nachrichtentypen mithilfe der folgenden Methoden an:

AddMarketDataSupport - Unterstützung für Nachrichten zum Abonnieren von Marktdaten.
AddTransactionalSupport - Unterstützung für Transaktionsnachrichten.

Geben Sie die spezifischen, vom Adapter unterstützten Marktdatentypen mithilfe der Methode AddSupportedMarketDataType an.

public CoinbaseMessageAdapter(IdGenerator transactionIdGenerator)
	: base(transactionIdGenerator)
{
	HeartbeatInterval = TimeSpan.FromSeconds(5);

	// Unterstützung für Marktdaten und Transaktionen hinzufügen
	this.AddMarketDataSupport();
	this.AddTransactionalSupport();

	// Nicht unterstützte Nachrichtentypen entfernen
	this.RemoveSupportedMessage(MessageTypes.Portfolio);
	this.RemoveSupportedMessage(MessageTypes.OrderGroupCancel);

	// Unterstützte Marktdatentypen hinzufügen
	this.AddSupportedMarketDataType(DataType.Ticks);
	this.AddSupportedMarketDataType(DataType.MarketDepth);
	this.AddSupportedMarketDataType(DataType.Level1);
	this.AddSupportedMarketDataType(DataType.CandleTimeFrame);
}

3. Verbinden und Trennen des Adapters

Um den Adapter mit dem Handelssystem zu verbinden, wird die Methode AsyncMessageAdapter.ConnectAsync aufgerufen. Ihr wird die eingehende Nachricht ConnectMessage übergeben. Wenn die Verbindung erfolgreich ist, sendet der Adapter eine ausgehende Nachricht ConnectMessage.

public override async ValueTask ConnectAsync(ConnectMessage connectMsg, CancellationToken cancellationToken)
{
	// Vorhandensein der Schlüssel für den Transaktionsmodus prüfen
	if (this.IsTransactional())
	{
		if (Key.IsEmpty())
			throw new InvalidOperationException(LocalizedStrings.KeyNotSpecified);

		if (Secret.IsEmpty())
			throw new InvalidOperationException(LocalizedStrings.SecretNotSpecified);
	}

	// Authentifikator initialisieren
	_authenticator = new(this.IsTransactional(), Key, Secret, Passphrase);

	// Prüfen, dass Clients noch nicht erstellt wurden
	if (_restClient != null)
		throw new InvalidOperationException(LocalizedStrings.NotDisconnectPrevTime);

	if (_socketClient != null)
		throw new InvalidOperationException(LocalizedStrings.NotDisconnectPrevTime);

	// REST-Client erstellen
	_restClient = new(_authenticator) { Parent = this };

	// WebSocket-Client erstellen und konfigurieren
	_socketClient = new(_authenticator, ReConnectionSettings.ReAttemptCount) { Parent = this };
	SubscribePusherClient();

	// WebSocket-Client verbinden
	await _socketClient.Connect(cancellationToken);

	// Nachricht über erfolgreiche Verbindung senden
	SendOutMessage(new ConnectMessage());
}

Um den Adapter vom Handelssystem zu trennen, wird die Methode AsyncMessageAdapter.DisconnectAsync aufgerufen. Wenn die Trennung erfolgreich ist, sendet der Adapter eine ausgehende Nachricht DisconnectMessage.

public override ValueTask DisconnectAsync(DisconnectMessage disconnectMsg, CancellationToken cancellationToken)
{
	// Prüfen, dass Clients erstellt wurden
	if (_restClient == null)
		throw new InvalidOperationException(LocalizedStrings.ConnectionNotOk);

	if (_socketClient == null)
		throw new InvalidOperationException(LocalizedStrings.ConnectionNotOk);

	// REST-Client-Ressourcen freigeben
	_restClient.Dispose();
	_restClient = null;

	// WebSocket-Client trennen
	_socketClient.Disconnect();

	// Trennungsnachricht senden
	SendOutDisconnectMessage(true);
	return default;
}

Darüber hinaus stellt der Adapter die Methode AsyncMessageAdapter.ResetAsync bereit, um den Zustand zurückzusetzen, wodurch die Verbindung geschlossen wird und der Adapter in seinen ursprünglichen Zustand zurückversetzt wird.

public override ValueTask ResetAsync(ResetMessage resetMsg, CancellationToken cancellationToken)
{
	// REST-Client-Ressourcen freigeben
	if (_restClient != null)
	{
		try
		{
			_restClient.Dispose();
		}
		catch (Exception ex)
		{
			SendOutError(ex);
		}

		_restClient = null;
	}

	// WebSocket-Client trennen und bereinigen
	if (_socketClient != null)
	{
		try
		{
			UnsubscribePusherClient();
			_socketClient.Disconnect();
		}
		catch (Exception ex)
		{
			SendOutError(ex);
		}

		_socketClient = null;
	}

	// Authentifikator-Ressourcen freigeben
	if (_authenticator != null)
	{
		try
		{
			_authenticator.Dispose();
		}
		catch (Exception ex)
		{
			SendOutError(ex);
		}

		_authenticator = null;
	}

	// Zusätzliche Daten bereinigen
	_candlesTransIds.Clear();

	// Reset-Nachricht senden
	SendOutMessage(new ResetMessage());
	return default;
}

Nach Abschluss der Entwicklung

Sobald der Connector implementiert ist, gibt es zwei Möglichkeiten, ihn zu verwenden:

Veröffentlichen Sie ihn im StockSharp Store entweder als kostenpflichtiges oder als kostenloses Produkt. In diesem Fall installieren die Benutzer den Connector automatisch über den Installer.
Für den persönlichen Gebrauch kopieren Sie die erstellte Connector-.dll-Datei in den Ordner Ihrer Anwendung (oder eines beliebigen StockSharp-Produkts). Beim Start durchsucht die Anwendung das aktuelle Verzeichnis nach Adaptern anhand der folgenden Kriterien:
- Es werden nur Dateien mit der Erweiterung .dll berücksichtigt, deren Namen mit StockSharp. beginnen.
- Jede verbleibende Datei wird überprüft, um sicherzustellen, dass es sich um eine gültige .NET-Assembly handelt.
- Die Assembly wird geladen, und alle Typen, die IMessageAdapter implementieren, werden gesammelt.
- Alle Fehler, die während des Scannens oder Ladens auftreten, werden im Protokoll festgehalten und stoppen die Suche nicht. Wenn das Laden fehlschlägt, öffnen Sie das Protokollfenster oder die Protokolldatei der Anwendung, um die Fehlerdetails anzuzeigen.

Dieses Dokument beschreibt die allgemeinen Prinzipien der Funktionsweise des Adapters, seiner Erstellung und der Verwaltung der Verbindung mit dem Handelssystem. Die folgenden Dokumente widmen sich der Implementierung der Funktionalität des Adapters: