chrome.sockets.tcp

الوصف

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

البيان

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

"sockets"

الأنواع

CreateInfo

أماكن إقامة

  • socketId

    الرقم

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

DnsQueryType

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

الإعدادات المفضّلة لحلول نظام أسماء النطاقات. القيمة التلقائية هي any وتستخدم إعدادات نظام التشغيل الحالية التي قد تعرض IPv4 أو IPv6. تفرض ipv4 الإصدار 4 من بروتوكول IP، وتفرض ipv6 الإصدار السادس من بروتوكول الإنترنت (IPv6).

Enum

"أيّ"

"ipv4"

"ipv6"

ReceiveErrorInfo

أماكن إقامة

  • resultCode

    الرقم

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

  • socketId

    الرقم

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

ReceiveInfo

أماكن إقامة

  • البيانات

    مخزن المصفوفات

    البيانات التي تم استلامها، بحد أقصى bufferSize

  • socketId

    الرقم

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

SecureOptions

أماكن إقامة

SendInfo

أماكن إقامة

  • bytesSent

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

    عدد وحدات البايت المرسلة (إذا كانت النتيجة == 0)

  • resultCode

    الرقم

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

SocketInfo

أماكن إقامة

  • bufferSize

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

    حجم المخزن المؤقت المستخدم لتلقي البيانات. إذا لم يتم تحديد حجم للمخزن المؤقت بشكل صريح، لن يتم تقديم القيمة.

  • تم الربط

    منطقي

    علامة تشير إلى ما إذا كان المقبس متصلاً بنظير بعيد

  • localAddress

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

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

  • localPort

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

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

  • الاسم

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

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

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

    منطقي

    علامة تشير إلى ما إذا كان المقبس المتصل يمنع نظيره من إرسال المزيد من البيانات (راجِع setPaused).

  • peerAddress

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

    إذا كان المقبس الأساسي متصلاً بالمقبس، يحتوي على عنوان النظير/ IPv4/6.

  • peerPort

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

    يحتوي المقبس الأساسي على المنفذ النظير إذا كان متصلاً

  • مستمر

    منطقي

    علامة تشير إلى ترك المقبس مفتوحًا عند تعليق التطبيق (راجع SocketProperties.persistent).

  • socketId

    الرقم

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

SocketProperties

أماكن إقامة

  • bufferSize

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

    حجم المخزن المؤقت المستخدم لتلقي البيانات. القيمة التلقائية هي 4096.

  • الاسم

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

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

  • مستمر

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

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

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

المرتجعات

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

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

    لا تتوفّر الوعود إلا مع إصدار 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 اختياري

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

    تفضيل تحليل العنوان.

  • رد الاتصال

    دالة

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

    (result: number) => void

    • نتيجة

      الرقم

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

create()

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

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

المعلمات

  • المواقع

    SocketProperties اختيارية

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

  • رد الاتصال

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

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

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

المرتجعات

  • Promise&lt;CreateInfo&gt;

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

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

disconnect()

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

لفصل المقبس.

المعلمات

  • socketId

    الرقم

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

  • رد الاتصال

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

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

    () => void

المرتجعات

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

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

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

getInfo()

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

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

المعلمات

  • socketId

    الرقم

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

  • رد الاتصال

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

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

المرتجعات

  • Promise&lt;SocketInfo&gt;

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

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

getSockets()

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

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

المعلمات

  • رد الاتصال

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

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

    (socketInfos: SocketInfo[]) => void

    • socketInfos

      SocketInfo[]

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

المرتجعات

  • Promise&lt;SocketInfo[]&gt;

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

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

secure()

chrome.sockets.tcp.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

ابدأ اتصال عميل TLS عبر مقبس عميل TCP المتصل.

المعلمات

  • socketId

    الرقم

    المقبس الحالي المتصل لاستخدامه.

  • الخيارات

    SecureOptions اختيارية

    القيود والمَعلمات لاتصال بروتوكول أمان طبقة النقل (TLS)

  • رد الاتصال

    دالة

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

    (result: number) => void

    • نتيجة

      الرقم

send()

chrome.sockets.tcp.send(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

يرسل البيانات على مقبس بروتوكول التحكم بالنقل المحدد.

المعلمات

  • socketId

    الرقم

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

  • البيانات

    مخزن المصفوفات

    البيانات المراد إرسالها.

  • رد الاتصال

    دالة

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

    (sendInfo: SendInfo) => void

    • sendInfo

      SendInfo

      نتيجة طريقة send.

setKeepAlive()

chrome.sockets.tcp.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

تمكين أو تعطيل وظيفة الاستمرار في اتصال TCP.

المعلمات

  • socketId

    الرقم

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

  • تفعيل

    منطقي

    إذا كانت القيمة هي "صحيح"، يمكنك تفعيل وظيفة الاحتفاظ بالأحداث.

  • تأخير

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

    اضبط عدد ثواني التأخير بين آخر حزمة بيانات تم تلقّيها وأول رسالة التحقّق من الاتصال. القيمة التلقائية هي 0.

  • رد الاتصال

    دالة

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

    (result: number) => void

    • نتيجة

      الرقم

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

setNoDelay()

chrome.sockets.tcp.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

لضبط TCP_NODELAY أو محوها لاتصال TCP. سيتم إيقاف خوارزمية Nagle عند ضبط TCP_NODELAY.

المعلمات

  • socketId

    الرقم

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

  • noDelay

    منطقي

    إذا كانت القيمة هي true، سيتم إيقاف خوارزمية Nagle.

  • رد الاتصال

    دالة

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

    (result: number) => void

    • نتيجة

      الرقم

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

setPaused()

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

تمكين أو تعطيل التطبيق من تلقي الرسائل من التطبيقات المشابهة. القيمة التلقائية هي "خطأ". عادةً ما يستخدم أحد التطبيقات إيقاف المقبس مؤقتًا للتحكم في البيانات التي يرسلها نظيره. عند إيقاف المقبس مؤقتًا، لا يتم رفع حدث onReceive. في حال توصيل مقبس وإلغاء إيقافه مؤقتًا، يتم رفع أحداث onReceive مرة أخرى عند استلام الرسائل.

المعلمات

  • socketId

    الرقم

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

    منطقي

  • رد الاتصال

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

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

    () => void

المرتجعات

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

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

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

update()

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

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

المعلمات

  • socketId

    الرقم

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

  • المواقع

    SocketProperties

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

  • رد الاتصال

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

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

    () => void

المرتجعات

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

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

    لا تتوفّر الوعود إلا مع إصدار 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