chrome.sockets.tcpServer

الوصف

استخدِم واجهة برمجة التطبيقات chrome.sockets.tcpServer لإنشاء تطبيقات الخادم باستخدام اتصالات بروتوكول التحكم بالنقل. تحل واجهة برمجة التطبيقات هذه محل وظائف بروتوكول التحكم بالنقل التي تم العثور عليها سابقًا في واجهة برمجة تطبيقات chrome.socket.

البيان

يجب الإعلان عن المفاتيح التالية في البيان لاستخدام واجهة برمجة التطبيقات هذه.

"sockets"

الأنواع

AcceptErrorInfo

أماكن إقامة

  • resultCode

    الرقم

    رمز النتيجة الذي تم عرضه من استدعاء الشبكة الأساسي.

  • socketId

    الرقم

    معرِّف مقبس الخادم.

AcceptInfo

أماكن إقامة

  • clientSocketId

    الرقم

    معرِّف مقبس العميل، أي معرِّف المقبس للاتصال الذي تم إنشاؤه حديثًا. يجب استخدام معرّف المقبس هذا مع الدوال من مساحة الاسم chrome.sockets.tcp فقط. لاحظ أن مقبس العميل متوقف مؤقتًا في البداية ويجب إلغاء إيقافه مؤقتًا بشكل صريح بواسطة التطبيق لبدء تلقي البيانات.

  • socketId

    الرقم

    معرِّف مقبس الخادم.

CreateInfo

أماكن إقامة

  • socketId

    الرقم

    معرف مقبس الخادم الذي تم إنشاؤه حديثًا. تجدر الإشارة إلى أنّ أرقام تعريف المنافذ التي تم إنشاؤها من واجهة برمجة التطبيقات هذه لا تتوافق مع أرقام تعريف المنافذ التي تم إنشاؤها من واجهات برمجة تطبيقات أخرى، مثل واجهة برمجة التطبيقات [socket](../socket/) التي تم إيقافها نهائيًا.

SocketInfo

أماكن إقامة

  • localAddress

    سلسلة اختيارية

    إذا كان المقبس يستمع إلى ما سبق، يحتوي على عنوان IPv4/6 المحلي الخاص به.

  • localPort

    الرقم اختياري

    يحتوي المقبس على منفذه المحلي إذا كان المقبس يستمع إلى ما يلي.

  • الاسم

    سلسلة اختيارية

    سلسلة معرّف التطبيق المرتبطة بالمقبس

  • متوقفة مؤقتًا

    منطقي

    علامة تشير إلى ما إذا كان يتم إرسال طلبات الاتصال على مقبس الاستماع من خلال حدث onAccept أو تم وضعها في قائمة الانتظار في قائمة انتظار الاستماع يمكنك الاطّلاع على setPaused. القيمة التلقائية هي "خطأ".

  • مستمر

    منطقي

    علامة تشير إلى ما إذا كان المقبس مفتوحًا عند إلغاء تحميل صفحة حدث التطبيق (راجِع SocketProperties.persistent). القيمة التلقائية هي "خطأ".

  • socketId

    الرقم

    معرِّف المقبس

SocketProperties

أماكن إقامة

  • الاسم

    سلسلة اختيارية

    سلسلة يحددها التطبيق ومرتبطة بالمقبس.

  • مستمر

    قيمة منطقية اختيارية

    علامة تشير إلى ما إذا كان المقبس مفتوحًا عند إلغاء تحميل صفحة حدث التطبيق (يمكنك الاطّلاع على إدارة دورة حياة التطبيق) والقيمة الافتراضية هي "false". عند تحميل التطبيق، يمكن استخدام getSockets لاسترجاع أي مقابس تم فتحها مسبقًا باستخدام persistent=true.

الطُرق

close()

وعود 
chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
)

فصل المقبس وإتلافه. يجب إغلاق كل مقبس تم إنشاؤه بعد الاستخدام. لم يعد معرّف المقبس صالحًا بمجرد استدعاء الدالة. ومع ذلك، يمكن ضمان إغلاق المقبس فقط عند استدعاء معاودة الاتصال.

المعلمات

  • socketId

    الرقم

    معرِّف المقبس

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

