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 del iniciador del protocolo Echo de Weave. Al igual que el protocolo ping ICMP, el protocolo Echo de Weave puede usarse para probar el funcionamiento y la accesibilidad de un nodo de 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 echo (consulta WeaveEchoServer).

Vinculación de cliente

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

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

Modo de repetición de llamadas

El método SendRepeating() se puede usar para colocar WeaveEchoClient en el modo SendRepeating. En este modo, el objeto del cliente envía una secuencia repetitiva de mensajes EchoRequest al par en un intervalo configurado. Para cancelar el modo SendRepeating, llama 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. Para ello, se configura el objeto Binding con una dirección de multidifusión IPv6 o IPv4 local (255.255.255.255). Cuando el objeto WeaveEchoClient detecta una dirección de par de transmisión o multidifusión, ingresa automáticamente al modo MultiResponse cuando se envía la EchoRequest.

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

Eventos de la API

Durante el transcurso de su operación, el objeto WeaveEchoClient llamará a la aplicación para solicitar acciones específicas o entregar 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 cuando se indique lo contrario, las aplicaciones tienen la libertad 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, 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.

RequestSent

Se envió un mensaje EchoRequest al par.

ResponseReceived

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

CommunicationError

Se ha producido un error durante la formación o el envío de una EchoRequest, o mientras se espera 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ó 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 de Echo en curso porque se solicitó enviar otra EchoRequest antes de que se recibiera 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 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 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
)