nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender

#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>

Weave 하트비트 발신자 클래스.

요약

생성자 및 소멸자
WeaveHeartbeatSender(void)

공개 유형
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) typedef
void(*
EventType{
  kEvent_UpdateSubscriptionState = 1,
  kEvent_HeartbeatSent = 2,
  kEvent_HeartbeatFailed = 3,
  kEvent_DefaultCheck = 100
} 		enum

공개 속성
AppState
void *

공개 함수
GetBinding() const
하트비트 발신자와 연결된 결합 객체를 가져옵니다.
GetConfiguration(uint32_t & interval, uint32_t & phase, uint32_t & window) const
void
하트비트 타이밍 구성을 가져옵니다.
GetEventCallback() const
EventCallback
WeaveHeartbeatSender에서 발생하는 이벤트나 변경사항을 애플리케이션에 알리기 위해 호출될 함수를 반환합니다.
GetRequestAck() const
bool
Weave Reliable Messaging을 사용하여 하트비트 메시지를 안정적으로 전송할지 여부를 나타내는 플래그를 반환합니다.
GetSubscriptionState() const
uint8_t
현재 정기 결제 상태 값을 가져옵니다.
Init(WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
Weave 하트비트 발신자를 초기화합니다.
ScheduleHeartbeat(void)
Weave 하트비트 메시지 전송을 예약합니다.
SendHeartbeatNow(void)
지금 Weave 하트비트 메시지를 보내세요.
SetConfiguration(uint32_t interval, uint32_t phase, uint32_t window)
void
하트비트 타이밍 구성을 설정합니다.
SetEventCallback(EventCallback eventCallback)
void
WeaveHeartbeatSender에서 발생하는 이벤트나 변경사항을 애플리케이션에 알리기 위해 호출할 함수를 설정합니다.
SetRequestAck(bool val)
void
Weave Reliable Messaging을 사용하여 하트비트 메시지를 안정적으로 전송해야 하는지 여부를 나타내는 플래그를 설정합니다.
SetSubscriptionState(uint8_t val)
void
현재 정기 결제 상태를 설정합니다.
Shutdown(void)
Weave 하트비트 발신자를 종료합니다.
StartHeartbeat(void)
Weave 하트비트 메시지를 보냅니다.
StopHeartbeat(void)
Weave 하트비트 메시지 전송을 중지합니다.

공개 정적 함수
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
WeaveHeartbeatSender API 이벤트의 기본 핸들러 함수입니다.

구조체
nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::InEventParam

WeaveHeartbeatSender API 이벤트에 대한 입력 매개변수입니다.

nl::Weave::Profiles::Heartbeat::WeaveHeartbeatSender::OutEventParam

WeaveHeartbeatSender API 이벤트에 출력 매개변수를 출력합니다.

공개 유형

EventCallback

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

EventType

 EventType
속성
kEvent_DefaultCheck

애플리케이션에서 올바른 기본 이벤트 처리를 확인하는 데 사용됩니다.

애플리케이션은 이 이벤트를 명시적으로 처리해서는 안 됩니다.

kEvent_HeartbeatFailed

피어에 하트비트 메시지를 보내지 못했습니다.

kEvent_HeartbeatSent

하트비트 메시지가 피어에 전송되었습니다.

안정적인 전송이 사용 설정된 경우 이 이벤트는 메시지가 확인되었음을 나타냅니다.

kEvent_UpdateSubscriptionState

애플리케이션에 구독 상태를 업데이트하도록 요청합니다.

공개 속성

AppState

void * AppState

공개 함수

GetBinding

Binding * GetBinding() const

하트비트 발신자와 연결된 결합 객체를 가져옵니다.

GetConfiguration

void GetConfiguration(
  uint32_t & interval,
  uint32_t & phase,
  uint32_t & window
) const

하트비트 타이밍 구성을 가져옵니다.

세부정보
매개변수
[out] interval
하트비트 간격을 수신할 정수에 대한 참조입니다.
[out] phase
하트비트 단계를 수신할 정수에 대한 참조입니다.
[out] window
하트비트 무작위 순서 지정 기간을 수신할 정수에 대한 참조입니다.

GetEventCallback

EventCallback GetEventCallback() const

WeaveHeartbeatSender에서 발생하는 이벤트나 변경사항을 애플리케이션에 알리기 위해 호출될 함수를 반환합니다.

GetRequestAck

bool GetRequestAck() const

Weave Reliable Messaging을 사용하여 하트비트 메시지를 안정적으로 전송할지 여부를 나타내는 플래그를 반환합니다.

GetSubscriptionState

uint8_t GetSubscriptionState() const

현재 정기 결제 상태 값을 가져옵니다.

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr,
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

Weave 하트비트 발신자를 초기화합니다.

세부정보
매개변수
[in] exchangeMgr
시스템 Weave Exchange Manager에 대한 포인터입니다.
[in] binding
피어 노드를 처리하는 데 사용될 Weave 바인딩 객체에 대한 포인터입니다.
[in] eventCallback
발신자에서 발생하는 이벤트 또는 상태 변경을 애플리케이션에 알리기 위해 호출될 함수에 대한 포인터입니다.
[in] appState
애플리케이션별 데이터에 대한 포인터입니다. 이 포인터는 애플리케이션에 대한 콜백에서 반환됩니다.
반환 값
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender 객체가 이미 초기화된 경우
WEAVE_ERROR_INVALID_ARGUMENT
제공된 인수 중 하나라도 null인 경우.
WEAVE_NO_ERROR
성공 시

ScheduleHeartbeat

WEAVE_ERROR ScheduleHeartbeat(
  void
)

Weave 하트비트 메시지 전송을 예약합니다.

세부정보
반환 값
WEAVE_SYSTEM_ERROR_NO_MEMORY
Start타이머()가 실패한 경우
WEAVE_NO_ERROR
성공 시

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

지금 Weave 하트비트 메시지를 보내세요.

세부정보
반환 값
WEAVE_ERROR_INCORRECT_STATE
WeaveHeartbeatSender가 초기화되지 않은 경우
WEAVE_NO_ERROR
성공 시

SetConfiguration

void SetConfiguration(
  uint32_t interval,
  uint32_t phase,
  uint32_t window
)

하트비트 타이밍 구성을 설정합니다.

세부정보
매개변수
[in] interval
Weave 하트비트 메시지를 보낼 때 사용할 간격입니다.
[in] phase
Weave 하트비트 메시지를 보낼 때 사용하는 단계입니다.
[in] window
임의의 간격을 선택하는 데 사용할 기간 범위

SetEventCallback

void SetEventCallback(
  EventCallback eventCallback
)

WeaveHeartbeatSender에서 발생하는 이벤트나 변경사항을 애플리케이션에 알리기 위해 호출할 함수를 설정합니다.

SetRequestAck

void SetRequestAck(
  bool val
)

Weave Reliable Messaging을 사용하여 하트비트 메시지를 안정적으로 전송해야 하는지 여부를 나타내는 플래그를 설정합니다.

이 플래그는 UDP를 전송으로 사용하는 경우에만 의미가 있습니다.

세부정보
매개변수
[in] val
하트비트 메시지를 안정적으로 전송해야 하는 경우 true입니다.

SetSubscriptionState

void SetSubscriptionState(
  uint8_t val
)

현재 정기 결제 상태를 설정합니다.

세부정보
매개변수
[in] val
하트비트 메시지로 전달할 8비트 구독 상태 값입니다.

종료

WEAVE_ERROR Shutdown(
  void
)

Weave 하트비트 발신자를 종료합니다.

세부정보
반환 값
WEAVE_NO_ERROR
성공 시

StartHeartbeat

WEAVE_ERROR StartHeartbeat(
  void
)

Weave 하트비트 메시지를 보냅니다.

세부정보
반환 값
INET_ERROR_NO_MEMORY
Start타이머()가 실패한 경우
WEAVE_NO_ERROR
성공 시

StopHeartbeat

WEAVE_ERROR StopHeartbeat(
  void
)

Weave 하트비트 메시지 전송을 중지합니다.

세부정보
반환 값
WEAVE_NO_ERROR
무조건적으로

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

공개 정적 함수

DefaultEventHandler

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)

WeaveHeartbeatSender API 이벤트의 기본 핸들러 함수입니다.

애플리케이션에서는 처리하지 않는 모든 API 이벤트에 대해 이 함수를 호출해야 합니다.