nl::Weave::Profiles::Echo_Next::WeaveEchoClient

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

Résumé

La classe WeaveEchoClient implémente le côté "initiateur" du protocole Weave Echo. À l'instar du protocole ping ICMP, le protocole Weave Echo peut être utilisé pour tester l'activité et la maniabilité d'un nœud Weave.

Les applications peuvent utiliser la classe WeaveEchoClient pour envoyer des messages EchoRequest uniques ou répétés à un nœud pair identifié par un objet Binding. Une classe correspondante existe pour répondre aux requêtes d'écho (voir WeaveEchoServer).

Liaison client

WeaveEchoClient utilise un objet Binding Weave qui permet d'identifier et d'établir la communication avec le destinataire prévu des requêtes d'écho. La Binding peut être configurée et préparée par l'application avant l'initialisation de l'objet WeaveEchoClient. Elle peut aussi ne pas être préparée, auquel cas le WeaveEchoClient demandera la préparation de la liaison à la demande (voir Binding::RequestPrepare() pour plus de détails).

La préparation à la demande de la liaison sera également demandée en cas d'échec après son passage à l'état "Prêt".

Mode SendRepeating

La méthode SendRepeating() peut être utilisée pour passer WeaveEchoClient en mode SendRepeating. Dans ce mode, l'objet client envoie une séquence répétée de messages EchoRequest au pair à un intervalle configuré. Vous pouvez annuler le mode SendRepeating en appelant la méthode Stop().

Multidiffusion et diffusion

Un objet WeaveEchoClient peut être utilisé pour envoyer simultanément des requêtes EchoRequest à plusieurs destinataires en configurant l'objet Binding avec une adresse de multidiffusion IPv6 ou une adresse de diffusion réseau locale IPv4 (255.255.255.255) appropriée. Lorsque l'objet WeaveEchoClient détecte une adresse homologue de diffusion ou de multidiffusion, il passe automatiquement en mode MultiResponse lors de l'envoi de la requête EchoRequest.

Dans ce mode, l'objet continue d'écouter et de distribuer tous les messages EchoResponse entrants qui arrivent sur le même échange. L'objet reste en mode MultiResponse jusqu'à ce que: 1) l'application appelle Stop() ou Send(), 2) soit en mode SendRepeating, que le temps d'envoyer une autre requête, ou 3) qu'aucune réponse ne soit reçue et que le délai de réception expire.

Événements de l'API

Au cours de son fonctionnement, l'objet WeaveEchoClient appelle l'application pour demander des actions spécifiques ou envoyer des notifications en cas d'événements importants. Ces appels d'événements d'API sont effectués vers la fonction de rappel actuellement configurée sur l'objet client. Sauf indication contraire, les applications sont libres de modifier l'état du client lors d'un rappel d'événement. La méthode Shutdown() de l'objet constitue une exception générale, car elle peut ne jamais être appelée lors d'un rappel.

Les événements d'API suivants sont définis:

PreparePayload

Le client WeaveEchoClient est sur le point de former un message EchoRequest et demande à l'application de fournir une charge utile. Si une application le souhaite, elle peut renvoyer un nouveau PacketBuffer contenant les données de la charge utile. Si l'application ne gère pas cet événement, une EchoRequest avec une charge utile de longueur nulle sera envoyée automatiquement. L'application NE peut PAS modifier l'état du WeaveEchoClient pendant ce rappel.

RequestSent

Un message EchoRequest a été envoyé au pair.

ResponseReceived

Un message EchoResponse a été reçu du pair. Les arguments de l'événement contiennent la charge utile de la réponse et des méta-informations sur le message de réponse.

CommunicationError

Une erreur s'est produite lors de la création ou de l'envoi d'une requête EchoRequest, ou lors de l'attente d'une réponse. Des exemples d'erreurs qui peuvent se produire en attendant une réponse sont les erreurs clés ou la fermeture inattendue d'une connexion. Les arguments de l'événement contiennent le motif de l'erreur.

ResponseTimeout

Aucune réponse EchoResponse n'a été reçue dans les délais impartis. Le délai avant expiration de la réponse est contrôlé par la propriété DefaultResponseTimeout de l'objet Binding.

RequestAborted

Un échange d'écho en cours a été annulé, car une requête a été effectuée pour envoyer une autre requête EchoRequest avant la réception d'une réponse au message précédent. Cela peut se produire en mode SendRepeating lorsque l'heure d'envoi de la prochaine EchoRequest arrive. Cela peut également se produire si l'application appelle Send() après l'envoi d'une requête EchoRequest, mais avant la réception de la réponse.

Lorsque l'objet est en mode MultiResponse, l'événement est supprimé si au moins un message EchoResponse a été reçu.

Types publics

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
)