OpenClient

StockSharp.cTrader.Native

継承元: Disposable

コンストラクター

public OpenClient(string host, uint port)

openClient = OpenClient(host, port)

接続されていないOpenClientのインスタンスを作成します。

host: APIエンドポイントのホスト名
port: ホストポート番号

プロパティ

Host

public string Host { get; }

value = openClient.Host

現在のクライアントが接続されている API エンドポイントホスト

IsCompleted

public bool IsCompleted { get; private set; }

value = openClient.IsCompleted
openClient.IsCompleted = value

クライアントストリームがエラーなしで完了すると、true を返します。そうしないと False が返されます。

IsTerminated

public bool IsTerminated { get; private set; }

value = openClient.IsTerminated
openClient.IsTerminated = value

クライアントストリームにエラー(例外)があった場合、これはtrue、そうでなければFalseを返す

Port

public uint Port { get; }

value = openClient.Port

現在のクライアントが接続している API ホストポート

メソッド

Connect

public Task Connect(CancellationToken cancellationToken)

result = openClient.Connect(cancellationToken)

指定したメソッドに基づいて API に接続します。

戻り値: タスク

ConnectTcp

private Task ConnectTcp(CancellationToken cancellationToken)

result = openClient.ConnectTcp(cancellationToken)

TCP クライアントを使用して API に接続します。

戻り値: タスク

DisposeManaged

protected override void DisposeManaged()

openClient.DisposeManaged()

クライアントを処分し、使用したリソースをすべて解放し、実行中のすべての操作を停止します。

GetLength

private static int GetLength(byte[] lengthBytes)

result = OpenClient.GetLength(lengthBytes)

追加の割り当てを起こさないで受信したメッセージの長さを返します

lengthBytes: バイト配列の受信した長さデータ

戻り値: サインイン

OnCompleted

private void OnCompleted()

openClient.OnCompleted()

それぞれの観察者をOnCompletedメソッドに呼び出して完了

OnError

private void OnError(Exception exception)

openClient.OnError(exception)

クライアントを処分し、例外スローされた後に、各々のオブザーバー@OnErrorを呼び出します

exception: 例外

ReadTcp

private Task ReadTcp(CancellationToken cancellationToken)

result = openClient.ReadTcp(cancellationToken)

このメソッドは、着信メッセージのTCPストリームを読みます

cancellationToken: ReadAsync 呼び出しで使われるキャンセルトークン

戻り値: タスク

SendMessage

public Task SendMessage(ProtoMessage message, CancellationToken cancellationToken)

result = openClient.SendMessage(message, cancellationToken)

メッセージキューにメッセージを入力すると、メッセージが瞬時に送信されない

message: 新着情報
cancellationToken

戻り値: タスク

SendMessage``1

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

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

メッセージキューにメッセージを入力すると、メッセージが瞬時に送信されない

message: 新着情報
payloadType: 電子メールペイロードのタイプ(ProtoOAPayloadType@)
clientMsgId: クライアントメッセージ ID (オプション)
cancellationToken

戻り値: タスク

SendMessage``1

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

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

このメソッドはメッセージキューにメッセージを入力します。メッセージのペイロードタイプを渡すことを避け、メッセージ自体からペイロードを取得するので、このオーバーロードを使用して即座にメッセージを送信しません。

message: 新着情報
clientMsgId: クライアントメッセージ ID (オプション)
cancellationToken

戻り値: タスク

SendMessage``1

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

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

メッセージキューにメッセージを入力すると、メッセージが瞬時に送信されない

message: 新着情報
payloadType: 電子メールペイロードのタイプ(ProtoPayloadType@)
clientMsgId: クライアントメッセージ ID (オプション)
cancellationToken

戻り値: タスク

ThrowObjectDisposedExceptionIfDisposed

private void ThrowObjectDisposedExceptionIfDisposed()

openClient.ThrowObjectDisposedExceptionIfDisposed()

クライアントが処分されたら@ObjectDisposedExceptionを投げる

WriteTcp

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

result = openClient.WriteTcp(messageByte, cancellationToken)

TCP ストリームにメッセージバイトを書き込みます

messageByte
cancellationToken: ストリームメソッドを呼び出す際に使われるキャンセルトークン

戻り値: タスク

イベント

MessageReceived

public event Action<ProtoMessage> MessageReceived

openClient.MessageReceived += handler

APIからメッセージを受信したときにこのイベントがトリガーされます