nl:: Weave:: Profiles:: ServiceDirectory:: WeaveServiceManager:: ConnectRequest
#include <src/lib/profiles/service-directory/ServiceDirectory.h>
Ta klasa reprezentuje jedną transakcję zarządzaną przez menedżera usługi.
Podsumowanie
Atrybuty publiczne |
|
---|---|
mAppState
|
void *
|
mAuthMode
|
WeaveAuthMode
|
mConnIntf
|
InterfaceId
interfejs, dla którego ma zostać skonfigurowane połączenie.
|
mConnectTimeoutMsecs
|
uint32_t
przekroczono limit czasu oczekiwania na odpowiedź na połączenie Connect lub zwrócenia błędu.
|
mConnection
|
Połączenie, które będzie przechowywane tutaj na czas oczekiwania na zakończenie.
|
mConnectionCompleteHandler
|
Wskaźnik do funkcji, która zostałaby wywołana po zakończeniu połączenia z docelowym punktem końcowym usługi.
|
mServiceEp
|
uint64_t
|
mStatusHandler
|
Wskaźnik do funkcji, która zostałaby wywołana po otrzymaniu raportu o stanie.
|
Funkcje publiczne |
|
---|---|
finalize(void)
|
void
Ta metoda czyści stan wewnętrzny, w tym zamknięcie połączenia.
|
free(void)
|
void
Ta metoda zwalnia obiekt żądania połączenia i zwraca go do puli.
|
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
|
Ta metoda inicjuje instancję ConnectRequest z przekazanymi argumentami.
|
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
|
bool
Ta funkcja sprawdza, czy żądanie połączenia jest obecnie używane do nawiązania połączenia z konkretnym punktem końcowym usługi na potrzeby jednostki aplikacji partnera.
|
isFree(void)
|
bool
Ta funkcja sprawdza, czy żądanie połączenia nie jest obecnie przydzielone.
|
onConnectionComplete(WEAVE_ERROR aError)
|
void
Ta metoda jest warstwą z przeskoku do aplikacji w przypadku zdarzenia zakończenia połączenia.
|
Atrybuty publiczne
mAppState
void * mAppState
mAuthMode
WeaveAuthMode mAuthMode
mConnIntf
InterfaceId mConnIntf
interfejs, dla którego ma zostać skonfigurowane połączenie.
mConnectTimeoutMsecs
uint32_t mConnectTimeoutMsecs
przekroczono limit czasu oczekiwania na odpowiedź na połączenie Connect lub zwrócenia błędu.
mConnection
WeaveConnection * mConnection
Połączenie, które będzie przechowywane tutaj na czas oczekiwania na zakończenie.
mConnectionCompleteHandler
WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler
Wskaźnik do funkcji, która zostałaby wywołana po zakończeniu połączenia z docelowym punktem końcowym usługi.
mServiceEp
uint64_t mServiceEp
mStatusHandler
StatusHandler mStatusHandler
Wskaźnik do funkcji, która zostałaby wywołana po otrzymaniu raportu o stanie.
Funkcje publiczne
finalize
void finalize( void )
Ta metoda czyści stan wewnętrzny, w tym zamknięcie połączenia.
bezpłatnie
void free( void )
Ta metoda zwalnia obiekt żądania połączenia i zwraca go do puli.
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 )
Ta metoda inicjuje instancję ConnectRequest z przekazanymi argumentami.
Szczegóły | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parametry |
|
||||||||||||||||
Zwroty |
WEAVE_NO_ERROR w przypadku powodzenia. W przeciwnym razie wyświetla się odpowiedni kod błędu.
|
isAllocatedTo
bool isAllocatedTo( const uint64_t & aServiceEp, void *aAppState )
Ta funkcja sprawdza, czy żądanie połączenia jest obecnie używane do nawiązania połączenia z konkretnym punktem końcowym usługi na potrzeby jednostki aplikacji partnera.
Szczegóły | |||||
---|---|---|---|---|---|
Parametry |
|
||||
Zwroty |
Wartość „true” (prawda), jeśli test zakończy się powodzeniem, „false” (fałsz) w przeciwnym razie.
|
isFree
bool isFree( void )
Ta funkcja sprawdza, czy żądanie połączenia nie jest obecnie przydzielone.
Szczegóły | |
---|---|
Zwroty |
Wartość „true” (prawda), jeśli test zakończy się powodzeniem, „false” (fałsz) w przeciwnym razie.
|
onConnectionComplete
void onConnectionComplete( WEAVE_ERROR aError )
Ta metoda jest warstwą z przeskoku do aplikacji w przypadku zdarzenia zakończenia połączenia.
Wywołuje on moduł obsługi ukończenia połączenia przypisany w funkcji lookupAndConnect() .