create()

وعود 
chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
)

ينشئ مقبس خادم بروتوكول التحكم في الإرسال.

المعلمات

  • المواقع

    SocketProperties اختيارية

    خصائص المقبس (اختيارية).

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      هي نتيجة إنشاء المقبس.

المرتجعات

  • Promise&lt;CreateInfo&gt;

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

disconnect()

وعود 
chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
)

ينقطع مقبس الاستماع، أي إيقاف قبول الاتصالات الجديدة وتحرير العنوان/المنفذ الذي يرتبط به المقبس. يظل معرف المقبس صالحًا، على سبيل المثال: يمكن استخدامه مع listen لقبول الاتصالات في منفذ وعنوان جديدَين.

المعلمات

  • socketId

    الرقم

    معرِّف المقبس

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getInfo()

وعود 
chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
)

يسترجع حالة المقبس المحدد.

المعلمات

  • socketId

    الرقم

    معرِّف المقبس

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      كائن يحتوي على معلومات المقبس

المرتجعات

  • Promise&lt;SocketInfo&gt;

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getSockets()

وعود 
chrome.sockets.tcpServer.getSockets(
  callback?: function,
)

استرداد قائمة المقابس المفتوحة حاليًا التي يملكها التطبيق.

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

      مصفوفة كائن تحتوي على معلومات المقبس.

المرتجعات

  • Promise&lt;SocketInfo[]&gt;

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

listen()

chrome.sockets.tcpServer.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

يرصد الاتصالات على المنفذ والعنوان المحدَّدين. في حال كان المنفذ/العنوان قيد الاستخدام، تشير رسالة معاودة الاتصال إلى تعذُّر الإجراء.

المعلمات

  • socketId

    الرقم

    معرِّف المقبس

  • معالجة

    سلسلة

    عنوان الجهاز المحلي.

  • المنفذ

    الرقم

    منفذ الجهاز المحلي. عند الضبط على 0، يتم اختيار المنفذ المجاني ديناميكيًا. يمكن العثور على المنفذ المخصّص ديناميكيًا من خلال طلب الرقم getInfo.

  • قائمة المهام

    الرقم اختياري

    طول قائمة انتظار الاستماع في المقبس تعتمد القيمة التلقائية على نظام التشغيل (SOMAXCONN)، مما يضمن مدة قائمة انتظار معقولة لمعظم التطبيقات.

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (result: number) => void

    • نتيجة

      الرقم

      رمز النتيجة الذي تم عرضه من استدعاء الشبكة الأساسي. تشير القيمة السالبة إلى وجود خطأ.

setPaused()

وعود 
chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

تفعيل مقبس الاستماع أو إيقافه من قبول الاتصالات الجديدة. عند الإيقاف المؤقت، يقبل مقبس الاستماع الاتصالات الجديدة إلى أن تمتلئ قائمة المهام (راجع الدالة listen) ثم يرفض طلبات الاتصال الإضافية. لا يتم رفع أحداث onAccept إلا عند إلغاء إيقاف المقبس مؤقتًا.

المعلمات

  • socketId

    الرقم

  • متوقفة مؤقتًا

    منطقي

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

update()

وعود 
chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

لتعديل خصائص المقبس

المعلمات

  • socketId

    الرقم

    معرِّف المقبس

  • المواقع

    SocketProperties

    السمات المطلوب تعديلها.

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 121 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

فعاليات

onAccept

chrome.sockets.tcpServer.onAccept.addListener(
  callback: function,
)

تم رفع الحدث عند إجراء اتصال بمقبس الخادم.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (info: AcceptInfo) => void

onAcceptError

chrome.sockets.tcpServer.onAcceptError.addListener(
  callback: function,
)

ظهر الحدث عند حدوث خطأ في الشبكة أثناء انتظار بيئة التشغيل للاتصالات الجديدة على عنوان المقبس والمنفذ. بعد رفع هذا الحدث، يتم ضبط المقبس على paused ولن يتم رفع أحداث onAccept الأخرى لهذا المقبس إلى أن يتم استئناف المقبس.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (info: AcceptErrorInfo) => void