class SubscriptionClient

Defined at line 63 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

Public Methods

void DefaultEventHandler (EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void DefaultResubscribePolicyCallback (void *const aAppState, ResubscribeParam & aInParam, uint32_t & aOutIntervalMsec)
void InitiateSubscription ()
void InitiateCounterSubscription (const uint32_t aLivenessTimeoutSec)
Binding * GetBinding ()
uint64_t GetPeerNodeId ()
WEAVE_ERROR EndSubscription ()

End the subscription.

When #WDM_ENABLE_SUBSCRIPTION_CANCEL compile-time option is enabled,

gracefully end the subscription by sending a CancelRequest to the peer.

The resources associated with the subscription are freed on response

from the peer or on timeout. When the option is disabled, the call is

equivalent to AbortSubscription().

void AbortSubscription ()

Abort the subscription.

Immediately stop accepting all traffic associated with the subscription,

and release all underlying communication resources. The

SubscriptionClient object itself remains valid and may be used again.

void Free ()

Free this SubscriptionClient object.

Calls AbortSubscription() if necessary and releases the refcount on this

SubscriptionClient object. Under correct usage, this should enable the

object to be returned to the object pool

WEAVE_ERROR GetSubscriptionId (uint64_t *const apSubscriptionId)
void EnableResubscribe (ResubscribePolicyCallback aCallback)
void DisableResubscribe ()
uint32_t GetLivenessTimeoutMsec ()

Defined at line 363 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

void ResetResubscribe ()
void IndicateActivity ()
void SetLivenessTimeoutMsec (uint32_t val)

Defined at line 364 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsInProgressOrEstablished ()

Defined at line 370 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsRetryEnabled ()

Defined at line 375 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsEstablished ()

Defined at line 377 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsEstablishedIdle ()

Defined at line 378 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsFree ()

Defined at line 379 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsCanceling ()

Defined at line 380 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsTerminated ()

Defined at line 381 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

bool IsInResubscribeHoldoff ()

Defined at line 382 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

Enumerations

enum 
Name Value
kNoTimeOut 0
kMaxTimeoutSec 3600000

Defined at line 66 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

enum EventID
Name Value
kEvent_OnSubscriptionTerminated 1
kEvent_OnExchangeStart 2
kEvent_OnSubscribeRequestPrepareNeeded 3
kEvent_OnSubscriptionEstablished 4
kEvent_OnNotificationRequest 5
kEvent_OnNotificationProcessed 6
kEvent_OnEventStreamReceived 7
kEvent_OnSubscriptionActivity 8

Defined at line 75 of file x64-shared/gen/third_party/openweave-core/src/include/Weave/Profiles/data-management/Current/SubscriptionClient.h

Records

Friends

class UpdateEncoder
class UpdateDictionaryDirtyPathCut
class UpdateDirtyPathFilter
class TraitSchemaEngine
class TraitDataSink
class MockWdmSubscriptionInitiatorImpl
class WdmUpdateServerTest
class WdmUpdateEncoderTest
class TestWdm
class TestTdm
class SubscriptionEngine