OpenClient
Hereda de: Disposable
Constructores
public OpenClient(string host, uint port)
openClient = OpenClient(host, port)
Crea una instancia de OpenClient que aún no está conectada
- host
- El nombre de host de API endpoint
- port
- El número de puerto anfitrión
Propiedades
public string Host { get; }
value = openClient.Host
El host de endpoint API que el cliente actual está conectado a
public bool IsCompleted { get; private set; }
value = openClient.IsCompleted
openClient.IsCompleted = value
Si el flujo del cliente se completa sin ningún error entonces volverá True, de lo contrario False
public bool IsTerminated { get; private set; }
value = openClient.IsTerminated
openClient.IsTerminated = value
Si hubo algún error (excepción) en el flujo del cliente entonces esto devolverá True, de lo contrario False
public uint Port { get; }
value = openClient.Port
El puerto de host API que el cliente actual está conectado a
Métodos
public Task Connect(CancellationToken cancellationToken)
result = openClient.Connect(cancellationToken)
Conecta con la API basada en el método especificado
Devuelve: Tareas
private Task ConnectTcp(CancellationToken cancellationToken)
result = openClient.ConnectTcp(cancellationToken)
Conecta con API utilizando un cliente TCP
Devuelve: Tareas
protected override void DisposeManaged()
openClient.DisposeManaged()
Desposa al cliente, libera todos los recursos usados y detiene todas las operaciones en ejecución
private static int GetLength(byte[] lengthBytes)
result = OpenClient.GetLength(lengthBytes)
Devuelve la longitud de un mensaje recibido sin causar asignación adicional
- lengthBytes
- El conjunto byte de datos de longitud recibidos
Devuelve: int
private void OnCompleted()
openClient.OnCompleted()
Completa cada observador llamando a su método OnCompleted
private void OnError(Exception exception)
openClient.OnError(exception)
Desposa al cliente y luego llama a cada observador OnError después de una excepción lanzada
- exception
- Excepciones
private Task ReadTcp(CancellationToken cancellationToken)
result = openClient.ReadTcp(cancellationToken)
Este método leerá la secuencia TCP para mensajes entrantes
- cancellationToken
- El token de cancelación que se utilizará en ReadAsyncllamadas
Devuelve: Tareas
public Task SendMessage(ProtoMessage message, CancellationToken cancellationToken)
result = openClient.SendMessage(message, cancellationToken)
Este método insertará su mensaje en la cola de mensajes, no enviará el mensaje al instante
- message
- Mensaje
- cancellationToken
Devuelve: Tareas
public Task SendMessage<T>(T message, ProtoOAPayloadType payloadType, string clientMsgId, CancellationToken cancellationToken)
result = openClient.SendMessage(message, payloadType, clientMsgId, cancellationToken)
Este método insertará su mensaje en la cola de mensajes, no enviará el mensaje al instante
- message
- Mensaje
- payloadType
- Mensaje de carga tipo (ProtoOAPayloadType@)
- clientMsgId
- El ID del mensaje del cliente (opcional)
- cancellationToken
Devuelve: Tareas
public Task SendMessage<T>(T message, string clientMsgId, CancellationToken cancellationToken)
result = openClient.SendMessage(message, clientMsgId, cancellationToken)
Este método insertará su mensaje en la cola de mensajes, no enviará el mensaje al instante Al utilizar esta sobrecarga de SendMessagemétodo evitas pasar el tipo de carga de mensaje y recibe la carga de pago del mensaje mismo
- message
- Mensaje
- clientMsgId
- El ID del mensaje del cliente (opcional)
- cancellationToken
Devuelve: Tareas
public Task SendMessage<T>(T message, ProtoPayloadType payloadType, string clientMsgId, CancellationToken cancellationToken)
result = openClient.SendMessage(message, payloadType, clientMsgId, cancellationToken)
Este método insertará su mensaje en la cola de mensajes, no enviará el mensaje al instante
- message
- Mensaje
- payloadType
- Mensaje de carga tipo (ProtoPayloadType@)
- clientMsgId
- El ID del mensaje del cliente (opcional)
- cancellationToken
Devuelve: Tareas
private void ThrowObjectDisposedExceptionIfDisposed()
openClient.ThrowObjectDisposedExceptionIfDisposed()
Lanza ObjectDisposedException@ si el cliente fue eliminado
private Task WriteTcp(byte[] messageByte, CancellationToken cancellationToken)
result = openClient.WriteTcp(messageByte, cancellationToken)
Escribe el mensaje de bytes a la secuencia TCP
- messageByte
- cancellationToken
- La ficha de cancelación que se utilizará en los métodos de secuencia de llamadas
Devuelve: Tareas
Eventos
public event Action<ProtoMessage> MessageReceived
openClient.MessageReceived += handler
Este evento se activará cuando se reciba un mensaje de la API