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

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

Diese Klasse stellt eine einzelne Transaktion dar, die vom Dienstmanager verwaltet wird.

Zusammenfassung

Öffentliche Attribute

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
die Schnittstelle, über die die Verbindung eingerichtet werden soll.
mConnectTimeoutMsecs
uint32_t
Das Zeitlimit für den erfolgreichen Verbindungsaufbau oder die Rückgabe eines Fehlers.
mConnection
Eine Verbindung, die hier versteckt werden soll, während sie auf ihren Abschluss wartet.
mConnectionCompleteHandler
Ein Zeiger auf eine Funktion, die aufgerufen wird, wenn eine Verbindung zum Zieldienstendpunkt hergestellt wurde.
mServiceEp
uint64_t
mStatusHandler
Ein Zeiger auf eine Funktion, die beim Empfang eines Statusberichts aufgerufen wird.

Öffentliche Funktionen

finalize(void)
void
Diese Methode bereinigt den internen Status, einschließlich der Verbindungsabbruch.
free(void)
void
Diese Methode gibt ein Verbindungsanfrageobjekt frei und gibt es an den Pool zurück.
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
Diese Methode initialisiert eine ConnectRequest-Instanz mit den übergebenen Argumenten.
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
Diese Funktion prüft, ob diese Verbindungsanfrage derzeit verwendet wird, um eine Verbindung zu einem bestimmten Dienstendpunkt für eine bestimmte Anwendungsentität herzustellen.
isFree(void)
bool
Diese Funktion prüft, ob die Verbindungsanfrage derzeit nicht zugewiesen ist.
onConnectionComplete(WEAVE_ERROR aError)
void
Bei dieser Methode handelt es sich um ein Trampolin zur Anwendungsebene für das Ereignis „Verbindung abgeschlossen“.

Öffentliche Attribute

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

die Schnittstelle, über die die Verbindung eingerichtet werden soll.

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

Das Zeitlimit für den erfolgreichen Verbindungsaufbau oder die Rückgabe eines Fehlers.

mConnection

WeaveConnection * mConnection

Eine Verbindung, die hier versteckt werden soll, während sie auf ihren Abschluss wartet.

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

Ein Zeiger auf eine Funktion, die aufgerufen wird, wenn eine Verbindung zum Zieldienstendpunkt hergestellt wurde.

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

Ein Zeiger auf eine Funktion, die beim Empfang eines Statusberichts aufgerufen wird.

Öffentliche Funktionen

finalize

void finalize(
  void
)

Diese Methode bereinigt den internen Status, einschließlich der Verbindungsabbruch.

Kostenlos

void free(
  void
)

Diese Methode gibt ein Verbindungsanfrageobjekt frei und gibt es an den Pool zurück.

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
)

Diese Methode initialisiert eine ConnectRequest-Instanz mit den übergebenen Argumenten.

Details
Parameter
[in] aManager
Ein Zeiger auf den zugehörigen Dienstmanager.
[in] aServiceEp
Eine ID für den vorgesehenen Dienstendpunkt für diese Verbindungsanfrage.
[in] aAuthMode
Ein Deskriptor für die Authentifizierungsmethode, die für diese Verbindung verwendet werden soll.
[in] aAppState
Ein beliebiger Zeiger, der in Callbacks zurückgegeben wird.
[in] aStatusHandler
Ein Zeiger auf eine Callback-Funktion, die einen Statusbericht als Antwort auf eine Dienstendpunktabfrage verarbeitet.
[in] aCompleteHandler
Ein Zeiger auf die Callback-Funktion, die das Ereignis „Verbindung abgeschlossen“ verarbeitet.
[in] aConnectTimeoutMsecs
Das Zeitlimit für den erfolgreichen Verbindungsaufbau oder die Rückgabe eines Fehlers.
[in] aConnectIntf
Die Schnittstelle, über die die Verbindung hergestellt werden soll.
Rückgabe
WEAVE_NO_ERROR bei Erfolg, andernfalls ein entsprechender Fehlercode.

isAllocatedTo

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

Diese Funktion prüft, ob diese Verbindungsanfrage derzeit verwendet wird, um eine Verbindung zu einem bestimmten Dienstendpunkt für eine bestimmte Anwendungsentität herzustellen.

Details
Parameter
[in] aServiceEp
Eine Dienstendpunkt-ID, die mit dem Inhalt dieser Verbindungsanfrage verglichen werden soll.
[in] aAppState
Ein Zeiger auf den Anwendungsstatus, der für einen Vergleich mit dem Inhalt dieser Verbindungsanfrage verwendet wird.
Rückgabe
„true“, wenn der Test bestanden wurde, andernfalls „false“.

isFree

bool isFree(
  void
)

Diese Funktion prüft, ob die Verbindungsanfrage derzeit nicht zugewiesen ist.

Details
Rückgabe
„true“, wenn der Test bestanden wurde, andernfalls „false“.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Bei dieser Methode handelt es sich um ein Trampolin zur Anwendungsebene für das Ereignis „Verbindung abgeschlossen“.

Er ruft den unter lookupAndConnect() zugewiesenen Handler für die vollständige Verbindung auf.