nl:: বুনা:: প্রোফাইল:: হৃদস্পন্দন :: WeaveHeartbeatSender

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

বুনা হার্টবিট প্রেরক বর্গ.

সারসংক্ষেপ

কনস্ট্রাক্টর এবং ডেস্ট্রাক্টর

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
ওয়েভ রিলায়েবল মেসেজিং ব্যবহার করে হার্টবিট মেসেজ নির্ভরযোগ্যভাবে পাঠানো হবে কিনা তা নির্দেশ করে একটি পতাকা ফেরত দেয়।
GetSubscriptionState () const
uint8_t
বর্তমান সদস্যতা রাষ্ট্র মান পান.
Init ( WeaveExchangeManager *exchangeMgr, Binding *binding, EventCallback eventCallback, void *appState)
ওয়েভ হার্টবিট প্রেরক শুরু করুন।
ScheduleHeartbeat (void)
ওয়েভ হার্টবিট মেসেজ পাঠানোর সময়সূচী।
SendHeartbeatNow (void)
এখনই একটি ওয়েভ হার্টবিট বার্তা পাঠান।
SetConfiguration (uint32_t interval, uint32_t phase, uint32_t window)
void
হার্টবিট টাইমিং কনফিগারেশন সেট করুন।
SetEventCallback (EventCallback eventCallback)
void
WeaveHeartbeatSender- এ ঘটতে থাকা ইভেন্ট বা পরিবর্তনের আবেদন জানানোর জন্য কল করা হবে এমন ফাংশন সেট করে।
SetRequestAck (bool val)
void
ওয়েভ রিলায়েবল মেসেজিং ব্যবহার করে হার্টবিট মেসেজ নির্ভরযোগ্যভাবে পাঠানো উচিত কিনা তা নির্দেশ করে একটি পতাকা সেট করে।
SetSubscriptionState (uint8_t val)
void
বর্তমান সদস্যতা অবস্থা সেট করুন.
Shutdown (void)
ওয়েভ হার্টবিট প্রেরক বন্ধ করুন।
StartHeartbeat (void)
ওয়েভ হার্টবিট মেসেজ পাঠানো শুরু করুন।
StopHeartbeat (void)
ওয়েভ হার্টবিট মেসেজ পাঠানো বন্ধ করুন।

পাবলিক স্ট্যাটিক ফাংশন

DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam)
void
WeaveHeartbeatSender API ইভেন্টের জন্য ডিফল্ট হ্যান্ডলার ফাংশন।

কাঠামো

nl:: বুনন:: প্রোফাইল:: হার্টবিট:: উইভহার্টবিট সেন্ডার:: ইভেন্টপারম

WeaveHeartbeatSender API ইভেন্টে ইনপুট পরামিতি।

nl:: বুনন:: প্রোফাইল:: হার্টবিট:: উইভহার্টবিট সেন্ডার:: OutEventParam

WeaveHeartbeatSender API ইভেন্টে আউটপুট প্যারামিটার।

পাবলিক প্রকার

ইভেন্ট কলব্যাক

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

ইভেন্টের ধরণ

 EventType
বৈশিষ্ট্য
kEvent_DefaultCheck

অ্যাপ্লিকেশনে সঠিক ডিফল্ট ইভেন্ট হ্যান্ডলিং যাচাই করতে ব্যবহৃত হয়।

অ্যাপ্লিকেশন স্পষ্টভাবে এই ইভেন্ট পরিচালনা করা উচিত নয়.

kEvent_HeartbeatFailed

একটি হার্টবিট মেসেজ পিয়ারকে পাঠানো যায়নি।

kEvent_HeartbeatSent

একটি হৃদস্পন্দন বার্তা সফলভাবে পিয়ার পাঠানো হয়েছে.

যদি নির্ভরযোগ্য ট্রান্সমিশন সক্ষম করা হয়, এই ইভেন্টটি নির্দেশ করে যে বার্তাটি স্বীকার করা হয়েছে।

kEvent_UpdateSubscriptionState

অ্যাপ্লিকেশনটিকে সাবস্ক্রিপশনের অবস্থা আপডেট করার জন্য অনুরোধ করা হচ্ছে।

পাবলিক বৈশিষ্ট্য

অ্যাপস্টেট

void * AppState

পাবলিক ফাংশন

GetBinding

Binding * GetBinding() const

হার্টবিট প্রেরকের সাথে যুক্ত বাঁধাই বস্তু পান।

গেট কনফিগারেশন

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

ওয়েভ রিলায়েবল মেসেজিং ব্যবহার করে হার্টবিট মেসেজ নির্ভরযোগ্যভাবে পাঠানো হবে কিনা তা নির্দেশ করে একটি পতাকা ফেরত দেয়।

সাবস্ক্রিপশন স্টেট পান

uint8_t GetSubscriptionState() const

বর্তমান সদস্যতা রাষ্ট্র মান পান.

এটা

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

ওয়েভ হার্টবিট প্রেরক শুরু করুন।

