nl :: Tejido:: Perfiles: Echo_Next :: WeaveEchoClient

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

Resumen

El WeaveEchoClient clase implementa el lado del iniciador del protocolo de la armadura Echo. Similar al protocolo de ping ICMP, el protocolo Weave Echo se puede utilizar para probar la vitalidad y la accesibilidad de un nodo Weave.

Las aplicaciones pueden utilizar la WeaveEchoClient clase para enviar de una sola vez o repetir los mensajes EchoRequest a un nodo par identificado por un Binding objeto. Existe una clase correspondiente para responder a solicitudes de eco (véase WeaveEchoServer ).

cliente Encuadernación

El WeaveEchoClient toma un tejido Binding objeto que se utiliza para identificar y establecer la comunicación con el destinatario previsto de las peticiones de eco. La unión puede ser configurado y preparado por la aplicación antes de la inicialización de la WeaveEchoClient objeto, o puede ser dejado sin preparación, en cuyo caso el WeaveEchoClient solicitará preparación bajo demanda de la unión (ver Encuadernación :: RequestPrepare () para los detalles ).

On-demand preparación de la unión también se pedirá que debe fallar después de haber entrado en el estado Lista.

Enviar Modo de repetición

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

Multidifusión y difusión

A WeaveEchoClient objeto se puede utilizar para enviar EchoRequests a varios destinatarios simultáneamente mediante la configuración de la Binding objeto con una dirección de multidifusión IPv6 correspondiente o IPv4 dirección de difusión de la red local (255.255.255.255). Cuando el WeaveEchoClient objeto detecta una dirección de difusión o multidifusión pares, entra automáticamente en modo de multirespuesta al envío de 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 el modo multirespuesta hasta que: 1) la aplicación llama Stop () o Send () , 2) en el modo de SendRepeating, llega el momento de enviar otra solicitud, o 3) no se recibe respuesta y el tiempo de espera expira recibir.

Eventos API

Durante el curso de su funcionamiento, la WeaveEchoClient objeto llamará a la aplicación de acciones específicas de solicitud o entregar las 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 la devolución de llamada de un evento. Una excepción general es del objeto de apagado () método, que nunca puede ser llamado durante una devolución de llamada.

Se definen los siguientes eventos de API:

PreparePayload

El WeaveEchoClient está a punto de formar un mensaje de EchoRequest y está solicitando la aplicación para suministrar 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 la 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 la 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 Binding objeto.

Solicitud cancelada

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 ocurrir si la aplicación llama a send () después de una EchoRequest ha sido enviado, pero antes de que se recibió ninguna respuesta.

Cuando el objeto está en modo de respuesta múltiple, el evento se suprime si se ha recibido al menos un mensaje de respuesta de eco.

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
)