Google is committed to advancing racial equity for Black communities. See how.
Эта страница переведена с помощью Cloud Translation API.
Switch to English

nl :: Плетение :: Профили: DataManagement_Current :: SubscriptionHandler

Резюме

Публичные типы

@142 перечислить
EventCallback )(void *const aAppState, EventID aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventID перечислить
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
)

Публичные функции

Прервать подписку

void AbortSubscription(
  void
)

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

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

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

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

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

ПринятьПодписатьсяЗапрос

WEAVE_ERROR AcceptSubscribeRequest(
  const uint32_t aLivenessTimeoutSec
)

Конец подписки

WEAVE_ERROR EndSubscription(
  const uint32_t aReasonProfileId,
  const uint16_t aReasonStatusCode
)

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

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

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

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

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

Подробности
Параметры
[in] aReasonProfileId
ProfileId 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()

Это бесплатно

bool IsFree()

Прекращено

bool IsTerminated()

SetMaxNotificationSize

void SetMaxNotificationSize(
  const uint32_t aMaxPayload
)