nl::Weave::Binding

#include <src/lib/core/WeaveBinding.h>

Weave কমিউনিকেশনের উদ্দেশ্যমূলক টার্গেট এবং সংশ্লিষ্ট কনফিগারেশন সংক্রান্ত তথ্য ক্যাপচার করে।

সারাংশ

একটি বাইন্ডিং অবজেক্ট Weave কমিউনিকেশনের (যা "পিয়ার" নামেও পরিচিত) উদ্দিষ্ট টার্গেট শনাক্ত করে, সাথে কনফিগারেশন প্যারামিটারের একটি সেট থাকে যা পিয়ারের সাথে কীভাবে কমিউনিকেশন করা উচিত তা বর্ণনা করে। দুই পক্ষের মধ্যে যে অ্যাপ্লিকেশন প্রোটোকল ব্যবহার করা হচ্ছে, বাইন্ডিং তার উপর নির্ভর করে না। তাই, তারা যোগাযোগের "কে" এবং "কীভাবে" ক্যাপচার করে, কিন্তু "কী" নয়।

কনফিগারেশন

অ্যাপ্লিকেশনগুলিকে অবশ্যই কাঙ্ক্ষিত যোগাযোগ চ্যানেলের প্রকারের জন্য নির্দিষ্ট প্যারামিটার সহ একটি বাইন্ডিং কনফিগার করতে হবে। TCP, UDP, Weave নির্ভরযোগ্য মেসেজিং সহ UDP এবং BLE (WoBLE)-এর মাধ্যমে Weave সহ বিভিন্ন ধরনের নেটওয়ার্ক ট্রান্সপোর্টের জন্য বাইন্ডিং সহায়তা প্রদান করে। এছাড়াও, পার্টিদের মধ্যে পাঠানো মেসেজ সুরক্ষিত রাখতে অ্যাপ্লিকেশন নির্দিষ্ট সুরক্ষা পদ্ধতির ব্যবহার করার অনুরোধ করতে পারে। এর মধ্যে CASE ও PASE সেশন এবং অ্যাপ্লিকেশন গ্রুপ কী অন্তর্ভুক্ত। বাইন্ডিং কনফিগার করার ইন্টারফেস একটি ডিক্ল্যারেটিভ API স্টাইল ব্যবহার করে যা অ্যাপ্লিকেশনকে সহজ শর্তে যোগাযোগের জন্য তাদের প্রয়োজনীয়তা জানাতে দেয়।

আরও তথ্যের জন্য Binding::Configuration-এর ডকুমেন্টেশন দেখুন।

প্রস্তুতি

যোগাযোগ করার আগে, বাইন্ডিং "প্রস্তুত" করতে হবে। বাইন্ডিং প্রস্তুত করার অর্থ হল যোগাযোগের জন্য প্রয়োজনীয় অবস্থা তৈরি করা। এর মধ্যে এইসব বিষয় অন্তর্ভুক্ত থাকতে পারে: পিয়ারের নেটওয়ার্ক অ্যাড্রেস সমাধান করা, নেটওয়ার্ক কানেকশন স্থাপন করা এবং নিরাপত্তা সংক্রান্ত 'কী' নিয়ে আলোচনা করা। অ্যাপ্লিকেশন দ্বারা কনফিগার করা হলে, বাইন্ডিং যোগাযোগের জন্য প্রস্তুত করার জন্য প্রয়োজনীয় সমস্ত পদক্ষেপের যত্ন নেয়, প্রক্রিয়াটি সম্পূর্ণ হলে অ্যাপ্লিকেশনটিতে কল ব্যাক করে। এইভাবে, বাইন্ডিং কমিউনিকেশনের মেকানিক্সকে আড়াল করে, যার ফলে অ্যাপ্লিকেশনগুলি হাই-লেভেল ইন্টার‍্যাকশনের উপর মনোযোগ দিতে পারে।

যোগাযোগ

