الوصف
يمكنك استخدام واجهة برمجة تطبيقات chrome.sockets.tcp
لإرسال البيانات واستلامها عبر الشبكة باستخدام اتصالات بروتوكول التحكم بالنقل. تحلّ واجهة برمجة التطبيقات هذه محلّ وظائف بروتوكول التحكم بالنقل التي كانت متوفّرة سابقًا في واجهة برمجة تطبيقات chrome.socket
.
البيان
يجب الإعلان عن المفاتيح التالية في ملف البيان كي تتمكّن من استخدام واجهة برمجة التطبيقات هذه.
"sockets"
الأنواع
CreateInfo
أماكن إقامة
-
socketId
الرقم
معرّف المقبس الذي تم إنشاؤه حديثًا. تجدر الإشارة إلى أنّ معرّفات المقابس التي يتم إنشاؤها من واجهة برمجة التطبيقات هذه غير متوافقة مع معرّفات المقابس التي تم إنشاؤها من واجهات برمجة تطبيقات أخرى، مثل واجهة برمجة تطبيقات
[
socket](../socket/)
المتوقّفة نهائيًا.
DnsQueryType
تفضيلات التحويل باستخدام نظام أسماء النطاقات (DNS). الإعداد التلقائي هو any
ويستخدم إعدادات نظام التشغيل الحالية التي قد تعرض IPv4 أو IPv6. ipv4
يفرض IPv4، وipv6
يفرض IPv6.
التعداد
"ipv4"
"ipv6"
ReceiveErrorInfo
أماكن إقامة
-
resultCode
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية
-
socketId
الرقم
معرّف المقبس
ReceiveInfo
أماكن إقامة
-
البيانات
ArrayBuffer
تم استلام البيانات، ويبلغ الحد الأقصى للحجم
bufferSize
. -
socketId
الرقم
معرّف المقبس
SecureOptions
أماكن إقامة
-
tlsVersion
TLSVersionConstraints اختيارية
SendInfo
أماكن إقامة
-
bytesSent
الرقم اختياري
عدد وحدات البايت المرسلة (إذا كانت النتيجة == 0)
-
resultCode
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية تشير القيمة السالبة إلى وجود خطأ.
SocketInfo
أماكن إقامة
-
bufferSize
الرقم اختياري
حجم المخزن المؤقت المستخدم لاستقبال البيانات. إذا لم يتم تحديد حجم للمخزن المؤقت بشكل صريح، لن يتم تقديم القيمة.
-
تم الربط
boolean
علامة تشير إلى ما إذا كان المقبس متصلاً بنظير بعيد
-
localAddress
سلسلة اختيارية
إذا كان المقبس الأساسي متصلاً، يحتوي على عنوان IPv4/6 المحلي.
-
localPort
الرقم اختياري
إذا كان المقبس الأساسي متصلاً، يحتوي على منفذه المحلي.
-
اسم
سلسلة اختيارية
سلسلة يحددها التطبيق مرتبطة بالمقبس.
-
متوقف مؤقتًا
boolean
علامة تشير إلى ما إذا كان المقبس المتصل يمنع نظيره من إرسال المزيد من البيانات (يُرجى الاطّلاع على
setPaused
). -
peerAddress
سلسلة اختيارية
في حال توصيل المقبس الأساسي، يتم استخدام عنوان IP/ IPv4/6.
-
peerPort
الرقم اختياري
في حال توصيل المقبس الأساسي، يتم استخدام المنفذ المنبثق.
-
ثابت
boolean
علامة تشير إلى ترك المقبس مفتوحًا أثناء تعليق التطبيق (راجِع
SocketProperties.persistent
) -
socketId
الرقم
معرّف المقبس
SocketProperties
أماكن إقامة
-
bufferSize
الرقم اختياري
حجم المخزن المؤقت المستخدم لاستقبال البيانات. القيمة التلقائية هي 4096.
-
اسم
سلسلة اختيارية
يشير ذلك المصطلح إلى سلسلة يحدِّدها التطبيق مرتبطة بالمقبس.
-
ثابت
منطقية اختيارية
علامة تشير إلى ترك المقبس مفتوحًا عند إلغاء تحميل صفحة حدث التطبيق (راجِع إدارة مراحل نشاط التطبيق) القيمة التلقائية هي "false". عند تحميل التطبيق، يمكن استرجاع أي مقابس تم فتحها مسبقًا باستخدام persistent=true باستخدام
getSockets
.
TLSVersionConstraints
أماكن إقامة
-
الحد الأقصى
سلسلة اختيارية
-
دقيقة
سلسلة اختيارية
الحد الأدنى والحد الأقصى من إصدارات بروتوكول أمان طبقة النقل (TLS) المقبولة والقيمتان المسموح بإدراجهما هما
tls1.2
أوtls1.3
.لم تعُد القيم
tls1
وtls1.1
متاحة. في حال ضبط السمةmin
على إحدى هذه القيم، سيتم تثبيتها بدون تنبيه صوتي علىtls1.2
. وفي حال ضبط السمةmax
على إحدى هذه القيم أو على أي قيمة أخرى غير معروفة، سيتم تجاهلها بدون تنبيه.
الطُرق
close()
chrome.sockets.tcp.close(
socketId: number,
callback?: function,
)
يتم إغلاق المقبس وتحرير العنوان/المنفذ المرتبط بالمقبس. يجب إغلاق كل مقبس تم إنشاؤه بعد الاستخدام. لم يعد معرف المقبس صالحًا بمجرد استدعاء الدالة. ومع ذلك، لا يمكن ضمان إغلاق المقبس إلا عند استدعاء معاودة الاتصال.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
connect()
chrome.sockets.tcp.connect(
socketId: number,
peerAddress: string,
peerPort: number,
dnsQueryType?: DnsQueryType,
callback: function,
)
توصيل المقبس بجهاز بعيد. عند اكتمال عملية "connect
" بنجاح، يتم جمع أحداث "onReceive
" عند تلقّي البيانات من التطبيق المشابه. إذا حدث خطأ في الشبكة أثناء استلام وقت التشغيل للحِزم، يُرجَّح حدث onReceiveError
، وعندها لن يتم رفع حدث onReceive
لهذا المقبس حتى يتم استدعاء طريقة resume
.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
peerAddress
سلسلة
عنوان الجهاز البعيد. يمكن استخدام تنسيقات الاسم "نظام أسماء النطاقات" وIPv4 وIPv6.
-
peerPort
الرقم
منفذ الجهاز البعيد
-
dnsQueryType
DnsQueryType اختيارية
Chrome 103 والإصدارات الأحدثتفضيل دقة العنوان
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(result: number) => void
-
نتيجة
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية تشير القيمة السالبة إلى وجود خطأ.
-
create()
chrome.sockets.tcp.create(
properties?: SocketProperties,
callback?: function,
)
تنشئ مقبس بروتوكول التحكم بالنقل.
المَعلمات
-
المواقع
SocketProperties اختيارية
خصائص المقبس (اختيارية)
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(createInfo: CreateInfo) => void
-
createInfo
نتيجة إنشاء المقبس
-
المرتجعات
-
Promise<CreateInfo>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
disconnect()
chrome.sockets.tcp.disconnect(
socketId: number,
callback?: function,
)
يتم فصل المقبس
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
getInfo()
chrome.sockets.tcp.getInfo(
socketId: number,
callback?: function,
)
لاسترداد حالة المقبس المحدد.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(socketInfo: SocketInfo) => void
-
socketInfo
عنصر يحتوي على معلومات المقبس
-
المرتجعات
-
Promise<SocketInfo>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
getSockets()
chrome.sockets.tcp.getSockets(
callback?: function,
)
يسترد قائمة المقابس المفتوحة حاليًا التي يملكها التطبيق.
المَعلمات
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:(socketInfos: SocketInfo[]) => void
-
socketInfos
مصفوفة كائنات تحتوي على معلومات المقبس
-
المرتجعات
-
Promise<SocketInfo[]>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
secure()
chrome.sockets.tcp.secure(
socketId: number,
options?: SecureOptions,
callback: function,
)
ابدأ اتصال عميل بروتوكول أمان طبقة النقل (TLS) من خلال مقبس عميل بروتوكول التحكم بالنقل المرتبط.
المَعلمات
-
socketId
الرقم
المقبس المتصل الحالي والمطلوب استخدامه.
-
الخيارات
SecureOptions اختيارية
القيود والمَعلمات لاتصال بروتوكول أمان طبقة النقل (TLS).
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(result: number) => void
-
نتيجة
الرقم
-
send()
chrome.sockets.tcp.send(
socketId: number,
data: ArrayBuffer,
callback: function,
)
يرسل البيانات على مقبس بروتوكول التحكم بالنقل المحدد.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
البيانات
ArrayBuffer
البيانات المطلوب إرسالها.
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(sendInfo: SendInfo) => void
-
sendInfo
نتيجة طريقة
send
.
-
setKeepAlive()
chrome.sockets.tcp.setKeepAlive(
socketId: number,
enable: boolean,
delay?: number,
callback: function,
)
تمكين أو إيقاف وظيفة البقاء على قيد الحياة لاتصال TCP.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
enable
boolean
في حال الضبط على "صحيح"، فعِّل وظيفة البقاء على قيد الحياة.
-
delay
الرقم اختياري
يمكنك ضبط مهلة التأخير بالثواني بين آخر حزمة بيانات تم استلامها ومسايرة رسالة التحقّق من الاتصال الأولى. وتكون القيمة التلقائية 0.
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(result: number) => void
-
نتيجة
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية تشير القيمة السالبة إلى وجود خطأ.
-
setNoDelay()
chrome.sockets.tcp.setNoDelay(
socketId: number,
noDelay: boolean,
callback: function,
)
لضبط TCP_NODELAY
أو محوه لاتصال TCP. سيتم إيقاف خوارزمية Nagle عند ضبط TCP_NODELAY
.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
noDelay
boolean
إذا كانت القيمة true، سيتم إيقاف خوارزمية Nagle.
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(result: number) => void
-
نتيجة
الرقم
رمز النتيجة الذي تم عرضه من الاتصال بالشبكة الأساسية تشير القيمة السالبة إلى وجود خطأ.
-
setPaused()
chrome.sockets.tcp.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
يؤدي هذا الخيار إلى تفعيل التطبيق أو إيقافه من تلقّي الرسائل من التطبيقات المشابهة. القيمة التلقائية هي "false". يتم عادةً استخدام إيقاف المقبس مؤقتًا بواسطة التطبيق لتقييد البيانات التي يرسلها نظيره. عند إيقاف المقبس مؤقتًا، لا يتم رفع حدث onReceive
. عند توصيل المقبس وإلغاء الإيقاف المؤقت، يتم رفع أحداث onReceive
مرة أخرى عند استلام الرسائل.
المَعلمات
-
socketId
الرقم
-
متوقف مؤقتًا
boolean
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
update()
chrome.sockets.tcp.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
لتحديث خصائص المقبس.
المَعلمات
-
socketId
الرقم
معرّف المقبس
-
المواقع
السمات المطلوب تعديلها
-
معاودة الاتصال
الدالة اختيارية
تبدو معلَمة
callback
على النحو التالي:() => void
المرتجعات
-
Promise<void>
Chrome 121 والإصدارات الأحدثلا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.
فعاليات
onReceive
chrome.sockets.tcp.onReceive.addListener(
callback: function,
)
تم رفع الحدث عند استلام بيانات لمقبس معيَّن.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(info: ReceiveInfo) => void
-
معلومات
-
onReceiveError
chrome.sockets.tcp.onReceiveError.addListener(
callback: function,
)
تم رفع الحدث عند حدوث خطأ في الشبكة أثناء انتظار وقت التشغيل للبيانات على عنوان المقبس والمنفذ. بعد رفع هذا الحدث، يتم ضبط المقبس على paused
ولن يتم رفع أحداث onReceive
أخرى لهذا المقبس.
المَعلمات
-
معاودة الاتصال
الوظيفة
تبدو معلَمة
callback
على النحو التالي:(info: ReceiveErrorInfo) => void
-
معلومات
-