nl::Weave::Echo_Next::Echo_Next::Weave

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 ICMP, el protocolo Eave 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 recurrentes de EchoRequest a un nodo de par identificado con 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 utiliza para identificar y establecer la 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 se puede dejar sin preparar; en ese caso, WeaveEchoClient solicitará la preparación a pedido de la vinculación (consulte Binding::RequestPrepare() para obtener más detalles).

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

Modo de repetición de envío

Se puede usar el método SendRepeating() para poner WeaveEchoClient en el 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 transmisión

Se puede usar un objeto WeaveEchoClient para enviar EchoRequests simultáneamente a varios destinatarios. Para ello, se debe configurar el objeto Binding con una dirección IPv6 o de transmisión local de IPv4 adecuada (255.255.255.255). Cuando el objeto WeaveEchoClient detecta una dirección de intercambio de tráfico multidifusión o de emisión, ingresa automáticamente en el modo MultiResponse al enviar la EchoRequest.

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

Eventos de API

Durante el funcionamiento del objeto, WeaveEchoClient llamará a la aplicación para solicitar acciones específicas o enviar notificaciones de eventos importantes. Estas llamadas de evento de la 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 pueden modificar 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 puede llamar durante una devolución de llamada.

Se definen los siguientes eventos de la 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 mostrar un nuevo PacketBuffer que contenga los datos de carga útil. Si la aplicación no controla este evento, se enviará automáticamente una EchoRequest con una carga útil de longitud cero. Es posible que la aplicación NO altere el estado de WeaveEchoClient durante esta devolución de llamada.

Se envió la solicitud.

Se envió un mensaje EchoRequest al par.

Respuesta recibida

Se recibió un mensaje de ecorespuesta 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 cuando se formó o envió una EchoRequest o mientras se esperaba una respuesta. Algunos ejemplos de errores que pueden ocurrir mientras esperas una respuesta son errores clave o un cierre inesperado de una conexión. Los argumentos del evento contienen el motivo del error.

Tiempo de espera de respuesta

No se recibió una ecorespuesta en el tiempo asignado. La propiedad DefaultResponseTimeout controla el tiempo de espera de respuesta del objeto Binding.

Solicitud anulada

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

Cuando el objeto está en modo MultiResponse, el evento se suprime si se recibe al menos un mensaje de ecorespuesta.

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
)