বাইন্ডিং তৈরি হয়ে গেলে, সেটি ব্যবহার করার জন্য রেডি হয়ে যায়। এই অবস্থায়, অ্যাপ্লিকেশন (বা আরও সাধারণভাবে, কোনও অ্যাপ্লিকেশনের হয়ে কাজ করা প্রোটোকল লেয়ার কোড) Weave এক্সচেঞ্জ কনটেক্সট অ্যাসাইন করার জন্য বাইন্ডিং-এর কাছে অনুরোধ করে। এর ফলে যে এক্সচেঞ্জ কনটেক্সট তৈরি হয় তা কমিউনিকেশনের জন্য আগে থেকেই কনফিগার করা থাকে, এর ফলে অ্যাপ্লিকেশনটি সাথে সাথেই পিয়ারের সাথে Weave এক্সচেঞ্জ শুরু করতে পারে। Binding বন্ধ না হওয়া পর্যন্ত বা কোনও ইভেন্ট, যেমন নেটওয়ার্ক কাজ না করার কারণে অন্তর্নিহিত কমিউনিকেশন চ্যানেল বন্ধ না হওয়া পর্যন্ত, অ্যাপ্লিকেশনটি Binding থেকে এক্সচেঞ্জ কনটেক্সটের জন্য অনুরোধ করা চালিয়ে যেতে পারে।

বাইন্ডিং স্ট্যাটাসে হওয়া পরিবর্তন

ব্যবহারের সময়, বাইন্ডিং, বাইন্ডিং-এর স্ট্যাটাসে হওয়া পরিবর্তন সম্পর্কে অ্যাপ্লিকেশনকে জানাতে API ইভেন্ট ডেলিভার করবে। যেমন, প্রস্তুতি সম্পূর্ণ হলে, অ্যাপ্লিকেশনটি একটি ইভেন্ট পাবে যা তাকে জানাবে যে বাইন্ডিং ব্যবহারের জন্য প্রস্তুত। একইভাবে, অন্তর্নিহিত কমিউনিকেশন চ্যানেল কাজ না করলে, অ্যাপ্লিকেশনকে একটি ইভেন্ট ডেলিভার করা হয় যা জানায় যে বাইন্ডিং আর রেডি স্টেটে নেই।

বাইন্ডিং বরাদ্দ করার সময় প্রদান করা ইভেন্ট কলব্যাক ফাংশনের মাধ্যমে এপিআই ইভেন্ট অ্যাপ্লিকেশনকে ডেলিভার করা হয়।

বাইন্ডিং লাইফটাইম

একাধিক সফ্টওয়্যার কম্পোনেন্ট জুড়ে শেয়ার করা ব্যবহারের অনুমতি দিতে বাইন্ডিং রেফারেন্স গণনা করা হয়। কোনও বাইন্ডিং বরাদ্দ করা হলে, বাইন্ডিংয়ের একটি রেফারেন্স তৈরি করা হয়। ভবিষ্যতে কোনও এক সময়ে এই রেফারেন্স রিলিজ করার দায়িত্ব অ্যাপ্লিকেশনের, যাতে বাইন্ডিং পরে আবার ব্যবহার করার জন্য ফ্রি থাকে।

কোনও অ্যাপ্লিকেশনের বাইন্ডিং সংক্রান্ত কাজ হয়ে গেলে, এটি বাইন্ডিংয়ে Close() কল করতে পারে। এটি বাইন্ডিং-এ অ্যাপ্লিকেশনের রেফারেন্স রিলিজ করে এবং API ইভেন্টের পরবর্তী সব ডেলিভারি ব্লক করে। বাইন্ডিং-এর শেষ রেফারেন্স রিলিজ হয়ে গেলে, এটি অটোমেটিক বন্ধ হয়ে যায়।

পাবলিক ধরন

@23{
  kGetPeerDescription_MaxLength = nl::Weave::kWeavePeerDescription_MaxLength
}
enum
EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType{
  kEvent_ConnectionEstablished = 1,
  kEvent_BindingReady = 2,
  kEvent_PrepareFailed = 3,
  kEvent_BindingFailed = 4,
  kEvent_PrepareRequested = 5,
  kEvent_PASEParametersRequested = 6,
  kEvent_TAKEParametersRequested = 7,
  kEvent_DefaultCheck = 100
}
enum
State enum

পাবলিক অ্যাট্রিবিউট

AppState
void *

পাবলিক ফাংশন

