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

Сводка

Общедоступные типы
@142 enum : перечисление
EventCallback)(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID enum : перечисление
HandlerId typedef
uint8_t

Общедоступные статические функции
DefaultEventHandler(EventID aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void

Общественные функции
AbortSubscription(void)
void
Эта функция немедленно прекращает подписку. Это синхронный вызов.
AcceptSubscribeRequest(const uint32_t aLivenessTimeoutSec)
EndSubscription(const uint32_t aReasonProfileId, const uint16_t aReasonStatusCode)
Эта функция инициирует корректное завершение работы подписки и очистку объекта обработчика.
GetBinding(void) const
GetMaxNotificationSize(void) const
uint32_t
GetPeerNodeId(void) const
uint64_t
GetSubscriptionId(uint64_t *const apSubscriptionId)
IsActive(void)
bool
IsCanceling() const
bool
IsEstablishedIdle()
bool
IsFree()
bool
IsTerminated()
bool
SetMaxNotificationSize(const uint32_t aMaxPayload)
void

Структуры
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::TraitInstanceInfo

Профсоюзы
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::InEventParam
nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler::OutEventParam

Общедоступные типы

@142

 @142

EventCallback

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

EventID

 EventID

HandlerId

uint8_t HandlerId

Общедоступные статические функции

DefaultEventHandler

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

Общественные функции

AbortSubscription

void AbortSubscription(
  void
)

Эта функция немедленно прекращает подписку. Это синхронный вызов.

Отменить подписку издателя.

Клиент не получает уведомления о прекращении, а контекст обмена, если он есть, немедленно прерывается. После этого вызова приложение не будет получать уведомления о дальнейших действиях с этим объектом. Кроме того, после этого приложение не сможет взаимодействовать с объектом с помощью каких-либо методов.

Прекращает подписку со стороны издателя, не уведомляя клиента подписки и не доставляя событие OnSubscriptionTerminated обработчику событий приложения. Если существует взаимная подписка, то встречная подписка издателя на клиента также прекращается.

При вызове AbortSubscription() объект SubscriptionHandler переходит в состояние Terminated. Если после завершения процесса прекращения на объект больше нет ссылок, объект SubscriptionHandler освобождается.

AcceptSubscribeRequest

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

EndSubscription

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

Эта функция инициирует корректное завершение работы подписки и очистку объекта обработчика.

Корректно завершать подписку издателя.

Это асинхронный вызов, который уведомляет клиента о предстоящем отключении с помощью сообщения SubscribeCancel/StatusReport, если это применимо.

В частности, это отменяет участие приложения в этой подписке. После этого вызова приложение не будет получать уведомления о дальнейших действиях с этим объектом. Кроме того, после этого приложение не сможет взаимодействовать с объектом с помощью каких-либо методов.

Корректно завершает подписку со стороны издателя. Если поддержка отмены подписки включена, клиенту подписки отправляется сообщение SubscribeCancelRequest, и система ожидает ответа, прежде чем прекратить подписку. В противном случае подписка немедленно прекращается аналогично AbortSubscription(). Если существует взаимная подписка, встречная подписка от издателя обратно клиенту также прекращается.

Сведения
Параметры
[in] aReasonProfileId
Идентификатор профиля StatusCode, который указывает причину прекращения.
[in] aReasonStatusCode
StatusCode, указывающий причину завершения.
Возвращаемые значения
Returns
Код ошибки Weave (только для справки). При возникновении ошибки объект будет синхронно удален (то есть прерван).

В ожидании ответа на SubscribeCancelRequest SubscriptionHandler переходит в состояние Canceling.

После начала процесса завершения объект SubscriptionHandler переходит в состояние Terminated, а событие OnSubscriptionTerminated передается обработчику событий приложения. Обратите внимание, что если поддержка отмены не включена, обработчик событий может быть вызван синхронно в рамках вызова EndSubscription().

После возврата обработчика событий приложения, если нет дополнительных ссылок на объект SubscriptionHandler, объект освобождается.

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
)

IsActive

bool IsActive(
  void
)

IsCanceling

bool IsCanceling() const

IsEstablishedIdle

bool IsEstablishedIdle()

IsFree

bool IsFree()

IsTerminated

bool IsTerminated()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)