nl :: Tejer :: Perfiles: Echo_Next :: WeaveEchoClient

Provides the ability to send Weave EchoRequest messages to a peer node and receive
the corresponding EchoResponse messages.

Resumen

La clase WeaveEchoClient implementa el lado del iniciador del protocolo Weave Echo. De forma similar al protocolo de ping ICMP, el protocolo Weave Echo se puede utilizar para probar la vivacidad y la accesibilidad de un nodo Weave.

Las aplicaciones pueden usar la clase WeaveEchoClient para enviar mensajes EchoRequest únicos o repetidos a un nodo par identificado por un objeto Binding . Existe una clase correspondiente para responder a las solicitudes de eco (consulte WeaveEchoServer ).

Vinculación del cliente

WeaveEchoClient toma un objeto Weave Binding que se utiliza para identificar y establecer comunicación con el destinatario previsto de las solicitudes de eco. El enlace puede ser configurado y preparado por la aplicación antes de la inicialización del objeto WeaveEchoClient , o puede dejarse sin preparar, en cuyo caso el WeaveEchoClient solicitará la preparación del enlace bajo demanda (consulte Binding :: RequestPrepare () para más detalles ).

También se solicitará la preparación a pedido del enlace si falla después de haber entrado en el estado Listo.

Enviar Modo de repetición

El método SendRepeating () se puede utilizar para poner WeaveEchoClient en modo SendRepeating. En este modo, el objeto cliente envía una secuencia repetida de mensajes EchoRequest al par en un intervalo configurado. El modo SendRepeating se puede cancelar llamando al método Stop () .

Multidifusión y difusión

Se puede usar un objeto WeaveEchoClient para enviar EchoRequests a múltiples destinatarios simultáneamente configurando el objeto Binding con una dirección de multidifusión IPv6 apropiada o una dirección de difusión de red local IPv4 (255.255.255.255). Cuando el objeto WeaveEchoClient detecta una dirección de pares de difusión o multidifusión, ingresa automáticamente al modo de respuesta múltiple al enviar la EchoRequest.

En este modo, el objeto continúa escuchando y entregando todos los mensajes EchoResponse entrantes que llegan al mismo intercambio. El objeto permanece en modo MultiResponse hasta que: 1) la aplicación llama a Stop () o Send () , 2) en modo SendRepeating, llega el momento de enviar otra solicitud, o 3) no se recibe respuesta y el tiempo de espera de recepción expira.

Eventos API

Durante el curso de su funcionamiento, el objeto WeaveEchoClient llamará a la aplicación para solicitar acciones específicas o enviar notificaciones de eventos importantes. Estas llamadas de eventos de API se realizan a la función de devolución de llamada configurada actualmente en el objeto de cliente. Excepto donde se indique, las aplicaciones son libres de alterar el estado del cliente durante una devolución de llamada de evento. Una excepción general es el método Shutdown () del objeto, que nunca se puede llamar durante una devolución de llamada.

Se definen los siguientes eventos de API:

PreparePayload

WeaveEchoClient está a punto de formar un mensaje EchoRequest y solicita a la aplicación que proporcione una carga útil. Si una aplicación lo desea, puede devolver un nuevo PacketBuffer que contiene los datos de la carga útil. Si la aplicación no maneja este evento, se enviará automáticamente una EchoRequest con una carga útil de longitud cero. La aplicación NO PUEDE alterar el estado de WeaveEchoClient durante esta devolución de llamada.

Solicitud enviada

Se envió un mensaje EchoRequest al par.

Respuesta recibida

Se recibió un mensaje EchoResponse del par. Los argumentos del evento contienen la carga útil de respuesta y la metainformación sobre el mensaje de respuesta.

Error de comunicación

Se produjo un error mientras se formaba o enviaba una EchoRequest, o mientras esperaba una respuesta. Ejemplos de errores que pueden ocurrir mientras se espera una respuesta son los errores clave o el cierre inesperado de una conexión. Los argumentos del evento contienen el motivo del error.

ResponseTimeout

No se recibió una EchoResponse en el tiempo asignado. El tiempo de espera de respuesta está controlado por la propiedad DefaultResponseTimeout en el objeto Binding .

RequestAborted

Se canceló un intercambio de eco en curso porque se hizo una solicitud para enviar otra solicitud de eco antes de recibir una respuesta al mensaje anterior. Esto puede surgir en el modo SendRepeating cuando llega el momento de enviar la siguiente EchoRequest. Esto también puede suceder si la aplicación llama a Send () después de que se haya enviado una EchoRequest pero antes de que se reciba una respuesta.

Cuando el objeto está en modo MultiResponse, el evento se suprime si se ha recibido al menos un mensaje EchoResponse.

Tipos públicos

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

 EventType

 State

void * AppState

Binding * GetBinding(
  void
) const 

EventCallback GetEventCallback(
  void
) const 

State GetState(
  void
) const 

WEAVE_ERROR Init(
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

bool IsSendRrepeating() const 

bool RequestInProgress() const 

WEAVE_ERROR Send(
  void
)

WEAVE_ERROR Send(
  PacketBuffer *payloadBuf
)

WEAVE_ERROR SendRepeating(
  uint32_t sendIntervalMS
)

void SetEventCallback(
  EventCallback eventCallback
)

void Shutdown(
  void
)

void Stop(
  void
)

 WeaveEchoClient(
  void
)

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)