AddRef(void)
void
বাইন্ডিং অবজেক্টের রেফারেন্স রিজার্ভ করুন।
AdjustResponseTimeout(ExchangeContext *apExchangeContext) const
রেসপন্স টাইমআউট অ্যাডজাস্ট করতে আগে থেকে থাকা এক্সচেঞ্জ কনটেক্সট আবার কনফিগার করুন।
AllocateRightSizedBuffer(PacketBuffer *& buf, const uint32_t desiredSize, const uint32_t minSize, uint32_t & outMaxPayloadSize)
BeginConfiguration()
বাইন্ডিং কনফিগার করার প্রসেস।
CanBePrepared(void) const
bool
Close(void)
void
বাইন্ডিং অবজেক্ট বন্ধ করে রেফারেন্স রিলিজ করুন।
GetConnection() const
বাইন্ডিংয়ের সাথে যুক্ত Weave কানেকশন অবজেক্ট পান।
GetDefaultResponseTimeout() const
uint32_t
পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট এক্সচেঞ্জ রেসপন্স টাইমআউট পান।
GetDefaultWRMPConfig(void) const
const WRMPConfig &
পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট WRMP কনফিগারেশন পান।
GetEncryptionType(void) const
uint8_t
পিয়ারকে/থেকে মেসেজ এনক্রিপ্ট করার সময় ব্যবহার করার জন্য মেসেজ এনক্রিপশন ধরন রিট্রিভ করুন।
GetEventCallback() const
EventCallback
Binding-এর জন্য কোনও API ইভেন্ট ঘটলে যে ফাংশন কল করা হবে সেটি পান।
GetExchangeManager() const
GetKeyId(void) const
uint32_t
পিয়ারকে/পিয়ার থেকে মেসেজ এনক্রিপ্ট করার সময় ব্যবহার করার জন্য মেসেজ এনক্রিপশন কী-এর আইডি রিট্রিভ করুন।
GetLogId(void) const
uint16_t
বাইন্ডিংয়ের জন্য একটি অনন্য আইডি পান।
GetMaxWeavePayloadSize(const System::PacketBuffer *msgBuf)
uint32_t
সর্বাধিক Weave পেলোড সাইজ পান যা সরবরাহ করা PacketBuffer-এর মধ্যে ফিট হতে পারে।
GetPeerDescription(char *buf, uint32_t bufSize) const
void
একটি স্ট্রিং তৈরি করে যা পিয়ার নোড এবং এর সাথে যুক্ত ঠিকানা / কানেকশন সংক্রান্ত তথ্য বর্ণনা করে।
GetPeerIPAddress(nl::Inet::IPAddress & address, uint16_t & port, InterfaceId & interfaceId) const
void
উপলভ্য থাকলে, পিয়ারের জন্য IP অ্যাড্রেস সংক্রান্ত তথ্য ফিরিয়ে আনুন।
GetPeerNodeId(void) const
uint64_t
বাইন্ডিং পিয়ারের নোড আইডি রিট্রিভ করুন।
GetProtocolLayerCallback(EventCallback & callback, void *& state) const
void
GetState(void) const
State
বাইন্ডিংয়ের বর্তমান স্টেট রিট্রিভ করুন।
IsAuthenticMessageFromPeer(const WeaveMessageInfo *msgInfo)
bool
কনফিগার করা পিয়ার থেকে কোনও নির্দিষ্ট ইনকামিং মেসেজ এসেছে কিনা এবং সেটি উপযুক্তভাবে যাচাই করা হয়েছে কিনা তা নির্ধারণ করুন।
IsConnectionTransport() const
bool
IsPreparing(void) const
bool
IsReady(void) const
bool
IsUDPTransport() const
bool
IsUnreliableUDPTransport() const
bool
IsWRMTransport() const
bool
NewExchangeContext(ExchangeContext *& appExchangeContext)
বাইন্ডিংয়ের টার্গেট যে পিয়ার তার সাথে যোগাযোগ করার জন্য নতুন এক্সচেঞ্জ কনটেক্সট বরাদ্দ করুন।
Release(void)
void
বাইন্ডিং অবজেক্টের রেফারেন্স রিলিজ করুন।
RequestPrepare()
বাইন্ডিং কনফিগার ও প্রস্তুত করার জন্য অ্যাপ্লিকেশনকে অনুরোধ করুন।
Reset(void)
void
বাইন্ডিংকে কনফিগার না করা অবস্থায় রিসেট করুন।
SetDefaultResponseTimeout(uint32_t msec)
void
পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট এক্সচেঞ্জ রেসপন্স টাইমআউট সেট করুন।
SetDefaultWRMPConfig(const WRMPConfig & wrmpConfig)
void
পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট WRMP কনফিগারেশন সেট করুন।
SetEventCallback(EventCallback aEventCallback)
void
বাইন্ডিং-এর জন্য কোনও API ইভেন্ট ঘটলে কল করার জন্য অ্যাপ্লিকেশন-সংজ্ঞায়িত ফাংশন সেট করুন।
SetProtocolLayerCallback(EventCallback callback, void *state)
void
কোনও অ্যাপ্লিকেশনের হয়ে বাইন্ডিং ব্যবহার করে প্রোটোকল লেয়ার কোডের জন্য ইভেন্ট কলব্যাক ফাংশন সেট করুন।

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

