chrome.sockets.tcp

توضیحات

از chrome.sockets.tcp API برای ارسال و دریافت داده ها از طریق شبکه با استفاده از اتصالات TCP استفاده کنید. این API جایگزین عملکرد TCP می شود که قبلاً در chrome.socket API یافت شده بود.

آشکار

برای استفاده از این API باید کلیدهای زیر در مانیفست اعلان شوند.

"sockets"

انواع

CreateInfo

خواص

• socketId

  شماره

  شناسه سوکت تازه ایجاد شده. توجه داشته باشید که شناسه‌های سوکت ایجاد شده از این API با شناسه‌های سوکت ایجاد شده از سایر APIها، مانند API منسوخ [ سوکت ](../socket/) سازگار نیستند.

DnsQueryType

Chrome 103+

تنظیمات برگزیده وضوح DNS پیش فرض any است و از پیکربندی فعلی سیستم عامل استفاده می کند که ممکن است IPv4 یا IPv6 را برگرداند. ipv4 IPv4 را مجبور می کند و ipv6 IPv6 را مجبور می کند.

Enum

"هر"

"ipv4"

"ipv6"

ReceiveErrorInfo

خواص

• نتیجه کد

  شماره

  کد نتیجه از تماس شبکه اصلی برگردانده شد.

• socketId

  شماره

  شناسه سوکت

ReceiveInfo

خواص

• داده ها

  ArrayBuffer

  داده های دریافتی، با حداکثر اندازه bufferSize .

• socketId

  شماره

  شناسه سوکت

SecureOptions

خواص

• نسخه tls

  TLSVersionConstraints اختیاری است

SendInfo

خواص

• bytesSent

  شماره اختیاری

  تعداد بایت های ارسال شده (اگر نتیجه == 0)

• نتیجه کد

  شماره

  کد نتیجه از تماس شبکه اصلی برگردانده شد. مقدار منفی نشان دهنده یک خطا است.

SocketInfo

خواص

• bufferSize

  شماره اختیاری

  اندازه بافر مورد استفاده برای دریافت داده ها. اگر اندازه بافر به طور صریح مشخص نشده باشد، مقدار ارائه نمی شود.

• متصل است

  بولی

  پرچمی که نشان می دهد سوکت به یک همتای راه دور متصل است یا خیر.

• آدرس محلی

  رشته اختیاری

  اگر سوکت زیرین متصل است، حاوی آدرس IPv4/6 محلی آن است.

• localPort

  شماره اختیاری

  اگر سوکت زیرین متصل باشد، حاوی پورت محلی آن است.

• نام

  رشته اختیاری

  رشته تعریف شده برنامه مرتبط با سوکت.

• مکث کرد

  بولی

  پرچم را نشان می دهد که آیا سوکت متصل مانع ارسال داده های بیشتر توسط همتای خود می شود (به setPaused مراجعه کنید).

• peerAddress

  رشته اختیاری

  اگر سوکت زیرین متصل است، حاوی آدرس همتا/ IPv4/6 است.

• peerPort

  شماره اختیاری

  اگر سوکت زیرین متصل است، حاوی پورت همتا است.

• مداوم

  بولی

  پرچم را نشان می دهد که آیا سوکت هنگام تعلیق برنامه باز می ماند یا خیر (به SocketProperties.persistent مراجعه کنید).

• socketId

  شماره

  شناسه سوکت

SocketProperties

خواص

• bufferSize

  شماره اختیاری

  اندازه بافر مورد استفاده برای دریافت داده ها. مقدار پیش فرض 4096 است.

• نام

  رشته اختیاری

  یک رشته تعریف شده توسط برنامه مرتبط با سوکت.

• مداوم

  بولی اختیاری

  پرچم را نشان می دهد که آیا هنگام بارگیری صفحه رویداد برنامه، سوکت باز مانده است (به مدیریت چرخه عمر برنامه مراجعه کنید). مقدار پیش فرض "نادرست" است. هنگامی که برنامه بارگیری می شود، هر سوکتی که قبلاً با 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

برمی گرداند

• قول<باطل>

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

connect()

chrome.sockets.tcp.connect(
  socketId: number,
  peerAddress: string,
  peerPort: number,
  dnsQueryType?: DnsQueryType,
  callback: function,
)

سوکت را به یک دستگاه از راه دور متصل می کند. هنگامی که عملیات connect با موفقیت کامل شد، رویدادهای onReceive هنگامی که داده‌ها از همتا دریافت می‌شود، افزایش می‌یابد. اگر در حین دریافت بسته‌ها، خطای شبکه رخ دهد، یک رویداد onReceiveError مطرح می‌شود، در این مرحله تا زمانی که متد resume فراخوانی نشود، دیگر رویداد onReceive برای این سوکت افزایش نخواهد یافت.

پارامترها

• socketId

  شماره

  شناسه سوکت

• peerAddress

  رشته

  آدرس دستگاه از راه دور. نام DNS، فرمت‌های IPv4 و IPv6 پشتیبانی می‌شوند.

