nl::Weave::Profiles::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 iniciador del protocolo Weave Echo. Al igual que el protocolo de ping ICMP, el protocolo Weave Echo se puede usar para probar el funcionamiento y la accesibilidad de un nodo de Weave.

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

Vinculación del cliente

WeaveEchoClient toma un objeto Binding de Weave que se usa para identificar y establecer comunicación con el destinatario previsto de las solicitudes de eco. La aplicación puede configurar y preparar la Binding antes de la inicialización del objeto WeaveEchoClient o puede dejarse sin preparar, en cuyo caso el WeaveEchoClient solicitará la preparación de la vinculación a pedido (consulta Binding::RequestPrepare() para obtener más detalles).

La preparación de la vinculación a pedido también se solicitará en caso de que falle después de haber ingresado al estado Listo.

Modo SendRepeating

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

Multidifusión y emisión

Se puede usar un objeto WeaveEchoClient para enviar EchoRequests a varios destinatarios de forma simultánea configurando el objeto Binding con una dirección de multidifusión IPv6 o una dirección de transmisión de red local IPv4 (255.255.255.255). Cuando el objeto WeaveEchoClient detecta una dirección de multidifusión o transmisión par, entra automáticamente en el modo MultiResponse cuando se envía la EchoRequest.

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

Eventos de la API

Durante 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 la API se realizan a la función de devolución de llamada configurada actualmente en el objeto de cliente. Excepto cuando se indique lo contrario, las aplicaciones pueden alterar el estado del cliente durante una devolución de llamada de evento. Una excepción general es el método Shutdown() del objeto, al que nunca se lo puede llamar durante una devolución de llamada.

Se definen los siguientes eventos de la API:

PreparePayload

El 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 mostrar un nuevo packageBuffer que contenga los datos de la carga útil. Si la aplicación no controla 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.

RequestSent

Se envió un mensaje EchoRequest al par.

ResponseReceived

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

CommunicationError

Se produjo un error al formar o enviar una EchoRequest, o mientras se esperaba una respuesta. Algunos 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 se controla mediante la propiedad DefaultResponseTimeout en el objeto Binding.

RequestAborted

Se anuló un intercambio Echo en curso porque se realizó una solicitud para enviar otro EchoRequest 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 envió una EchoRequest, pero antes de que se reciba cualquier respuesta.

Cuando el objeto está en modo de respuesta múltiple, el evento se suprime si se recibió 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
)