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

Zusammenfassung

Konstruktoren und Zerstörer
BdxNode(void)
Standardkonstruktor, der alle Mitglieder auf NULL setzt.

Öffentliche Funktionen
AllowBdxTransferToRun(bool aEnable)
void
Verwenden Sie diese Schaltfläche zum Aktivieren/Deaktivieren des BDX-Servers, ohne ihn vollständig herunterzufahren und neu zu starten.
AwaitBdxReceiveInit(ReceiveInitHandler aReceiveInitHandler)
AwaitBdxSendInit(SendInitHandler aSendInitHandler)
CanBdxTransferRun(void)
bool
Gibt „true“ zurück, wenn der BDX-Server zu diesem Zeitpunkt eine Übertragung starten darf, andernfalls „false“.
Init(WeaveExchangeManager *anExchangeMgr)
Versetzen Sie alle Übertragungen in einen Standardzustand, der verwendet werden kann, speichern Sie WeaveExchangeManager und alle anderen erforderlichen Weave-Ressourcen und legen Sie „allowBdxTransferToRun(true)“ fest.
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
Gibt "true" zurück, wenn dieser BdxNode bereits initialisiert wurde.
NewTransfer(Binding *aBinding, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
Rufen Sie, falls verfügbar, ein neues BDXTransfer aus dem Übertragungspool ab und richten Sie es ein, oder setzen Sie andernfalls auf NULL und geben Sie einen Fehler zurück.
NewTransfer(WeaveConnection *aCon, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
Rufen Sie, falls verfügbar, ein neues BDXTransfer aus dem Übertragungspool ab und richten Sie es ein, oder setzen Sie andernfalls auf NULL und geben Sie einen Fehler zurück.
Shutdown(void)
Beendet alle Übertragungen und gibt alle Weave-Ressourcen frei. Der Wert wird derzeit für mExchangeMgr auf NULL gesetzt.

Öffentliche statische Funktionen
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
Fahren Sie das angegebene Übertragungsobjekt herunter und geben Sie es an den Pool zurück.

Öffentliche Funktionen

AllowBdxTransferToRun

void AllowBdxTransferToRun(
  bool aEnable
)

Verwenden Sie diese Schaltfläche zum Aktivieren/Deaktivieren des BDX-Servers, ohne ihn vollständig herunterzufahren und neu zu starten.

Details
Parameter
[in] aEnable
Aktivieren (wahr) oder deaktivieren (falsch)

AwaitBdxReceiveInit

WEAVE_ERROR AwaitBdxReceiveInit(
  ReceiveInitHandler aReceiveInitHandler
)

AwaitBdxSendInit

WEAVE_ERROR AwaitBdxSendInit(
  SendInitHandler aSendInitHandler
)

BdxNode

 BdxNode(
  void
)

Standardkonstruktor, der alle Mitglieder auf NULL setzt.

Versuchen Sie erst dann etwas mit dem Server zu tun, wenn Sie zumindest init() aufgerufen haben.

CanBdxTransferRun

bool CanBdxTransferRun(
  void
)

Gibt „true“ zurück, wenn der BDX-Server zu diesem Zeitpunkt eine Übertragung starten darf, andernfalls „false“.

Details
Rückgabe
„true“, wenn die BDX-Übertragung zulässig ist, „false“, wenn nicht

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *anExchangeMgr
)

Versetzen Sie alle Übertragungen in einen Standardzustand, der verwendet werden kann, speichern Sie WeaveExchangeManager und alle anderen erforderlichen Weave-Ressourcen und legen Sie „allowBdxTransferToRun(true)“ fest.

Details
Parameter
[in] anExchangeMgr
Ein Anzeigenplattform-Manager für diesen Bulk-Übertragungsvorgang.
Rückgabewerte
WEAVE_NO_ERROR
falls erfolgreich
WEAVE_ERROR_INCORRECT_STATE
wenn mExchangeMgr nicht null ist, ist bereits initialisiert.

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
)

Gibt "true" zurück, wenn dieser BdxNode bereits initialisiert wurde.

Details
Rückgabe
„true“, wenn dieses Objekt initialisiert wurde

