nl::Weave::Binding

Acquisisce la destinazione prevista di una comunicazione Weave e le informazioni di configurazione associate.

Riepilogo

Un oggetto Binding identifica l'obiettivo previsto di una comunicazione Weave (noto anche come "peer"), insieme a un insieme di parametri di configurazione che descrivono come deve avvenire la comunicazione con il peer. Le associazioni sono indipendenti dal protocollo dell'applicazione parlato tra le due parti. In questo modo, catturano il "chi" e il "come" della comunicazione, ma non il "cosa".

Configurazione

Le applicazioni devono configurare un'associazione con parametri specifici per il tipo di canale di comunicazione desiderato. Le associazioni offrono supporto per un'ampia gamma di trasporti di rete, tra cui TCP, UDP, UDP con messaggi Weave Reliable e Weave over BLE (WoBLE). Le applicazioni possono inoltre richiedere l'utilizzo di specifici meccanismi di sicurezza per proteggere i messaggi scambiati tra le parti. Sono incluse le sessioni CASE e PASE e le chiavi di gruppo di applicazioni. L'interfaccia per la configurazione di un'associazione utilizza uno stile dell'API dichiarativa che consente alle applicazioni di indicare i propri requisiti per la comunicazione in termini semplici.

Per ulteriori dettagli, consulta la documentazione di Binding::Configuration.

Preparazione

Prima che la comunicazione abbia luogo, un'associazione deve essere "preparata". La preparazione di un vincolo consiste nello stabilire lo stato necessario affinché la comunicazione abbia luogo. Questi possono includere, ad esempio, la risoluzione dell'indirizzo di rete del peer, la creazione di una connessione di rete e la negoziazione dei token di sicurezza. Una volta configurata dall'applicazione, l'associazione si occupa di tutti i passaggi necessari per preparare la comunicazione, richiamando l'applicazione al termine del processo. In questo modo, le associazioni nascondono i meccanismi della comunicazione, consentendo alle applicazioni di concentrarsi sulle interazioni di alto livello.

Comunicazione

Una volta preparata l'associazione, è pronta per l'uso. In questo stato, le applicazioni (o più comunemente, il codice a livello di protocollo che opera per conto di un'applicazione) richiedono l'associazione per allocare un contesto di scambio Weave. Il contesto di scambio risultante è preconfigurato per la comunicazione, consentendo all'applicazione di avviare immediatamente uno scambio Weave con il peer. L'applicazione può continuare a richiedere contesti di scambio dall'associazione fino alla chiusura dell'associazione o fino alla chiusura del canale di comunicazione sottostante, ad esempio un errore di rete.

Modifiche di stato associazione

Nel corso del suo utilizzo, un'associazione erogherà eventi API all'applicazione per informarla di modifiche allo stato dell'associazione. Ad esempio, una volta completata la preparazione, l'applicazione riceverà un evento che la informa che l'associazione è pronta per l'uso. Analogamente, se il canale di comunicazione sottostante non funziona, viene inviato un evento all'applicazione che informa che l'associazione non è più in stato di pronto.

Gli eventi API vengono inviati all'applicazione tramite una funzione di callback dell'evento fornita al momento dell'allocazione dell'associazione.

Durata associazione

Le associazioni vengono conteggiate per consentirne l'uso condiviso tra più componenti software. Quando viene allocata un'associazione, viene creato un singolo riferimento all'associazione. L'applicazione è responsabile del rilascio di questo riferimento in un determinato momento futuro, in modo che l'associazione sia senza costi per il riutilizzo successivo.

Quando un'applicazione utilizza un Binding, potrebbe chiamare Close() sull'associazione. In questo modo viene rilasciato il riferimento dell'applicazione all'associazione e viene bloccato ogni ulteriore distribuzione di eventi API. Quando viene rilasciato l'ultimo riferimento a un'associazione, questa viene chiusa automaticamente.

Tipi pubblici

 @23

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

 EventType

 State

void * AppState

void AddRef(
  void
)

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

Configuration BeginConfiguration()

bool CanBePrepared(
  void
) const 

void Close(
  void
)

WeaveConnection * GetConnection() const 

uint32_t GetDefaultResponseTimeout() const 

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

uint8_t GetEncryptionType(
  void
) const 

EventCallback GetEventCallback() const 

WeaveExchangeManager * GetExchangeManager() const 

uint32_t GetKeyId(
  void
) const 

uint16_t GetLogId(
  void
) const 

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

uint64_t GetPeerNodeId(
  void
) const 

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

State GetState(
  void
) const 

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

bool IsConnectionTransport() const 

bool IsPreparing(
  void
) const 

bool IsReady(
  void
) const 

bool IsUDPTransport() const 

bool IsUnreliableUDPTransport() const 

bool IsWRMTransport() const 

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

void Release(
  void
)

WEAVE_ERROR RequestPrepare()

void Reset(
  void
)

void SetDefaultResponseTimeout(
  uint32_t msec
)

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

void SetEventCallback(
  EventCallback aEventCallback
)

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)