DefaultEventHandler(void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
API ইভেন্ট বাইন্ডিংয়ের জন্য ডিফল্ট হ্যান্ডলার।

ক্লাস

nl::Weave::Binding::Configuration

Binding অবজেক্ট কনফিগার ও প্রস্তুত করার জন্য ডিক্ল্যারেটিভ-স্টাইল ইন্টারফেস প্রদান করে।

স্ট্রাক্ট

nl::Weave::Binding::InEventParam

Binding API ইভেন্টে ইনপুট প্যারামিটার।

nl::Weave::Binding::OutEventParam

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

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

@23

 @23
প্রপার্টি
kGetPeerDescription_MaxLength

GetPeerDescription()-এর মাধ্যমে রিটার্ন করা স্ট্রিংয়ের (NUL অক্ষর সহ) সর্বাধিক দৈর্ঘ্য।

EventCallback

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

EventType

 EventType
প্রপার্টি
kEvent_BindingFailed

বাইন্ডিং কাজ করেনি এবং পিয়ারের সাথে যোগাযোগ করার জন্য আর ব্যবহার করা যাবে না।

kEvent_BindingReady

বাইন্ডিংয়ের উপর প্রস্তুতি অ্যাকশন সফল হয়েছে এবং বাইন্ডিং এখন পিয়ারের সাথে যোগাযোগ করতে ব্যবহার করা যেতে পারে।

kEvent_ConnectionEstablished

অনুরোধ করা Weave কানেকশন তৈরি করা হয়েছে।

kEvent_DefaultCheck

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

kEvent_PASEParametersRequested

PASE সেশন এস্টাবলিশ করার সময় ব্যবহার করার জন্য প্যারামিটার সাপ্লাই করার অনুরোধ অ্যাপ্লিকেশনকে করা হয়।

kEvent_PrepareFailed

বাইন্ডিংয়ে প্রস্তুতি অ্যাকশন কাজ করেনি।

kEvent_PrepareRequested

নেটওয়ার্ক স্ট্যাকের মাধ্যমে ব্যবহার করার জন্য অ্যাপ্লিকেশনকে বাইন্ডিং কনফিগার ও প্রস্তুত করার অনুরোধ করা হয়েছে।

kEvent_TAKEParametersRequested

TAKE সেশন এস্ট্যাবলিশ করার সময় ব্যবহার করার জন্য অ্যাপ্লিকেশনকে প্যারামিটার সাপ্লাই করার অনুরোধ করা হয়।

রাজ্য

 State

পাবলিক অ্যাট্রিবিউট

AppState

void * AppState

পাবলিক ফাংশন

AddRef

void AddRef(
  void
)

বাইন্ডিং অবজেক্টের রেফারেন্স রিজার্ভ করুন।

AdjustResponseTimeout

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

উত্তর দেওয়ার টাইম-আউট অ্যাডজাস্ট করতে আগে থেকে থাকা Exchange Context আবার কনফিগার করুন।

বিবরণ
প্যারামিটারগুলি
[in] apExchangeContext
Exchange Context অবজেক্টের একটি পয়েন্টার যা আবার কনফিগার করতে হবে

AllocateRightSizedBuffer

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

BeginConfiguration

Configuration BeginConfiguration()

বাইন্ডিং কনফিগার করার প্রসেস।

পিয়ারের সাথে যোগাযোগ করার জন্য বাইন্ডিং প্রস্তুত করার আগে, অ্যাপ্লিকেশনকে অবশ্যই BeginConfiguration() কল করতে হবে।

বিবরণ
ফেরত
একটি Binding::Configuration অবজেক্ট যা বাইন্ডিং কনফিগার করতে ব্যবহার করা যেতে পারে।

CanBePrepared

bool CanBePrepared(
  void
) const 

বন্ধ করুন

void Close(
  void
)

বাইন্ডিং অবজেক্ট বন্ধ করুন এবং রেফারেন্স রিলিজ করুন।

কল করা হলে, এই পদ্ধতির কারণে বাইন্ডিং ক্লোজড স্টেটে চলে যায়। বাইন্ডিংয়ের জন্য কোনও প্রিপেয়ার অ্যাকশন প্রসেস চলাকালীন বাতিল করা হয় এবং বাইন্ডিংয়ের কাছে থাকা সব এক্সটার্নাল কমিউনিকেশন রিসোর্স রিলিজ করা হয়।

Close() কল করলে বাইন্ডিংয়ের সাথে যুক্ত রেফারেন্স কাউন্ট কমে যায় এবং রেফারেন্স কাউন্ট শূন্য হয়ে গেলে অবজেক্টটি ফ্রি হয়ে যায়।

GetConnection

WeaveConnection * GetConnection() const 

বাইন্ডিংয়ের সাথে যুক্ত Weave কানেকশন অবজেক্ট পান।

বিবরণ
ফেরত
WeaveConnection অবজেক্টের একটি পয়েন্টার, অথবা বাইন্ডিংয়ের সাথে কোনও কানেকশন যুক্ত না থাকলে NULL।

GetDefaultResponseTimeout

uint32_t GetDefaultResponseTimeout() const 

পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট এক্সচেঞ্জ রেসপন্স টাইমআউট পান।

বিবরণ
ফেরত
মিলিসেকেন্ডে উত্তর দেওয়ার সময়সীমা।

GetDefaultWRMPConfig

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট WRMP কনফিগারেশন পান।

বিবরণ
ফেরত
ডিফল্ট কনফিগারেশন ভ্যালু সহ WRMPConfig স্ট্রাকচারের রেফারেন্স।

GetEncryptionType

uint8_t GetEncryptionType(
  void
) const 

পিয়ার থেকে/পিয়ারে মেসেজ এনক্রিপ্ট করার সময় ব্যবহার করার জন্য মেসেজ এনক্রিপশনের ধরন ফিরিয়ে আনুন।

GetEventCallback

EventCallback GetEventCallback() const 

বাইন্ডিং-এর জন্য API ইভেন্ট ঘটলে যে ফাংশনটি কল করা হবে সেটি পান।

বিবরণ
ফেরত
কলব্যাক ফাংশনের একটি পয়েন্টার।

GetExchangeManager

WeaveExchangeManager * GetExchangeManager() const 

GetKeyId

uint32_t GetKeyId(
  void
) const 

পিয়ার থেকে/পিয়ারে মেসেজ এনক্রিপ্ট করার সময় ব্যবহার করার জন্য মেসেজ এনক্রিপশন কী-এর আইডি ফিরিয়ে আনুন।

GetLogId

uint16_t GetLogId(
  void
) const 

বাইন্ডিংয়ের জন্য একটি অনন্য আইডি পান।

GetMaxWeavePayloadSize

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

সর্বাধিক Weave পেলোড সাইজ পান যা সরবরাহ করা PacketBuffer-এর মধ্যে ফিট হতে পারে।

UDP-এর জন্য, WRM সহ UDP সহ, ফেরত আসা সর্বাধিক পেলোড সাইজ নিশ্চিত করবে যে ফলস্বরূপ Weave মেসেজ কনফিগার করা UDP MTU ওভারফ্লো করবে না।

এছাড়াও, এই পদ্ধতি নিশ্চিত করবে যে Weave পেলোড, প্রদত্ত PacketBuffer-এ ওভারফ্লো করবে না।

বিবরণ
প্যারামিটারগুলি
[in] msgBuf
PacketBuffer-এর একটি পয়েন্টার যেখানে মেসেজ পেলোড লেখা হবে।
ফেরত
Weave পেলোডের সর্বাধিক সাইজ।

GetPeerDescription

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

একটি স্ট্রিং তৈরি করে যা পিয়ার নোড এবং এর সাথে যুক্ত ঠিকানা / কানেকশন সংক্রান্ত তথ্য বর্ণনা করে।

বিবরণ
প্যারামিটারগুলি
[in] buf
বাফারের একটি পয়েন্টার যেখানে স্ট্রিং লিখতে হবে। The supplied buffer should be at least as big as kGetPeerDescription_MaxLength. ছোট বাফার দেওয়া হলে, স্ট্রিংটি ছোট করে ফিট করা হবে। আউটপুটে সব ক্ষেত্রেই একটি NUL সমাপ্তি অক্ষর থাকবে।
[in] bufSize
buf দ্বারা নির্দেশিত বাফারের সাইজ।

GetPeerIPAddress

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

উপলভ্য থাকলে, পিয়ারের IP অ্যাড্রেস সংক্রান্ত তথ্য রিট্রিভ করুন।

পিয়ারের IP অ্যাড্রেস সংক্রান্ত তথ্যের উপলভ্যতা বাইন্ডিংয়ের অবস্থা এবং কনফিগারেশনের উপর নির্ভর করে। IP-ভিত্তিক ট্রান্সপোর্ট (TCP, UDP বা WRMP সহ UDP) ব্যবহার করার সময় IP অ্যাড্রেস সংক্রান্ত তথ্য শুধু উপলভ্য থাকে। প্রস্তুতি শুরু করার আগে, ঠিকানা সংক্রান্ত তথ্য তখনই উপলভ্য হয় যদি কনফিগারেশনের সময় অ্যাপ্লিকেশন দ্বারা এটি স্পষ্টভাবে সেট করা হয়। প্রস্তুতির পর্যায়ে, ঠিকানা প্রস্তুত করা সম্পূর্ণ হলে (যেমন, DNS রেজোলিউশন সম্পূর্ণ হওয়ার পরে) ঠিকানা সংক্রান্ত তথ্য উপলভ্য হয়। বাইন্ডিং রেডি হয়ে যাওয়ার পরে, বাইন্ডিং রিসেট না করা পর্যন্ত ঠিকানা সংক্রান্ত তথ্য উপলভ্য থাকে।

বিবরণ
প্যারামিটারগুলি
[out] address
IPAddress অবজেক্টের একটি রেফারেন্স যা পিয়ারের IP অ্যাড্রেস পাবে। পিয়ারের IP অ্যাড্রেস সংক্রান্ত তথ্য উপলভ্য না থাকলে, এই মানটি IPAddress::Any হিসেবে সেট করা হবে।
[out] port
একটি পূর্ণসংখ্যার রেফারেন্স যা পিয়ারের পোর্ট নম্বর পাবে। পিয়ারের IP অ্যাড্রেস সংক্রান্ত তথ্য উপলভ্য না থাকলে, এই ভ্যালু সংজ্ঞায়িত করা হয় না।
[out] interfaceId
একটি পূর্ণসংখ্যায় রেফারেন্স যা নেটওয়ার্ক ইন্টারফেসের আইডি পাবে যার মাধ্যমে পিয়ারকে রিচ করা যাবে। পিয়ার আইপি অ্যাড্রেস সংক্রান্ত তথ্য উপলভ্য না থাকলে, এই মানটি অনির্দিষ্ট।

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const 

বাইন্ডিং পিয়ারের নোড আইডি রিট্রিভ করুন।

বাইন্ডিং অবজেক্ট তৈরি হয়ে গেলে তবেই কাজ করে।

বিবরণ
ফেরত
পিয়ারের Weave নোড আইডি

GetProtocolLayerCallback

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

GetState

State GetState(
  void
) const 

বাইন্ডিংয়ের বর্তমান অবস্থা রিট্রিভ করুন।

বিবরণ
ফেরত
বাইন্ডিং স্টেট।

IsAuthenticMessageFromPeer

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

কোনও নির্দিষ্ট ইনকামিং মেসেজ কনফিগার করা পিয়ার থেকে এসেছে কিনা এবং সেটি সঠিকভাবে যাচাই করা হয়েছে কিনা তা নির্ধারণ করুন।

এই পদ্ধতি প্রদত্ত মেসেজ সম্পর্কে নিম্নলিখিত বিবরণ কনফার্ম করে:

  • বাইন্ডিংয়ের পিয়ার নোড থেকে মেসেজটি এসেছে
  • বাইন্ডিংয়ের মতো একই ট্রান্সপোর্ট টাইপের মাধ্যমে মেসেজটি পাওয়া গেছে। কোনও কানেকশনের মাধ্যমে মেসেজটি পাওয়া গেলে, এই পদ্ধতিটি এটিও কনফার্ম করে যে মেসেজটি বাইন্ডিংয়ের সাথে যুক্ত সঠিক কানেকশনের মাধ্যমে পাওয়া গেছে।
  • মেসেজ এনক্রিপ্ট করার জন্য ব্যবহৃত এনক্রিপশন কী ও ধরন বাইন্ডিংয়ে কনফিগার করা কী ও ধরনের সাথে ম্যাচ করে। নিরাপত্তা ব্যবহার না করে কনফিগার করা বাইন্ডিংয়ের ক্ষেত্রে, এই পদ্ধতি নিশ্চিত করে যে ইনকামিং মেসেজ এনক্রিপ্ট করা হয়নি।

এই পদ্ধতিটি WDM-এর মতো প্রোটোকলে ব্যবহার করার জন্য তৈরি করা হয়েছে যেখানে নোড থেকে পিয়ারে প্রাথমিক এক্সচেঞ্জের পরে পিয়াররা স্বতঃস্ফূর্তভাবে স্থানীয় নোডে এক্সচেঞ্জ শুরু করতে পারে। এই ধরনের ক্ষেত্রে, এই পদ্ধতিটি স্থানীয় নোডকে নিশ্চিত করতে দেয় যে ইনকামিং অবাঞ্ছিত মেসেজটি সংশ্লিষ্ট পিয়ার দ্বারা পাঠানো হয়েছে। (অবশ্যই, মেসেজ এনক্রিপশন ব্যবহার না করে কনফিগার করা বাইন্ডিংয়ের ক্ষেত্রে, এই অ্যাসারশন নিরাপত্তার দিক থেকে কোনও ভ্যালু প্রদান করে না। এটি শুধু নিশ্চিত করে যে প্রেরকের নোড আইডি এবং ট্রান্সপোর্ট ধরন মিলছে।)

মনে রাখবেন, বাইন্ডিং রেডি অবস্থায় না থাকলে, এই পদ্ধতি সবসময় false রিটার্ন করবে।

বিবরণ
প্যারামিটারগুলি
[in] msgInfo
ইনকামিং মেসেজের জন্য Weave মেসেজের তথ্য।
ফেরত
মেসেজটি যদি পিয়ারের থেকে নির্ভরযোগ্যভাবে আসে তাহলে ট্রু।

IsConnectionTransport

bool IsConnectionTransport() const 

IsPreparing

bool IsPreparing(
  void
) const 

বিবরণ
ফেরত
বাইন্ডিং বর্তমানে তৈরি করা হলে, 'সত্য' হিসেবে বিবেচিত হবে।

IsReady

bool IsReady(
  void
) const 

বিবরণ
ফেরত
বাইন্ডিং 'প্রস্তুত' স্ট্যাটাসে থাকলে ট্রু।

IsUDPTransport

bool IsUDPTransport() const 

IsUnreliableUDPTransport

bool IsUnreliableUDPTransport() const 

IsWRMTransport

bool IsWRMTransport() const 

NewExchangeContext

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

বাইন্ডিংয়ের টার্গেট যে পিয়ার তার সাথে যোগাযোগ করার জন্য নতুন এক্সচেঞ্জ কনটেক্সট বরাদ্দ করুন।

বিবরণ
প্যারামিটারগুলি
[out] appExchangeContext
একটি পয়েন্টারের রেফারেন্স যা নতুনভাবে বরাদ্দ করা এক্সচেঞ্জ কনটেক্সট অবজেক্ট পাবে। পদ্ধতিটি ব্যর্থ হলে পয়েন্টারটি NULL-এ সেট করা হবে।
রিটার্ন ভ্যালু
WEAVE_NO_ERROR
এক্সচেঞ্জ কনটেক্সট সফলভাবে অ্যাসাইন করা হলে।
WEAVE_ERROR_NO_MEMORY
এক্সচেঞ্জ কন্টেক্সট অ্যাসাইন করার জন্য কোনও মেমরি উপলভ্য না থাকলে।
WEAVE_ERROR_INCORRECT_STATE
বাইন্ডিং রেডি অবস্থায় না থাকলে।
other
বাইন্ডিংয়ের কনফিগারেশনের উপর ভিত্তি করে এক্সচেঞ্জ কনটেক্সট কনফিগার করার সাথে সম্পর্কিত অন্যান্য সমস্যা।

রিলিজ

void Release(
  void
)

বাইন্ডিং অবজেক্টের রেফারেন্স রিলিজ করুন।

বাইন্ডিং অবজেক্টের আর কোনও রেফারেন্স না থাকলে, বাইন্ডিং বন্ধ করে দেওয়া হয় এবং ফ্রি করে দেওয়া হয়।

RequestPrepare

WEAVE_ERROR RequestPrepare()

বাইন্ডিং কনফিগার ও প্রস্তুত করার জন্য অ্যাপ্লিকেশনকে অনুরোধ করুন।

প্রোটোকল লেয়ার কোড, কনফিগার করা হয়নি বা ব্যর্থ হয়েছে এমন বাইন্ডিংয়ে এই পদ্ধতি ব্যবহার করতে পারে, যাতে ব্যবহার করার জন্য বাইন্ডিং কনফিগার ও প্রস্তুত করার অনুরোধ করে অ্যাপ্লিকেশনকে (kEvent_PrepareRequested) ইভেন্ট ট্রিগার করা যায়।

এই পদ্ধতিটি শুধুমাত্র NotConfigured বা Failed স্ট্যাটাসে থাকা বাইন্ডিংয়ে কল করা যেতে পারে।

আবেদনটি যদি বাইন্ডিংয়ের অন-ডিমান্ড কনফিগারেশন/প্রিপারেশন সমর্থন না করে, তাহলে WEAVE_ERROR_NOT_IMPLEMENTED সহ পদ্ধতিটি ব্যর্থ হবে।

রিসেট করুন

void Reset(
  void
)

বাইন্ডিংকে কনফিগার না করা অবস্থায় রিসেট করুন।

Reset() কল করা হলে, বাইন্ডিংয়ের জন্য কোনও ইন-প্রগ্রেস প্রিপেয়ার অ্যাকশন বাতিল করা হয় এবং বাইন্ডিংয়ের কাছে থাকা সব এক্সটার্নাল কমিউনিকেশন রিসোর্স রিলিজ করা হয়। Reset() বাইন্ডিংকে কনফিগার না করা অবস্থায় নিয়ে যায়, যার পরে এটি আবার কনফিগার ও প্রস্তুত করা যেতে পারে।

Reset() বাইন্ডিংয়ের রেফারেন্স কাউন্ট পরিবর্তন করে না।

SetDefaultResponseTimeout

void SetDefaultResponseTimeout(
  uint32_t msec
)

পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট এক্সচেঞ্জ রেসপন্স টাইমআউট সেট করুন।

বিবরণ
প্যারামিটারগুলি
[in] timeout
নতুন রেসপন্স টাইমআউট, মিলিসেকেন্ডে।

SetDefaultWRMPConfig

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

পিয়ারের সাথে যোগাযোগ করার সময় ব্যবহার করার জন্য ডিফল্ট WRMP কনফিগারেশন সেট করুন।

বিবরণ
প্যারামিটারগুলি
[in] aWRMPConfig
নতুন ডিফল্ট কনফিগারেশন সহ WRMPConfig স্ট্রাকচারের রেফারেন্স।

SetEventCallback

void SetEventCallback(
  EventCallback aEventCallback
)

বাইন্ডিং-এর জন্য কোনও API ইভেন্ট ঘটলে কল করার জন্য অ্যাপ্লিকেশন-সংজ্ঞায়িত ফাংশন সেট করুন।

বিবরণ
প্যারামিটারগুলি
[in] aEventCallback
কলব্যাক ফাংশনের একটি পয়েন্টার।

SetProtocolLayerCallback

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

কোনও অ্যাপ্লিকেশনের হয়ে Binding ব্যবহার করে প্রোটোকল লেয়ার কোডের জন্য একটি ইভেন্ট কলব্যাক ফাংশন সেট করুন।

Binding-এর জন্য API ইভেন্ট ঘটলে, অ্যাপ্লিকেশন-সংজ্ঞায়িত কলব্যাক ফাংশনের পাশাপাশি এই ফাংশনটি কল করা হবে।

বিবরণ
প্যারামিটারগুলি
[in] callback
কলব্যাক ফাংশনের একটি পয়েন্টার।
[in] state
প্রোটোকল লেয়ার কলব্যাক হলে প্রোটোকল লেয়ার কোডে সাপ্লাই করা হবে এমন একটি স্টেট অবজেক্টের পয়েন্টার।

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

DefaultEventHandler

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

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

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

বিবরণ
প্যারামিটারগুলি
[in] apAppState
বাইন্ডিংয়ের সাথে যুক্ত অ্যাপ্লিকেশন-সংজ্ঞায়িত স্টেট তথ্যের একটি পয়েন্টার।
[in] aEvent
ইভেন্ট কলব্যাক দ্বারা পাস করা ইভেন্ট আইডি
[in] aInParam
ইভেন্ট কলব্যাক দ্বারা পাস করা ইনপুট ইভেন্ট প্যারামিটারের রেফারেন্স
[in] aOutParam
ইভেন্ট কলব্যাকের মাধ্যমে পাস করা আউটপুট ইভেন্ট প্যারামিটারের রেফারেন্স