nl::Weave::Profiles::WeaveEchoClient

Summary

Constructors and Destructors
WeaveEchoClient(void)

Public types
EchoAckFunct)(void *msgCtxt) typedef
void(*
EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload) typedef
void(*

Public attributes
EncryptionType
uint8_t
ExchangeMgr
FabricState
KeyId
uint16_t
OnAckRcvdReceived
EchoAckFunct
OnEchoResponseReceived
EchoFunct

Public functions
Init(WeaveExchangeManager *exchangeMgr)
SendEchoRequest(WeaveConnection *con, PacketBuffer *payload)
Send an echo request over a WeaveConnection.
SendEchoRequest(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)
Send an echo request to a Weave node using the default Weave port and the letting the system's routing table choose the output interface.
SendEchoRequest(uint64_t nodeId, IPAddress nodeAddr, uint16_t port, InterfaceId sendIntfId, PacketBuffer *payload)
Send an echo request to a Weave node.
SetRequestAck(bool requestAck)
void
SetWRMPACKDelay(uint16_t aWRMPACKDelay)
void
SetWRMPRetransCount(uint8_t aRetransCount)
void
SetWRMPRetransInterval(uint32_t aRetransInterval)
void
Shutdown(void)

Public types

EchoAckFunct

void(* EchoAckFunct)(void *msgCtxt)

EchoFunct

void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)

Public attributes

EncryptionType

uint8_t EncryptionType

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

FabricState

const WeaveFabricState * FabricState

KeyId

uint16_t KeyId

OnAckRcvdReceived

EchoAckFunct OnAckRcvdReceived

OnEchoResponseReceived

EchoFunct OnEchoResponseReceived

Public functions

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

SendEchoRequest

WEAVE_ERROR SendEchoRequest(
  WeaveConnection *con,
  PacketBuffer *payload
)

Send an echo request over a WeaveConnection.

Details
Parameters
con
The connection
payload
A PacketBuffer with the payload. This function takes ownership of the PacketBuffer
Returns
WEAVE_ERROR_NO_MEMORY if no ExchangeContext is available. Other WEAVE_ERROR codes as returned by the lower layers.

SendEchoRequest

WEAVE_ERROR SendEchoRequest(
  uint64_t nodeId,
  IPAddress nodeAddr,
  PacketBuffer *payload
)

Send an echo request to a Weave node using the default Weave port and the letting the system's routing table choose the output interface.

Details
Parameters
nodeId
The destination's nodeId
nodeAddr
The destination's ip address
payload
A PacketBuffer with the payload. This function takes ownership of the PacketBuffer
Returns
WEAVE_ERROR_NO_MEMORY if no ExchangeContext is available. Other WEAVE_ERROR codes as returned by the lower layers.

SendEchoRequest

WEAVE_ERROR SendEchoRequest(
  uint64_t nodeId,
  IPAddress nodeAddr,
  uint16_t port,
  InterfaceId sendIntfId,
  PacketBuffer *payload
)

Send an echo request to a Weave node.

Details
Parameters
nodeId
The destination's nodeId
nodeAddr
The destination's ip address
port
The destination's UDP port (WEAVE_PORT by default)
sendIntfId
A specific interface to use
payload
A PacketBuffer with the payload. This function takes ownership of the PacketBuffer
Returns
WEAVE_ERROR_NO_MEMORY if no ExchangeContext is available. Other WEAVE_ERROR codes as returned by the lower layers.

SetRequestAck

void SetRequestAck(
  bool requestAck
)

SetWRMPACKDelay

void SetWRMPACKDelay(
  uint16_t aWRMPACKDelay
)

SetWRMPRetransCount

void SetWRMPRetransCount(
  uint8_t aRetransCount
)

SetWRMPRetransInterval

void SetWRMPRetransInterval(
  uint32_t aRetransInterval
)

Shutdown

WEAVE_ERROR Shutdown(
  void
)

WeaveEchoClient

 WeaveEchoClient(
  void
)