Guides Happy Reference Resources
GitHub
Reference Specifications

nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler

Summary

Public types
@131 enum
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enum
HandlerId typedef
uint8_t

Public static functions
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Public functions
AbortSubscription(void)
void
This function terminates a subscription immediately - this is a synchronous call.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
This function initiates a graceful shutdown of the subscription and clean-up of the handler object.
GetBinding(void) const
GetMaxNotificationSize(void) const
uint32_t
GetPeerNodeId(void) const
uint64_t
GetSubscriptionId(uint64_t *const apSubscriptionId)
IsAborted()
bool
IsActive(void)
bool
IsEstablishedIdle()
bool
IsFree()
bool
SetMaxNotificationSize(const uint32_t aMaxPayload)
void

Structs
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

Unions
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::OutEventParam

Public types

@131

 @131

EventCallback

void(* EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventID

 EventID

HandlerId

uint8_t HandlerId

Public static functions

DefaultEventHandler

void DefaultEventHandler(
  EventID aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

Public functions

AbortSubscription

void AbortSubscription(
  void
)

This function terminates a subscription immediately - this is a synchronous call.

No attempt is made to notify the client of the termination, and the underlying exchange context if present is aborted immediately. After this call, the application will not be notified of any further activity on this object. Additionally, the application is not allowed to interact with this object thereafter through any of its methods.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

This function initiates a graceful shutdown of the subscription and clean-up of the handler object.

This is an asynchronous call and will notify a client of the impending shutdown through a SubscribeCancel/StatusReport message where relevant.

Notably, this relinquishes the application's involvement in this subscription. After this call, the application will not be notified of any further activity on this object. Additionally, the application is not allowed to interact with this object thereafter through any of its methods.

Details
Parameters
[in] aReasonProfileId
ProfileId of the StatusCode that indicates the reason behind the termination
[in] aReasonStatusCode
StatusCode that indicates the reason behind the termination
Return Values
Returns
a Weave error code for informational purposes only. On any error, the object will be terminated synchronously (i.e aborted).

GetBinding

Binding * GetBinding(
  void
) const

GetMaxNotificationSize

uint32_t GetMaxNotificationSize(
  void
) const

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const

GetSubscriptionId

WEAVE_ERROR GetSubscriptionId(
  uint64_t *const apSubscriptionId
)

IsAborted

bool IsAborted()

IsActive

bool IsActive(
  void
)

IsEstablishedIdle

bool IsEstablishedIdle()

IsFree

bool IsFree()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)