• peerPort

  شماره

  پورت دستگاه از راه دور.

• dnsQueryType

  DnsQueryType اختیاری است

  Chrome 103+

  اولویت وضوح آدرس.

• پاسخ به تماس

  تابع

  پارامتر callback به نظر می رسد:

  (result: number) => void

  • نتیجه

    شماره

    کد نتیجه از تماس شبکه اصلی برگردانده شد. مقدار منفی نشان دهنده یک خطا است.

create()

قول بده

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

یک سوکت TCP ایجاد می کند.

پارامترها

• خواص

  SocketProperties اختیاری است

  ویژگی های سوکت (اختیاری).

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  (createInfo: CreateInfo) => void

  • createInfo

    CreateInfo

    نتیجه ایجاد سوکت.

برمی گرداند

• Promise< CreateInfo >

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

disconnect()

قول بده

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

سوکت را جدا می کند.

پارامترها

• socketId

  شماره

  شناسه سوکت

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  () => void

برمی گرداند

• قول<باطل>

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getInfo()

قول بده

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

وضعیت سوکت داده شده را بازیابی می کند.

پارامترها

• socketId

  شماره

  شناسه سوکت

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  (socketInfo: SocketInfo) => void

  • socketInfo

    SocketInfo

    شی حاوی اطلاعات سوکت.

برمی گرداند

• Promise< SocketInfo >

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getSockets()

قول بده

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

لیست سوکت های باز شده در حال حاضر متعلق به برنامه را بازیابی می کند.

پارامترها

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  (socketInfos: SocketInfo[]) => void

  • socketInfos

    SocketInfo []

    آرایه ای از شی حاوی اطلاعات سوکت.

برمی گرداند

• Promise< SocketInfo []>

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

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,
)

داده ها را روی سوکت TCP داده شده ارسال می کند.

پارامترها

• socketId

  شماره

  شناسه سوکت

• داده ها

  ArrayBuffer

  داده های ارسالی

• پاسخ به تماس

  تابع

  پارامتر callback به نظر می رسد:

  (sendInfo: SendInfo) => void

  • ارسال اطلاعات

    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 تنظیم یا پاک می کند. وقتی TCP_NODELAY تنظیم شود، الگوریتم Nagle غیرفعال خواهد شد.

پارامترها

• socketId

  شماره

  شناسه سوکت

• بدون تاخیر

  بولی

  اگر درست باشد، الگوریتم Nagle را غیرفعال می کند.

• پاسخ به تماس

  تابع

  پارامتر callback به نظر می رسد:

  (result: number) => void

  • نتیجه

    شماره

    کد نتیجه از تماس شبکه اصلی برگردانده شد. مقدار منفی نشان دهنده یک خطا است.

setPaused()

قول بده

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

برنامه را از دریافت پیام از طرف همتای خود فعال یا غیرفعال می کند. مقدار پیش فرض "نادرست" است. مکث یک سوکت معمولاً توسط یک برنامه کاربردی برای دریچه گاز ارسال شده توسط همتای خود استفاده می شود. هنگامی که یک سوکت متوقف می شود، هیچ رویداد onReceive افزایش نمی یابد. هنگامی که یک سوکت وصل می شود و متوقف نمی شود، رویدادهای onReceive با دریافت پیام ها دوباره مطرح می شوند.

پارامترها

• socketId

  شماره

• مکث کرد

  بولی

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  () => void

برمی گرداند

• قول<باطل>

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

update()

قول بده

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

ویژگی های سوکت را به روز می کند.

پارامترها

• socketId

  شماره

  شناسه سوکت

• خواص

  SocketProperties

  خواص برای به روز رسانی

• پاسخ به تماس

  عملکرد اختیاری

  پارامتر callback به نظر می رسد:

  () => void

برمی گرداند

• قول<باطل>

  Chrome 121+

  Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

رویدادها

onReceive

chrome.sockets.tcp.onReceive.addListener(
  callback: function,
)

زمانی که داده برای یک سوکت معین دریافت شده است، رویداد مطرح می شود.

پارامترها

• پاسخ به تماس

  تابع

  پارامتر callback به نظر می رسد:

  (info: ReceiveInfo) => void

  • اطلاعات

    ReceiveInfo

onReceiveError

chrome.sockets.tcp.onReceiveError.addListener(
  callback: function,
)

هنگامی که یک خطای شبکه در زمانی که زمان اجرا منتظر داده‌ها در آدرس سوکت و پورت بود، رخ داد، رویداد مطرح شد. پس از بالا آمدن این رویداد، سوکت به paused تنظیم می شود و دیگر رویدادهای onReceive برای این سوکت افزایش نمی یابد.

پارامترها

• پاسخ به تماس

  تابع

  پارامتر callback به نظر می رسد:

  (info: ReceiveErrorInfo) => void

  • اطلاعات

    ReceiveErrorInfo