nl::Weave::Profiles::BDX_Development::BdxNode

Podsumowanie

Konstruktory i niszczyciele
BdxNode(void)
Domyślny konstruktor, który ustawia wartość NULL w przypadku wszystkich elementów.

Funkcje publiczne
AllowBdxTransferToRun(bool aEnable)
void
Służy do włączania/wyłączania serwera BDX bez pełnego wyłączania i ponownego uruchamiania go.
AwaitBdxReceiveInit(ReceiveInitHandler aReceiveInitHandler)
AwaitBdxSendInit(SendInitHandler aSendInitHandler)
CanBdxTransferRun(void)
bool
Zwraca wartość „prawda”, jeśli serwer BDX może w tej chwili rozpocząć przesyłanie danych. W przeciwnym razie zwraca wartość „false”.
Init(WeaveExchangeManager *anExchangeMgr)
Ustaw wszystkie transfery w domyślnym stanie gotowości do użycia, zapisz obiekt WeaveExchangeManager i wszystkie inne niezbędne zasoby Weave, a następnie ustawiaj wartość allowBdxTransferToRun(true).
InitBdxReceive(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
IsInitialized(void)
bool
Zwraca wartość „prawda”, jeśli ten obiekt BdxNode został już zainicjowany.
NewTransfer(Binding *aBinding, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
Pobierz i skonfiguruj nowy transfer BDXTransfer z puli transferów, jeśli jest dostępny. W przeciwnym razie ustaw wartość NULL, by zwrócić błąd.
NewTransfer(WeaveConnection *aCon, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
Pobierz i skonfiguruj nowy transfer BDXTransfer z puli transferów, jeśli jest dostępny. W przeciwnym razie ustaw wartość NULL, by zwrócić błąd.
Shutdown(void)
Zamyka wszystkie transfery i zwalnia wszystkie zasoby Weave (obecnie ustawia mExchangeMgr na NULL).

Publiczne funkcje statyczne
HandleReceiveInit(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
HandleSendInit(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
ShutdownTransfer(BDXTransfer *aXfer)
void
Wyłącz dany obiekt transferu i zwróć go do puli.

Funkcje publiczne

AllowBdxTransferToRun

void AllowBdxTransferToRun(
  bool aEnable
)

Służy do włączania/wyłączania serwera BDX bez pełnego wyłączania i ponownego uruchamiania go.

Szczegóły
Parametry
[in] aEnable
Włącz (prawda) lub wyłącz (fałsz)

AwaitBdxReceiveInit

WEAVE_ERROR AwaitBdxReceiveInit(
  ReceiveInitHandler aReceiveInitHandler
)

AwaitBdxSendInit

WEAVE_ERROR AwaitBdxSendInit(
  SendInitHandler aSendInitHandler
)

BdxNode

 BdxNode(
  void
)

Domyślny konstruktor, który ustawia wartość NULL w przypadku wszystkich elementów.

Nie próbuj wykonywać żadnych czynności z serwerem, dopóki nie wywołasz co najmniej funkcji init().

CanBdxTransferRun

bool CanBdxTransferRun(
  void
)

Zwraca wartość „prawda”, jeśli serwer BDX może w tej chwili rozpocząć przesyłanie danych. W przeciwnym razie zwraca wartość „false”.

Szczegóły
Zwroty
true (prawda), jeśli przesyłanie BDX jest dozwolone. Fałsz, jeśli nie jest dozwolone.

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *anExchangeMgr
)

Ustaw wszystkie transfery w domyślnym stanie gotowości do użycia, zapisz obiekt WeaveExchangeManager i wszystkie inne niezbędne zasoby Weave, a następnie ustawiaj wartość allowBdxTransferToRun(true).

Szczegóły
Parametry
[in] anExchangeMgr
Konto menedżera giełdy, które ma być używane w przypadku tej operacji transferu zbiorczego.
Zwracane wartości
WEAVE_NO_ERROR
w przypadku powodzenia
WEAVE_ERROR_INCORRECT_STATE
jeśli funkcja mExchangeMgr nie ma wartości null, została już zainicjowana

InitBdxReceive

WEAVE_ERROR InitBdxReceive(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

IsInitialized

bool IsInitialized(
  void
)

Zwraca wartość „prawda”, jeśli ten obiekt BdxNode został już zainicjowany.

Szczegóły
Zwroty
true, jeśli ten obiekt został zainicjowany

NewTransfer

WEAVE_ERROR NewTransfer(
  Binding *aBinding,
  BDXHandlers aBDXHandlers,
  ReferencedString & aFileDesignator,
  void *anAppState,
  BDXTransfer *& aXfer
)

Pobierz i skonfiguruj nowy transfer BDXTransfer z puli transferów, jeśli jest dostępny. W przeciwnym razie ustaw wartość NULL, by zwrócić błąd.

Szczegóły
Parametry
[in] aBinding
Wiązanie z węzłem, od którego rozpoczniemy przenoszenie. Służy do utworzenia powiązanego kontekstu ExchangeContext na potrzeby tego transferu.
[in] aBDXHandlers
Struktura modułów obsługi wywołań zwrotnych BDX, które mają być wywoływane podczas przesyłania
[in] aFileDesignator
Oznaczenie pliku, który zostanie przeniesiony.
[in] anAppState
Obiekt stanu aplikacji, który należy dołączyć do BDXTransfer, aby wykorzystać go przez aplikację użytkownika i powiązane wywołania zwrotne.
[in] aXfer
Przekazywany wskaźnik referencyjny wskazujący nowy obiekt BDXTransfer, jeśli jest dostępny, a w przeciwnym razie – wartość NULL.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli znaleźliśmy nowy obiekt BDXTransfer,
WEAVE_ERROR_NO_MEMORY
Jeśli nie można utworzyć ExchangeContext
WEAVE_ERROR_TOO_MANY_CONNECTIONS
Jeśli aktywnych jest zbyt wiele transferów, a aXfer ma wartość NULL
WEAVE_ERROR_INCORRECT_STATE
Jeśli powiązanie nie jest przygotowane

NewTransfer

WEAVE_ERROR NewTransfer(
  WeaveConnection *aCon,
  BDXHandlers aBDXHandlers,
  ReferencedString & aFileDesignator,
  void *anAppState,
  BDXTransfer *& aXfer
)

Pobierz i skonfiguruj nowy transfer BDXTransfer z puli transferów, jeśli jest dostępny. W przeciwnym razie ustaw wartość NULL, by zwrócić błąd.

Szczegóły
Parametry
[in] aCon
WeaveConnection w węźle, od którego zainicjujemy transfer. Służy do utworzenia powiązanego kontekstu ExchangeContext na potrzeby tego transferu.
[in] aBDXHandlers
Struktura modułów obsługi wywołań zwrotnych BDX, które mają być wywoływane podczas przesyłania
[in] aFileDesignator
Oznaczenie pliku, który zostanie przeniesiony.
[in] anAppState
Obiekt stanu aplikacji, który należy dołączyć do BDXTransfer, aby wykorzystać go przez aplikację użytkownika i powiązane wywołania zwrotne.
[in] aXfer
Przekazywany wskaźnik referencyjny wskazujący nowy obiekt BDXTransfer, jeśli jest dostępny, a w przeciwnym razie – wartość NULL.
Zwracane wartości
WEAVE_NO_ERROR
Jeśli znaleźliśmy nowy obiekt BDXTransfer,
WEAVE_ERROR_NO_MEMORY
Jeśli nie można utworzyć ExchangeContext
WEAVE_ERROR_TOO_MANY_CONNECTIONS
Jeśli aktywnych jest zbyt wiele transferów, a aXfer ma wartość NULL
WEAVE_ERROR_INCORRECT_STATE
Jeśli funkcja mExchangeMgr nie została jeszcze skonfigurowana lub jeśli aCon nie nawiązano połączenia

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Zamyka wszystkie transfery i zwalnia wszystkie zasoby Weave (obecnie ustawia mExchangeMgr na NULL).

Ustawia element allowBdxTransferToRun(false) i odłącza wszystkie bieżące wywołania zwrotne (na przykład SendInitHandler).

Szczegóły
Zwroty
WEAVE_NO_ERROR w przypadku pomyślnego wyłączenia lub inny błąd, jeśli AwaitBdxSend/ReceiveInit zwróci błąd.

Publiczne funkcje statyczne

HandleReceiveInit

void HandleReceiveInit(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleSendInit

void HandleSendInit(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

ShutdownTransfer

void ShutdownTransfer(
  BDXTransfer *aXfer
)

Wyłącz dany obiekt transferu i zwróć go do puli.

Zastępuje to polecenie BDXTransfer::disabledown()

Szczegóły
Parametry
[in] aXfer
BDXTransfer, który ma zostać wyłączony