UDP

تتضمن هذه الوحدة وظائف تتحكم في اتصال UDP.

ملخّص

عمليات التعداد
otNetifIdentifier{
  OT_NETIF_UNSPECIFIED = 0,
  OT_NETIF_THREAD,
  OT_NETIF_BACKBONE
} 		تعداد
تحدِّد هذه السياسة معرِّفات واجهة شبكة OpenThread.

تحديدات النوع
otNetifIdentifier typedef
تحدِّد هذه السياسة معرِّفات واجهة شبكة OpenThread.
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
تسمح معاودة الاتصال هذه لتقنية OpenThread بتوفير معالجات محدَّدة لرسائل UDP معيّنة.
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
تسمح معاودة الاتصال هذه لـ OpenThread إعلام التطبيق برسالة UDP تم استلامها.
otUdpReceiver typedef
struct otUdpReceiver
يمثل جهاز استقبال UDP.
otUdpSocket typedef
struct otUdpSocket
يُمثِّل مقبس UDP.

الدوال
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
لإضافة جهاز استقبال UDP.
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
ربط مقبس UDP/IPv6.
otUdpClose(otInstance *aInstance, otUdpSocket *aSocket)
أغلِق مقبس UDP/IPv6.
otUdpConnect(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
قم بتوصيل مقبس UDP/IPv6.
otUdpGetSockets(otInstance *aInstance)
للحصول على رأس القائمة المرتبطة بمقابس UDP.
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
bool
تحقَّق مما إذا كان مقبس UDP مفتوحًا.
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
تخصيص مخزن مؤقت جديد للرسائل لإرسال رسالة UDP.
otUdpOpen(otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
افتح مقبس UDP/IPv6.
otUdpRemoveReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
لإزالة جهاز استقبال UDP.
otUdpSend(otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
إرسال رسالة UDP/IPv6.
otUdpSendDatagram(otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
لإرسال رسالة UDP بدون مقبس

الهياكل
otUdpReceiver

يمثل جهاز استقبال UDP.

otUdpSocket

يُمثِّل مقبس UDP.

عمليات التعداد

otNetifIdentifier

 otNetifIdentifier

تحدِّد هذه السياسة معرِّفات واجهة شبكة OpenThread.

أماكن إقامة
OT_NETIF_BACKBONE

واجهة "العمود الرئيسي".

OT_NETIF_THREAD

واجهة سلسلة المحادثات

OT_NETIF_UNSPECIFIED

واجهة شبكة غير محدّدة

تحديدات النوع

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

تحدِّد هذه السياسة معرِّفات واجهة شبكة OpenThread.

otUdpHandler

bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)

تسمح معاودة الاتصال هذه لتقنية OpenThread بتوفير معالجات محدَّدة لرسائل UDP معيّنة.

التفاصيل
قيم الإرجاع
true
يتعامل هذا المُستلِم مع الرسالة، ويجب عدم معالجتها مرة أخرى.
false
لا يتعامل هذا المستلِم مع الرسالة.

otUdpReceive

void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

تسمح معاودة الاتصال هذه لـ OpenThread إعلام التطبيق برسالة UDP تم استلامها.

otUdpReceiver

struct otUdpReceiver otUdpReceiver

يمثل جهاز استقبال UDP.

otUdpSocket

struct otUdpSocket otUdpSocket

يُمثِّل مقبس UDP.

الدوال

otUdpAddReceiver

otError otUdpAddReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

لإضافة جهاز استقبال UDP.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aUdpReceiver
مؤشر يشير إلى مستلِم UDP.
قيم الإرجاع
OT_ERROR_NONE
تمت إضافة المستلِم بنجاح.
OT_ERROR_ALREADY
سبق أن تمت إضافة جهاز استقبال UDP.

otUdpBind

otError otUdpBind(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName,
  otNetifIdentifier aNetif
)

ربط مقبس UDP/IPv6.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
[in] aSockName
يشير هذا المصطلح إلى مؤشر إلى بنية عنوان مقبس IPv6.
[in] aNetif
واجهة الشبكة المطلوب ربطها
قيم الإرجاع
OT_ERROR_NONE
تمت عملية الربط بنجاح.
OT_ERROR_FAILED
تعذّر ربط مقبس UDP.

otUdpClose

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

أغلِق مقبس UDP/IPv6.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
قيم الإرجاع
OT_ERROR_NONE
تم إغلاق المقبس.
OT_ERROR_FAILED
تعذَّر إغلاق مقبس UDP.

otUdpConnect

otError otUdpConnect(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName
)

قم بتوصيل مقبس UDP/IPv6.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
[in] aSockName
يشير هذا المصطلح إلى مؤشر إلى بنية عنوان مقبس IPv6.
قيم الإرجاع
OT_ERROR_NONE
تمت عملية الاتصال بنجاح.
OT_ERROR_FAILED
تعذّر توصيل مقبس UDP.

otUdpGetSockets

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

للحصول على رأس القائمة المرتبطة بمقابس UDP.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
المرتجعات
مؤشر يشير إلى رأس القائمة المرتبطة بمقبس UDP.

otUdpIsOpen

bool otUdpIsOpen(
  otInstance *aInstance,
  const otUdpSocket *aSocket
)

تحقَّق مما إذا كان مقبس UDP مفتوحًا.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
المرتجعات
ما إذا كان مقبس UDP مفتوحًا أم لا.

otUdpNewMessage

otMessage * otUdpNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

تخصيص مخزن مؤقت جديد للرسائل لإرسال رسالة UDP.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSettings
مؤشر إلى إعدادات الرسالة أو فارغ لاستخدام الإعدادات التلقائية.
المرتجعات
يشير هذا المصطلح إلى مؤشر المخزن المؤقت للرسائل أو NULL في حال عدم توفّر أي مخازن مؤقتة للرسائل أو كانت المَعلمات غير صالحة.
يمكنك الاطّلاع أيضًا على:
otMessageFree

otUdpOpen

otError otUdpOpen(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otUdpReceive aCallback,
  void *aContext
)

افتح مقبس UDP/IPv6.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
[in] aCallback
مؤشر لدالة استدعاء التطبيق.
[in] aContext
مؤشر إلى السياق الخاص بالتطبيق.
قيم الإرجاع
OT_ERROR_NONE
تم فتح المقبس بنجاح.
OT_ERROR_FAILED
تعذّر فتح المقبس.

otUdpRemoveReceiver

otError otUdpRemoveReceiver(
  otInstance *aInstance,
  otUdpReceiver *aUdpReceiver
)

لإزالة جهاز استقبال UDP.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aUdpReceiver
مؤشر يشير إلى مستلِم UDP.
قيم الإرجاع
OT_ERROR_NONE
تمت إزالة المستلِم بنجاح.
OT_ERROR_NOT_FOUND
لم تتم إضافة جهاز استقبال UDP.

otUdpSend

otError otUdpSend(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

إرسال رسالة UDP/IPv6.

إذا كانت القيمة المعروضة هي OT_ERROR_NONE، سيحصل OpenThread على ملكية aMessage، ويجب ألا يشير المتصل إلى aMessage بعد ذلك. وإذا لم تكن القيمة المعروضة OT_ERROR_NONE، يحتفظ المتصل بملكية aMessage، بما في ذلك تحرير aMessage إذا لم تعد هناك حاجة إلى المخزن المؤقت للرسائل.

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aSocket
مؤشر يشير إلى بنية مقبس UDP.
[in] aMessage
مؤشر يشير إلى المخزن المؤقت للرسائل.
[in] aMessageInfo
يشير هذا المصطلح إلى مؤشر لبنية معلومات الرسالة.

التفاصيل
قيم الإرجاع
OT_ERROR_NONE
تمت جدولة إرسال الرسالة بنجاح.
OT_ERROR_INVALID_ARGS
تم تقديم وسيطات غير صالحة.
OT_ERROR_NO_BUFS
المخزن المؤقت المتوفر غير كافٍ لإضافة رؤوس UDP وIPv6.

otUdpSendDatagram

otError otUdpSendDatagram(
  otInstance *aInstance,
  otMessage *aMessage,
  otMessageInfo *aMessageInfo
)

لإرسال رسالة UDP بدون مقبس

التفاصيل
المَعلمات
[in] aInstance
يشير هذا المصطلح إلى مؤشر لمثيل OpenThread.
[in] aMessage
يشير هذا المصطلح إلى مؤشر لرسالة بدون عنوان UDP.
[in] aMessageInfo
مؤشر يشير إلى معلومات رسالة مرتبطة بالعنوان aMessage.
قيم الإرجاع
OT_ERROR_NONE
تم إدراج الرسالة في قائمة الانتظار بنجاح في واجهة إخراج.
OT_ERROR_NO_BUFS
المخزن المؤقت المتوفر غير كافٍ لإضافة رؤوس IPv6.
OT_ERROR_INVALID_ARGS
تم تقديم وسيطات غير صالحة.

المراجِع

تنشأ المواضيع المرجعية لواجهة برمجة تطبيقات OpenThread من رمز المصدر المتاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في مستنداتنا، يمكنك الاطّلاع على المراجع.