الوصف
استخدِم واجهة برمجة التطبيقات chrome.sockets.tcpServer
API لإنشاء تطبيقات الخادم باستخدام اتصالات بروتوكول التحكم بالنقل. تحلّ واجهة برمجة التطبيقات هذه محلّ وظائف بروتوكول التحكم بالنقل التي كانت متوفّرة سابقًا في واجهة برمجة تطبيقات chrome.socket
.
البيان
يجب الإعلان عن المفاتيح التالية في ملف البيان كي تتمكّن من استخدام واجهة برمجة التطبيقات هذه.
"sockets"
الأنواع
AcceptErrorInfo
أماكن إقامة
-
resultCode
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية
-
socketId
الرقم
معرّف مقبس الخادم
AcceptInfo
أماكن إقامة
-
clientSocketId
الرقم
معرّف مقبس العميل، أي معرّف مقبس الاتصال الذي تم إنشاؤه حديثًا. يجب استخدام معرّف المقبس هذا فقط مع وظائف من مساحة الاسم
chrome.sockets.tcp
. تجدر الإشارة إلى أنّه يتم إيقاف مقبس العميل مؤقتًا مبدئيًا ويجب أن يوقفه التطبيق بشكل صريح لبدء تلقّي البيانات. -
socketId
الرقم
معرّف مقبس الخادم
CreateInfo
أماكن إقامة
-
socketId
الرقم
معرّف مقبس الخادم الذي تم إنشاؤه حديثًا. تجدر الإشارة إلى أنّ معرّفات المقابس التي يتم إنشاؤها من واجهة برمجة التطبيقات هذه غير متوافقة مع معرّفات المقابس التي تم إنشاؤها من واجهات برمجة تطبيقات أخرى، مثل واجهة برمجة تطبيقات
[
socket](../socket/)
المتوقّفة نهائيًا.
SocketInfo
أماكن إقامة
-
localAddress
سلسلة اختيارية
إذا كان المقبس قيد الاستماع، يحتوي على عنوان IPv4/6 المحلي.
-
localPort
الرقم اختياري
إذا كان المقبس قيد الاستماع، يحتوي على منفذه المحلي.
-
اسم
سلسلة اختيارية
سلسلة يحددها التطبيق مرتبطة بالمقبس.
-
متوقف مؤقتًا
boolean
علامة تشير إلى ما إذا تم إرسال طلبات الاتصال على مقبس توصيل من خلال الحدث
onAccept
أو وضعها في قائمة مهام قائمة انتظار الاستماع يمكنك الاطّلاع علىsetPaused
. القيمة التلقائية هي "false". -
ثابت
boolean
علامة تشير إلى ما إذا كان المقبس لا يزال مفتوحًا عند إلغاء تحميل صفحة الحدث للتطبيق (راجِع
SocketProperties.persistent
). القيمة التلقائية هي "false". -
socketId
الرقم
معرّف المقبس
SocketProperties
أماكن إقامة
-
اسم
سلسلة اختيارية
يشير ذلك المصطلح إلى سلسلة يحدِّدها التطبيق مرتبطة بالمقبس.
-
ثابت
منطقية اختيارية
علامة تشير إلى بقاء المقبس مفتوحًا عند إلغاء تحميل صفحة الحدث للتطبيق (راجِع إدارة مراحل نشاط التطبيق) القيمة التلقائية هي "false". عند تحميل التطبيق، يمكن استرجاع أي مقابس تم فتحها مسبقًا باستخدام persistent=true باستخدام
getSockets
.
الطُرق
close()
chrome.sockets.tcpServer.close(
socketId: number,
callback?: function,
)
يتم فصل المقبس وإتلافه. يجب إغلاق كل مقبس تم إنشاؤه بعد الاستخدام. لم يعد معرف المقبس صالحًا عند استدعاء الدالة. ومع ذلك، لا يمكن ضمان إغلاق المقبس إلا عند استدعاء معاودة الاتصال.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
create()
chrome.sockets.tcpServer.create(
properties?: SocketProperties,
callback?: function,
)
تنشئ مقبس خادم TCP.
المَعلمات
-
المواقع
SocketProperties اختيارية
خصائص المقبس (اختيارية)
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(createInfo: CreateInfo) => void
-
createInfo
نتيجة إنشاء المقبس
-
المرتجعات
-
Promise<CreateInfo>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
disconnect()
chrome.sockets.tcpServer.disconnect(
socketId: number,
callback?: function,
)
تفصِل مقبس الاستماع، أي إيقاف قبول الاتصالات الجديدة وإطلاق العنوان/المنفذ المرتبط بالمقبس. يظل معرّف المقبس صالحًا، على سبيل المثال يمكن استخدامه مع listen
لقبول الاتصالات على المنفذ والعنوان الجديدين.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
getInfo()
chrome.sockets.tcpServer.getInfo(
socketId: number,
callback?: function,
)
لاسترداد حالة المقبس المحدد.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(socketInfo: SocketInfo) => void
-
socketInfo
عنصر يحتوي على معلومات المقبس
-
المرتجعات
-
Promise<SocketInfo>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
getSockets()
chrome.sockets.tcpServer.getSockets(
callback?: function,
)
يسترد قائمة المقابس المفتوحة حاليًا التي يملكها التطبيق.
المَعلمات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(socketInfos: SocketInfo[]) => void
-
socketInfos
مصفوفة كائنات تحتوي على معلومات المقبس
-
المرتجعات
-
Promise<SocketInfo[]>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من 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
الرقم
-
متوقف مؤقتًا
boolean
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
update()
chrome.sockets.tcpServer.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
لتحديث خصائص المقبس.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
المواقع
السمات المطلوب تعديلها
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من 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
-
معلومات
-