বিস্তারিত
পরামিতি
[in] exchangeMgr
সিস্টেম উইভ এক্সচেঞ্জ ম্যানেজার একটি পয়েন্টার.
[in] binding
একটি ওয়েভ বাইন্ডিং অবজেক্টের একটি পয়েন্টার যা পিয়ার নোডকে অ্যাড্রেস করতে ব্যবহার করা হবে।
[in] eventCallback
একটি ফাংশনের একটি পয়েন্টার যা প্রেরকের মধ্যে ঘটতে থাকা ইভেন্ট বা রাজ্যের পরিবর্তনগুলির আবেদন জানানোর জন্য কল করা হবে।
[in] appState
অ্যাপ্লিকেশন-নির্দিষ্ট ডেটার জন্য একটি পয়েন্টার। এই পয়েন্টারটি অ্যাপ্লিকেশনে কলব্যাকে ফেরত দেওয়া হবে।
রিটার্ন মান
WEAVE_ERROR_INCORRECT_STATE
যদি WeaveHeartbeatSender অবজেক্টটি ইতিমধ্যেই শুরু করা হয়েছে।
WEAVE_ERROR_INVALID_ARGUMENT
সরবরাহকৃত আর্গুমেন্ট শূন্য হলে।
WEAVE_NO_ERROR
সাফল্যের উপর।

শিডিউল হার্টবিট

WEAVE_ERROR ScheduleHeartbeat(
  void
)

ওয়েভ হার্টবিট মেসেজ পাঠানোর সময়সূচী।

বিস্তারিত
রিটার্ন মান
WEAVE_SYSTEM_ERROR_NO_MEMORY
যদি StartTimer() ব্যর্থ হয়
WEAVE_NO_ERROR
সাফল্যের উপর

SendHeartbeatNow

WEAVE_ERROR SendHeartbeatNow(
  void
)

এখনই একটি ওয়েভ হার্টবিট বার্তা পাঠান।

বিস্তারিত
রিটার্ন মান
WEAVE_ERROR_INCORRECT_STATE
যদি WeaveHeartbeatSender আরম্ভ করা না হয়
WEAVE_NO_ERROR
সাফল্যের উপর

সেট কনফিগারেশন

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

হার্টবিট টাইমিং কনফিগারেশন সেট করুন।

বিস্তারিত
পরামিতি
[in] interval
ওয়েভ হার্টবিট মেসেজ পাঠানোর সময় ব্যবহার করার ব্যবধান।
[in] phase
ওয়েভ হার্টবিট মেসেজ পাঠানোর সময় ব্যবহার করতে হবে।
[in] window
এলোমেলো ব্যবধান বেছে নেওয়ার জন্য ব্যবহার করার জন্য উইন্ডো পরিসর

সেট ইভেন্ট কলব্যাক

void SetEventCallback(
  EventCallback eventCallback
)

WeaveHeartbeatSender- এ ঘটতে থাকা ইভেন্ট বা পরিবর্তনের আবেদন জানানোর জন্য কল করা হবে এমন ফাংশন সেট করে।

SetRequestAck

void SetRequestAck(
  bool val
)

ওয়েভ রিলায়েবল মেসেজিং ব্যবহার করে হার্টবিট মেসেজ নির্ভরযোগ্যভাবে পাঠানো উচিত কিনা তা নির্দেশ করে একটি পতাকা সেট করে।

মনে রাখবেন যে এই পতাকাটি শুধুমাত্র তখনই অর্থবহ হয় যখন একটি পরিবহন হিসাবে UDP ব্যবহার করে৷

বিস্তারিত
পরামিতি
[in] val
সত্য যদি হার্টবিট বার্তাগুলি নির্ভরযোগ্যভাবে পাঠানো উচিত।

সাবস্ক্রিপশন স্টেট সেট করুন

void SetSubscriptionState(
  uint8_t val
)

বর্তমান সদস্যতা অবস্থা সেট করুন.

বিস্তারিত
পরামিতি
[in] val
একটি 8-বিট সাবস্ক্রিপশন স্টেট মান হার্টবিট মেসেজের সাথে জানানো হবে।

শাটডাউন

WEAVE_ERROR Shutdown(
  void
)

ওয়েভ হার্টবিট প্রেরক বন্ধ করুন।

বিস্তারিত
রিটার্ন মান
WEAVE_NO_ERROR
সাফল্যের উপর।

হার্টবিট শুরু করুন

WEAVE_ERROR StartHeartbeat(
  void
)

ওয়েভ হার্টবিট মেসেজ পাঠানো শুরু করুন।

বিস্তারিত
রিটার্ন মান
INET_ERROR_NO_MEMORY
যদি StartTimer() ব্যর্থ হয়
WEAVE_NO_ERROR
সাফল্যের উপর

স্টপ হার্টবিট

WEAVE_ERROR StopHeartbeat(
  void
)

ওয়েভ হার্টবিট মেসেজ পাঠানো বন্ধ করুন।

বিস্তারিত
রিটার্ন মান
WEAVE_NO_ERROR
শর্তহীনভাবে

WeaveHeartbeatSender

 WeaveHeartbeatSender(
  void
)

পাবলিক স্ট্যাটিক ফাংশন

ডিফল্ট ইভেন্টহ্যান্ডলার

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

WeaveHeartbeatSender API ইভেন্টের জন্য ডিফল্ট হ্যান্ডলার ফাংশন।

অ্যাপ্লিকেশনগুলিকে অবশ্যই এই ফাংশনটি যে কোনও API ইভেন্টের জন্য কল করতে হবে যা তারা পরিচালনা করে না।