class SubscriptionHandler

Defined at line 42 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

Public Methods

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

uint64_t GetPeerNodeId ()

Binding * GetBinding ()

WEAVE_ERROR GetSubscriptionId (uint64_t *const apSubscriptionId)

WEAVE_ERROR AcceptSubscribeRequest (const uint32_t aLivenessTimeoutSec)

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.

aReasonProfileId [in] ProfileId of the StatusCode that indicates the reason behind the termination

aReasonStatusCode [in] StatusCode that indicates the reason behind the termination

void AbortSubscription ()

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.

bool IsEstablishedIdle ()

Defined at line 177 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

bool IsActive ()

Defined at line 178 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

bool IsCanceling ()

Defined at line 182 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

bool IsTerminated ()

Defined at line 183 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

bool IsFree ()

Defined at line 184 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

uint32_t GetMaxNotificationSize ()

Defined at line 186 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

void SetMaxNotificationSize (const uint32_t aMaxPayload)

enum

Name	Value
kMaxTimeoutSec	3600000
kNoTimeout	0

Defined at line 47 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

enum EventID

Name	Value
kEvent_OnSubscribeRequestParsed	0
kEvent_OnExchangeStart	1
kEvent_OnSubscriptionEstablished	2
kEvent_OnSubscriptionTerminated	3

Defined at line 68 of file gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionHandler.h

class TestWdm

class TestTdm

class TestSubscriptionHandler

class NotificationEngine

class SubscriptionEngine