nl::Weave::Profiles::Echo_Next::WeaveEchoServer

Accepts EchoRequest messages from a peer node and responds with an EchoResponse message.

Résumé

La classe WeaveEchoServer implémente le côté répondant 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 WeaveEchoServer pour activer la réponse automatique aux messages EchoRequest entrants. Une classe correspondante existe pour lancer des requêtes d'écho (voir WeaveEchoClient).

Par défaut, WeaveEchoServer répond immédiatement à une EchoRequest dont la réponse contient la même charge utile que la requête. Cependant, ce comportement peut être modifié par l'application lors du traitement de l'événement API EchoRequestReceived.

Événements de l'API

Au cours de son fonctionnement, l'objet WeaveEchoServer 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 serveur. Sauf indication contraire, les applications sont libres de modifier l'état du serveur 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:

EchoRequestReceived

Un message EchoRequest a été reçu d'un pair. Les arguments de l'événement contiennent la charge utile de la requête, le contexte d'échange dans lequel le message a été reçu et des méta-informations sur le message de requête.

Si l'application le souhaite, elle peut modifier les arguments de sortie de l'événement afin de forcer un délai de réponse ou de supprimer complètement la réponse. En outre, elle peut modifier le contenu du tampon de charge utile, qui deviendra la charge utile du message de réponse.

EchoResponseSent

Un message EchoResponse a été envoyé, ou son envoi a échoué. Les arguments de l'événement contiennent l'erreur résultant de l'envoi du message (le cas échéant) et le contexte d'échange sur lequel le message a été envoyé.

Héritage

Types publics

void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

 EventType

void * AppState

EchoFunct OnEchoRequestReceived

EventCallback GetEventCallback(
  void
) const 

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  EventCallback eventCallback,
  void *appState
)

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

void SetEventCallback(
  EventCallback eventCallback
)

WEAVE_ERROR Shutdown(
  void
)

 WeaveEchoServer(
  void
)

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)