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

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

Ta klasa reprezentuje pojedynczą transakcję zarządzaną przez menedżera usługi.

Podsumowanie

Atrybuty publiczne

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
interfejsu, za pomocą którego zostanie skonfigurowane połączenie.
mConnectTimeoutMsecs
uint32_t
limit czasu, po którym połączenie Connect zakończy się powodzeniem lub zwróci błąd.
mConnection
Połączenie do schowka 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 to żądanie połączenia jest obecnie używane do łączenia się z określonym punktem końcowym usługi dla danej encji aplikacji.
isFree(void)
bool
Ta funkcja sprawdza, czy żądanie połączenia nie jest obecnie przydzielone.
onConnectionComplete(WEAVE_ERROR aError)
void
Metoda ta polega na przechodzeniu z trampoliny do warstwy aplikacji podczas zdarzenia polegającego na zakończeniu połączenia.

Atrybuty publiczne

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

interfejsu, za pomocą którego zostanie skonfigurowane połączenie.

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

limit czasu, po którym połączenie Connect zakończy się powodzeniem lub zwróci błąd.

mConnection

WeaveConnection * mConnection

Połączenie do schowka 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

finalizować

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
[in] aManager
Wskaźnik do menedżera usługi, która go zawiera.
[in] aServiceEp
Identyfikator odpowiedniego punktu końcowego usługi dla tego żądania połączenia.
[in] aAuthMode
Opis metody uwierzytelniania, która powinna być używana w przypadku tego połączenia.
[in] aAppState
Dowolny wskaźnik, który jest zwracany w wywołaniach zwrotnych.
[in] aStatusHandler
Wskaźnik do funkcji wywołania zwrotnego, która obsługuje raport o stanie w odpowiedzi na zapytanie punktu końcowego usługi.
[in] aCompleteHandler
Wskaźnik do funkcji wywołania zwrotnego, która obsługuje zdarzenie zakończenia połączenia.
[in] aConnectTimeoutMsecs
Czas oczekiwania, po którym połączenie Connect zakończy się powodzeniem lub zwróci błąd.
[in] aConnectIntf
Interfejs, za pomocą którego ma zostać nawiązane połączenie.
Zwroty
WEAVE_NO_ERROR po powodzeniu. w przeciwnym razie odpowiedni kod błędu.

isAllocatedTo

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

Ta funkcja sprawdza, czy to żądanie połączenia jest obecnie używane do łączenia się z określonym punktem końcowym usługi dla danej encji aplikacji.

Szczegóły
Parametry
[in] aServiceEp
Identyfikator punktu końcowego usługi do porównania z tym, co zawiera to żądanie połączenia.
[in] aAppState
Wskaźnik do stanu aplikacji używany do porównywania z danymi w tym żądaniu połączenia.
Zwroty
„true” (prawda), jeśli test jest zaliczony. W przeciwnym razie ma wartość „false” (fałsz).

isFree

bool isFree(
  void
)

Ta funkcja sprawdza, czy żądanie połączenia nie jest obecnie przydzielone.

Szczegóły
Zwroty
„true” (prawda), jeśli test jest zaliczony. W przeciwnym razie ma wartość „false” (fałsz).

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

Metoda ta polega na przechodzeniu z trampoliny do warstwy aplikacji podczas zdarzenia polegającego na zakończeniu połączenia.

Wywołuje ona pełny moduł obsługi połączenia przypisany w funkcji lookupAndConnect() .