NewTransfer

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

Rufen Sie, falls verfügbar, ein neues BDXTransfer aus dem Übertragungspool ab und richten Sie es ein, oder setzen Sie andernfalls auf NULL und geben Sie einen Fehler zurück.

Details
Parameter
[in] aBinding
Das Binding an den Knoten, mit dem die Übertragung gestartet wird. Damit wird ein verknüpfter ExchangeContext für diese Übertragung erstellt.
[in] aBDXHandlers
Eine Struktur von BDX-Callback-Handlern, die während der Übertragung aufgerufen werden
[in] aFileDesignator
Der Dateibezeichner für die zu übertragende Datei.
[in] anAppState
Ein anwendungsspezifisches Statusobjekt, das zur Verwendung durch die Nutzeranwendung und zugehörige Callbacks an BDXTransfer angehängt wird.
[in] aXfer
Ein von Verweis-URL weitergegebener Zeiger, der auf das neue BDXTransfer-Objekt verweist, sofern eines verfügbar ist, andernfalls NULL.
Rückgabewerte
WEAVE_NO_ERROR
Wenn ein neuer BDXTransfer gefunden wurde.
WEAVE_ERROR_NO_MEMORY
Wenn ExchangeContext nicht erstellt werden kann
WEAVE_ERROR_TOO_MANY_CONNECTIONS
Wenn zu viele Übertragungen derzeit aktiv sind und aXfer den Wert NULL hat
WEAVE_ERROR_INCORRECT_STATE
Wenn aBinding nicht vorbereitet ist

NewTransfer

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

Rufen Sie, falls verfügbar, ein neues BDXTransfer aus dem Übertragungspool ab und richten Sie es ein, oder setzen Sie andernfalls auf NULL und geben Sie einen Fehler zurück.

Details
Parameter
[in] aCon
Die WeaveConnection zu dem Knoten, mit dem die Übertragung gestartet wird. Damit wird ein verknüpfter ExchangeContext für diese Übertragung erstellt.
[in] aBDXHandlers
Eine Struktur von BDX-Callback-Handlern, die während der Übertragung aufgerufen werden
[in] aFileDesignator
Der Dateibezeichner für die zu übertragende Datei.
[in] anAppState
Ein anwendungsspezifisches Statusobjekt, das zur Verwendung durch die Nutzeranwendung und zugehörige Callbacks an BDXTransfer angehängt wird.
[in] aXfer
Ein von Verweis-URL weitergegebener Zeiger, der auf das neue BDXTransfer-Objekt verweist, sofern eines verfügbar ist, andernfalls NULL.
Rückgabewerte
WEAVE_NO_ERROR
Wenn ein neuer BDXTransfer gefunden wurde.
WEAVE_ERROR_NO_MEMORY
Wenn ExchangeContext nicht erstellt werden kann
WEAVE_ERROR_TOO_MANY_CONNECTIONS
Wenn zu viele Übertragungen derzeit aktiv sind und aXfer den Wert NULL hat
WEAVE_ERROR_INCORRECT_STATE
Wenn mExchangeMgr noch nicht festgelegt wurde oder wenn aCon keine erfolgreiche Verbindung hergestellt hat

Herunterfahren

WEAVE_ERROR Shutdown(
  void
)

Beendet alle Übertragungen und gibt alle Weave-Ressourcen frei. Der Wert wird derzeit für mExchangeMgr auf NULL gesetzt.

Legt „AllowBdxTransferToRun(false)“ fest und trennt alle aktuellen Callbacks (z. B. SendInitHandler).

Details
Rückgabe
WEAVE_NO_ERROR bei erfolgreichem Herunterfahren; anderer Fehler, wenn AwaitBdxSend/ReceiveInit einen Fehler zurückgibt

Öffentliche statische Funktionen

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
)

Fahren Sie das angegebene Übertragungsobjekt herunter und geben Sie es an den Pool zurück.

Dies wird einfach auf BDXTransfer::Herunterfahren() übertragen.

Details
Parameter
[in] aXfer
Das herunterzufahrende BDXTransfer