nl:: Weave:: 프로필:: 하트비트:: WeaveHeartbeatSender
#include <src/lib/profiles/heartbeat/WeaveHeartbeat.h>
위브 Heartbeat Sender 클래스
요약
생성자 및 소멸자 |
|
---|---|
WeaveHeartbeatSender(void)
|
공개 유형 |
|
---|---|
EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
|
typedefvoid(*
|
EventType{
|
enum |
공개 속성 |
|
---|---|
AppState
|
void *
|
공개 함수 |
|
---|---|
GetBinding() const
|
Binding *
하트비트 발신자와 연결된 결합 객체를 가져옵니다.
|
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 Heartbeat 발신자를 초기화합니다.
|
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 Heartbeat 발신자를 종료합니다.
|
StartHeartbeat(void)
|
Weave Heartbeat 메시지 전송을 시작합니다.
|
StopHeartbeat(void)
|
Weave Heartbeat 메시지 전송을 중지합니다.
|
공개 정적 함수 |
|
---|---|
DefaultEventHandler(void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
|
void
WeaveHeartbeatSender API 이벤트의 기본 핸들러 함수
|
구조체 |
|
---|---|
nl:: |
WeaveHeartbeatSender API 이벤트에 매개변수를 입력합니다. |
nl:: |
WeaveHeartbeatSender API 이벤트에 대한 출력 매개변수입니다. |
공개 유형
이벤트 콜백
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
EventType
EventType
속성 | |
---|---|
kEvent_DefaultCheck
|
애플리케이션에서 올바른 기본 이벤트 처리를 확인하는 데 사용됩니다. 애플리케이션은 이 이벤트를 명시적으로 처리해서는 안 됩니다. |
kEvent_HeartbeatFailed
|
하트비트 메시지를 피어에 보낼 수 없습니다. |
kEvent_HeartbeatSent
|
하트비트 메시지가 피어에 전송되었습니다. 안정적인 전송이 사용 설정된 경우 이 이벤트는 메일이 확인되었음을 나타냅니다. |
kEvent_UpdateSubscriptionState
|
애플리케이션이 가입 상태를 업데이트하도록 요청합니다. |
공개 속성
앱 상태
void * AppState
공개 함수
GetConfiguration
void GetConfiguration( uint32_t & interval, uint32_t & phase, uint32_t & window ) const
하트비트 타이밍 구성 가져오기
세부정보 | |||||||
---|---|---|---|---|---|---|---|
매개변수 |
|
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 Heartbeat 발신자를 초기화합니다.
세부정보 | |||||||||
---|---|---|---|---|---|---|---|---|---|
매개변수 |
|
||||||||
반환 값 |
|
스케줄 하트비트
WEAVE_ERROR ScheduleHeartbeat( void )
Weave 하트비트 메시지 전송을 예약합니다.
세부정보 | |||||
---|---|---|---|---|---|
반환 값 |
|
SendHeartbeatNow
WEAVE_ERROR SendHeartbeatNow( void )
지금 Weave 하트비트 메시지를 보내세요.
세부정보 | |||||
---|---|---|---|---|---|
반환 값 |
|
설정 구성
void SetConfiguration( uint32_t interval, uint32_t phase, uint32_t window )
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
WeaveHeartbeatSender에서 발생한 이벤트 또는 변경사항을 애플리케이션에 알리기 위해 호출할 함수를 설정합니다.
SetRequestAck
void SetRequestAck( bool val )
Weave Reliable Messaging을 사용하여 하트비트 메시지를 안정적으로 전송해야 하는지 여부를 나타내는 플래그를 설정합니다.
이 플래그는 UDP를 전송으로 사용할 때만 의미가 있습니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
SetSubscriptionState
void SetSubscriptionState( uint8_t val )
현재 정기 결제 상태를 설정합니다.
세부정보 | |||
---|---|---|---|
매개변수 |
|
하트비트
WEAVE_ERROR StartHeartbeat( void )
Weave Heartbeat 메시지 전송을 시작합니다.
세부정보 | |||||
---|---|---|---|---|---|
반환 값 |
|
스톱하트비트
WEAVE_ERROR StopHeartbeat( void )
위브하트비트 발신기
WeaveHeartbeatSender( void )
공개 정적 함수
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
WeaveHeartbeatSender API 이벤트의 기본 핸들러 함수
애플리케이션은 자신이 처리하지 않는 API 이벤트에 대해 이 함수를 호출해야 합니다.