OpenClient

StockSharp.cTrader.Native

Erbt von: Disposable

Konstruktoren

public OpenClient(string host, uint port)

openClient = OpenClient(host, port)

Erstellt eine Instanz von OpenClient, die noch nicht verbunden ist

host: Der Hostname des API-Endpunkts
port: Die Host-Port-Nummer

Eigenschaften

Host

public string Host { get; }

value = openClient.Host

Der API-Endpunkt-Host, mit dem der aktuelle Client verbunden ist

IsCompleted

public bool IsCompleted { get; private set; }

value = openClient.IsCompleted
openClient.IsCompleted = value

Wenn der Client-Stream ohne Fehler abgeschlossen ist, wird er True zurückgeben, andernfalls False

IsTerminated

public bool IsTerminated { get; private set; }

value = openClient.IsTerminated
openClient.IsTerminated = value

Wenn es einen Fehler (Ausnahme) im Client-Stream gab, wird dies True, andernfalls False zurückgeben

Port

public uint Port { get; }

value = openClient.Port

Der API-Hostport, mit dem der aktuelle Client verbunden ist

Methoden

Connect

public Task Connect(CancellationToken cancellationToken)

result = openClient.Connect(cancellationToken)

Verbinden Sie sich mit der API basierend auf Ihrer angegebenen Methode

Rückgabe: Aufgabe

ConnectTcp

private Task ConnectTcp(CancellationToken cancellationToken)

result = openClient.ConnectTcp(cancellationToken)

Verbinden mit API mit einem TCP-Client

Rückgabe: Aufgabe

DisposeManaged

protected override void DisposeManaged()

openClient.DisposeManaged()

Entsorgt den Client, gibt alle verwendeten Ressourcen frei und stoppt alle laufenden Operationen

GetLength

private static int GetLength(byte[] lengthBytes)

result = OpenClient.GetLength(lengthBytes)

Gibt die Länge einer empfangenen Nachricht zurück, ohne dass eine zusätzliche Zuweisung verursacht wird

lengthBytes: Das Byte-Array der empfangenen Längendaten

Rückgabe: int

OnCompleted

private void OnCompleted()

openClient.OnCompleted()

Vervollständigt jeden Beobachter, indem er seine OnCompleted-Methode aufruft

OnError

private void OnError(Exception exception)

openClient.OnError(exception)

Entsorgt den Client und ruft dann jeden Beobachter OnError nach einer Ausnahme geworfen

exception: Ausnahme

ReadTcp

private Task ReadTcp(CancellationToken cancellationToken)

result = openClient.ReadTcp(cancellationToken)

Diese Methode liest den TCP-Stream für eingehende Nachrichten

cancellationToken: Das Stornierungstoken, das bei ReadAsync @ Anrufen verwendet wird

Rückgabe: Aufgabe

SendMessage

public Task SendMessage(ProtoMessage message, CancellationToken cancellationToken)

result = openClient.SendMessage(message, cancellationToken)

Diese Methode wird Ihre Nachricht in die Nachrichten-Warteschlange einfügen, es wird nicht sofort die Nachricht senden

message: Nachricht
cancellationToken

Rückgabe: Aufgabe

SendMessage``1

public Task SendMessage<T>(T message, ProtoOAPayloadType payloadType, string clientMsgId, CancellationToken cancellationToken)

result = openClient.SendMessage(message, payloadType, clientMsgId, cancellationToken)

Diese Methode wird Ihre Nachricht in die Nachrichten-Warteschlange einfügen, es wird nicht sofort die Nachricht senden

message: Nachricht
payloadType: Payload-Typ der Nachricht (ProtoOAPayloadType)
clientMsgId: Die Client Message ID (optional)
cancellationToken

Rückgabe: Aufgabe

SendMessage``1

public Task SendMessage<T>(T message, string clientMsgId, CancellationToken cancellationToken)

result = openClient.SendMessage(message, clientMsgId, cancellationToken)

Diese Methode wird Ihre Nachricht in Nachrichten-Warteschlange einfügen, es wird die Nachricht nicht sofort senden Durch die Verwendung dieser Überlastung von SendMessage @ Methode vermeiden Sie das Übergeben der Nachricht Nutzlast und es erhält die Nutzlast von der Nachricht selbst

message: Nachricht
clientMsgId: Die Client Message ID (optional)
cancellationToken

Rückgabe: Aufgabe

SendMessage``1

public Task SendMessage<T>(T message, ProtoPayloadType payloadType, string clientMsgId, CancellationToken cancellationToken)

result = openClient.SendMessage(message, payloadType, clientMsgId, cancellationToken)

Diese Methode wird Ihre Nachricht in die Nachrichten-Warteschlange einfügen, es wird nicht sofort die Nachricht senden

message: Nachricht
payloadType: Payload-Typ der Nachricht (ProtoPayloadType)
clientMsgId: Die Client Message ID (optional)
cancellationToken

Rückgabe: Aufgabe

ThrowObjectDisposedExceptionIfDisposed

private void ThrowObjectDisposedExceptionIfDisposed()

openClient.ThrowObjectDisposedExceptionIfDisposed()

Wirft ObjectDisposedException, wenn der Client entsorgt wurde

WriteTcp

private Task WriteTcp(byte[] messageByte, CancellationToken cancellationToken)

result = openClient.WriteTcp(messageByte, cancellationToken)

Schreibt die Nachrichtenbytes in den TCP-Stream

messageByte
cancellationToken: Das Stornierungstoken, das bei Aufrufen von Stream-Methoden verwendet wird

Rückgabe: Aufgabe

Ereignisse

MessageReceived

public event Action<ProtoMessage> MessageReceived

openClient.MessageReceived += handler

Dieses Ereignis wird ausgelöst, wenn eine Nachricht von der API empfangen wird