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épondeur du protocole Weave Echo. Tout comme le protocole ping ICMP, le protocole Weave Echo peut être utilisé pour tester l'activité et la joignabilité d'un nœud Weave.

Les applications peuvent utiliser la classe WeaveEchoServer pour activer la réponse automatique aux messages EchoRequest entrants. Il existe une classe correspondante pour initier des requêtes d'écho (voir WeaveEchoClient).

Par défaut, le WeaveEchoServer répond immédiatement à une EchoRequest, avec une réponse contenant la même charge utile que la requête. Toutefois, ce comportement peut être modifié par l'application lors du traitement de l'événement d'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 d'événements importants. Ces appels d'événements d'API sont envoyés à 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. Une exception globale est la méthode Shutdown() de l'objet, qui 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 la requête.

Si l'application le souhaite, elle peut modifier les arguments de sortie de l'événement pour forcer un délai de réponse ou pour supprimer complètement la réponse. En outre, il 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 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 via 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
)