chrome.sockets.tcpServer

شرح

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

مانیفست

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

"sockets"

انواع

AcceptErrorInfo

مشخصات

• resultCode

  شماره

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

• socketId

  شماره

  شناسه سوکت سرور.

AcceptInfo

مشخصات

• clientSocketId

  شماره

  شناسه سوکت مشتری، یعنی شناسه سوکت اتصال جدیداً برقرارشده. این شناسه سوکت باید فقط با توابع جای‌نام chrome.sockets.tcp استفاده شود. توجه داشته باشید که نقطه پایانی مشتری در ابتدا موقتاً متوقف شده است و باید صریحاً توسط برنامه از حالت توقف موقت خارج شود تا دریافت داده‌ها آغاز شود.

• socketId

  شماره

  شناسه سوکت سرور.

CreateInfo

مشخصات

• socketId

  شماره

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

SocketInfo

مشخصات

• localAddress

  رشته اختیاری

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

• localPort

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

  اگر سوکت درحال گوش دادن باشد، درگاه محلی آن را دربرمی‌گیرد.

• نام

  رشته اختیاری

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

• موقتاً متوقف‌شده

  بولی

  پرچمی که نشان می‌دهد آیا درخواست‌های اتصال در سوکت شنونده ازطریق رویداد onAccept ارسال می‌شوند یا در صف انتظار شنونده قرار می‌گیرند. setPaused را ببینید. مقدار پیش‌فرض «false» است.

• دائمی

  بولی

  پرچمی که نشان می‌دهد آیا سوکت هنگام تخلیه صفحه رویداد برنامه باز می‌ماند یا نه (SocketProperties.persistent را ببینید). مقدار پیش‌فرض «نادرست» است.

• socketId

  شماره

  شناسه سوکت.

SocketProperties

مشخصات

• نام

  رشته اختیاری

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

• دائمی

  بولی اختیاری

  پرچمی که نشان می‌دهد آیا سوکت هنگام تخلیه صفحه رویداد برنامه باز می‌ماند یا نه (به مدیریت چرخه حیات برنامه مراجعه کنید). مقدار پیش‌فرض «false» است. وقتی برنامه بار می‌شود، هر سوکتی که قبلاً با persistent=true باز شده باشد می‌تواند با getSockets واکشی شود.

روش‌ها

close()

قول

chrome.sockets.tcpServer.close(
  socketId: number,
  callback?: function,
): Promise<void>

اتصال سوکت را قطع و آن را تخریب می‌کند. هر سوکت ایجادشده باید پس‌از استفاده بسته شود. شناسه سوکت به‌محض فراخوانی تابع دیگر معتبر نیست. بااین‌حال، تضمین می‌شود که سوکت فقط زمانی بسته شود که فراخوانی برگشتی فراخوانده شود.

پارامترها

• socketId

  شماره

  شناسه سوکت.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

create()

قول

chrome.sockets.tcpServer.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

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

پارامترها

• اقامتگاه‌ها

  SocketProperties اختیاری

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

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (createInfo: CreateInfo) => void

  • createInfo

    CreateInfo

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

بازگشتی‌ها

• Promise<CreateInfo>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

disconnect()

قول

chrome.sockets.tcpServer.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

سوکت شنونده را قطع می‌کند، یعنی پذیرش اتصالات جدید را متوقف می‌کند و نشانی/درگاهی را که سوکت به آن متصل است آزاد می‌کند. شناسه سوکت معتبر باقی می‌ماند، مثلاً می‌توان از آن با listen برای پذیرش اتصال‌ها در درگاه و نشانی جدید استفاده کرد.

پارامترها

• socketId

  شماره

  شناسه سوکت.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getInfo()

قول

chrome.sockets.tcpServer.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

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

پارامترها

• socketId

  شماره

  شناسه سوکت.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (socketInfo: SocketInfo) => void

  • socketInfo

    SocketInfo

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

بازگشتی‌ها

• Promise<SocketInfo>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getSockets()

قول

chrome.sockets.tcpServer.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

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

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (socketInfos: SocketInfo[]) => void

  • socketInfos

    SocketInfo[]

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

بازگشتی‌ها

• Promise<SocketInfo[]>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

listen()

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

به اتصالات در درگاه و نشانی مشخص‌شده گوش می‌دهد. اگر درگاه/نشانی درحال استفاده باشد، فراخوانی برگشتی نشان‌دهنده شکست است.

پارامترها

• socketId

  شماره

  شناسه سوکت.

• نشانی

  رشته

  نشانی ماشین محلی.

• درگاه

  شماره

  درگاه ماشین محلی. وقتی روی 0 تنظیم شود، درگاه آزاد به‌صورت پویا انتخاب می‌شود. درگاه تخصیص‌یافته پویا را می‌توانید با تماس با getInfo پیدا کنید.

• کارهای معوقه

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

  طول صف گوش دادن سوکت. مقدار پیش‌فرض به سیستم‌عامل (SOMAXCONN) بستگی دارد که طول صف معقولی را برای اکثر برنامه‌ها تضمین می‌کند.

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (result: number) => void

  • نتیجه

    شماره

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

setPaused()

قول

chrome.sockets.tcpServer.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

سوکت شنونده را برای پذیرش اتصالات جدید فعال یا غیرفعال می‌کند. وقتی موقتاً متوقف می‌شود، سوکت شنونده اتصالات جدید را می‌پذیرد تا زمانی که کارهای معوقه آن (تابع listen را ببینید) پر شود، سپس درخواست‌های اتصال اضافی را رد می‌کند. رویدادهای onAccept فقط زمانی مطرح می‌شوند که سوکت از حالت مکث خارج شده باشد.

پارامترها

• socketId

  شماره

• موقتاً متوقف‌شده

  بولی

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

update()

قول

chrome.sockets.tcpServer.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

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

پارامترها

• socketId

  شماره

  شناسه سوکت.

• اقامتگاه‌ها

  SocketProperties

  ویژگی‌هایی که باید به‌روز شود.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  () => void

بازگشتی‌ها

• Promise<void>

  Chrome نسخه ۱۲۱ و بالاتر

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onAccept

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (info: AcceptInfo) => void

  • اطلاعات

    AcceptInfo

onAcceptError

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

رویدادی که هنگام وقوع خطای شبکه درحالی‌که زمان اجرا منتظر اتصالات جدید در نشانی و درگاه سوکت بود، ایجاد شد. وقتی این رویداد مطرح می‌شود، سوکت روی paused تنظیم می‌شود و تا زمانی که سوکت ازسر گرفته نشود، رویدادهای onAccept بیشتری برای این سوکت مطرح نمی‌شود.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (info: AcceptErrorInfo) => void

  • اطلاعات

    AcceptErrorInfo