nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

Cette classe représente une transaction unique gérée par le gestionnaire de services.

Résumé

Attributs publics

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
l'interface sur laquelle la connexion doit être configurée.
mConnectTimeoutMsecs
uint32_t
le délai avant expiration de l'appel Connect pour réussir ou renvoyer une erreur.
mConnection
Une connexion à cacher ici en attendant qu'elle soit terminée.
mConnectionCompleteHandler
Pointeur vers une fonction qui sera appelée une fois la connexion au point de terminaison du service de destination terminée.
mServiceEp
uint64_t
mStatusHandler
Pointeur vers une fonction appelée à la réception d'un rapport d'état.

Fonctions publiques

finalize(void)
void
Cette méthode nettoie l'état interne, y compris la fermeture de la connexion.
free(void)
void
Cette méthode libère un objet de requête de connexion et le renvoie au pool.
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
Cette méthode initialise une instance ConnectRequest avec les arguments transmis.
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
Cette fonction teste si cette requête de connexion est actuellement utilisée pour se connecter à un point de terminaison de service particulier pour une entité d'application particulière.
isFree(void)
bool
Cette fonction teste si la requête de connexion n'est pas actuellement allouée.
onConnectionComplete(WEAVE_ERROR aError)
void
Cette méthode permet de passer de trampoline à la couche d'application pour l'événement de connexion terminée.

Attributs publics

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

l'interface sur laquelle la connexion doit être configurée.

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

le délai avant expiration de l'appel Connect pour réussir ou renvoyer une erreur.

mConnection

WeaveConnection * mConnection

Une connexion à cacher ici en attendant qu'elle soit terminée.

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

Pointeur vers une fonction qui sera appelée une fois la connexion au point de terminaison du service de destination terminée.

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

Pointeur vers une fonction appelée à la réception d'un rapport d'état.

Fonctions publiques

finalize

void finalize(
  void
)

Cette méthode nettoie l'état interne, y compris la fermeture de la connexion.

gratuit

void free(
  void
)

Cette méthode libère un objet de requête de connexion et le renvoie au pool.

init

WEAVE_ERROR init(
  WeaveServiceManager *aManager,
  const uint64_t & aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnIntf
)

Cette méthode initialise une instance ConnectRequest avec les arguments transmis.

Détails
Paramètres
[in] aManager
Pointeur vers le gestionnaire de services associé.
[in] aServiceEp
ID du point de terminaison de service prévu pour cette requête de connexion.
[in] aAuthMode
Descripteur de la méthode d'authentification à utiliser pour cette connexion.
[in] aAppState
Pointeur arbitraire qui serait renvoyé dans les rappels.
[in] aStatusHandler
Pointeur vers une fonction de rappel qui gère un rapport d'état en réponse à une requête de point de terminaison de service.
[in] aCompleteHandler
Pointeur vers la fonction de rappel qui gère l'événement de connexion terminée.
[in] aConnectTimeoutMsecs
Délai avant expiration de l'appel Connect pour réussir ou renvoyer une erreur.
[in] aConnectIntf
Interface sur laquelle la connexion doit être établie.
Renvoie
WEAVE_NO_ERROR en cas de réussite ; Sinon, un code d'erreur respectif.

isAllocatedTo

bool isAllocatedTo(
  const uint64_t & aServiceEp,
  void *aAppState
)

Cette fonction teste si cette requête de connexion est actuellement utilisée pour se connecter à un point de terminaison de service particulier pour une entité d'application particulière.

Détails
Paramètres
[in] aServiceEp
ID de point de terminaison du service à comparer à ce que contient cette requête de connexion.
[in] aAppState
Pointeur vers l'état de l'application, qui permet de le comparer à ce que contient cette requête de connexion.
Renvoie
La valeur est "true" si le test réussit, ou "false" dans le cas contraire.

isFree

bool isFree(
  void
)

Cette fonction teste si la requête de connexion n'est pas actuellement allouée.

Détails
Renvoie
La valeur est "true" si le test réussit, ou "false" dans le cas contraire.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Cette méthode permet de passer de trampoline à la couche d'application pour l'événement de connexion terminée.

Il appelle le gestionnaire de fin de connexion attribué à l'étape lookupAndConnect() .