شرح
از chrome.sockets.tcpServer
API برای ایجاد برنامه های سرور با استفاده از اتصالات TCP استفاده کنید. این API جایگزین عملکرد TCP می شود که قبلاً در chrome.socket
API یافت شده بود.
آشکار
انواع
AcceptErrorInfo
خواص
- نتیجه کد
عدد
کد نتیجه از تماس شبکه اصلی برگردانده شد.
- socketId
عدد
شناسه سوکت سرور
AcceptInfo
خواص
- clientSocketId
عدد
شناسه سوکت مشتری، یعنی شناسه سوکت اتصال تازه ایجاد شده. این شناسه سوکت باید فقط با توابع از فضای نام
chrome.sockets.tcp
استفاده شود. توجه داشته باشید که سوکت کلاینت در ابتدا متوقف شده است و برای شروع دریافت داده ها باید به صراحت توسط برنامه لغو مکث شود. - socketId
عدد
شناسه سوکت سرور
CreateInfo
خواص
- socketId
عدد
شناسه سوکت سرور تازه ایجاد شده. توجه داشته باشید که شناسههای سوکت ایجاد شده از این API با شناسههای سوکت ایجاد شده از سایر APIها، مانند API منسوخ
[
سوکت](../socket/)
سازگار نیستند.
SocketInfo
خواص
- آدرس محلی
رشته اختیاری
اگر سوکت در حال گوش دادن است، حاوی آدرس IPv4/6 محلی آن است.
- localPort
شماره اختیاری
اگر سوکت در حال گوش دادن است، حاوی پورت محلی آن است.
- نام
رشته اختیاری
رشته تعریف شده برنامه مرتبط با سوکت.
- مکث کرد
بولی
پرچمی که نشان میدهد درخواستهای اتصال در سوکت گوش دادن از طریق رویداد
onAccept
ارسال میشوند یا در صف بک لاگ صف شنیدن قرار میگیرند.setPaused
ببینید. مقدار پیش فرض غلط است". - مداوم
بولی
پرچم را نشان می دهد که آیا سوکت هنگام بارگیری صفحه رویداد برنامه باز می ماند (به
SocketProperties.persistent
مراجعه کنید). مقدار پیش فرض غلط است". - socketId
عدد
شناسه سوکت
SocketProperties
خواص
- نام
رشته اختیاری
یک رشته تعریف شده توسط برنامه مرتبط با سوکت.
- مداوم
بولی اختیاری
پرچم را نشان می دهد که آیا سوکت هنگام بارگیری صفحه رویداد برنامه باز می ماند (به مدیریت چرخه عمر برنامه مراجعه کنید). مقدار پیش فرض غلط است." هنگامی که برنامه بارگیری می شود، هر سوکتی که قبلا با persistent=true باز شده است را می توان با
getSockets
واکشی کرد.
مواد و روش ها
close()
chrome.sockets.tcpServer.close(
socketId: number,
callback?: function,
)
سوکت را قطع و از بین می برد. هر سوکت ایجاد شده باید پس از استفاده بسته شود. به محض فراخوانی تابع، شناسه سوکت دیگر معتبر نیست. با این حال، سوکت تضمین شده است که فقط زمانی که تماس برگشتی فراخوانی شود بسته می شود.
مولفه های
- socketId
عدد
شناسه سوکت
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:() => void
برمی گرداند
قول<باطل>
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
create()
chrome.sockets.tcpServer.create(
properties?: SocketProperties,
callback?: function,
)
یک سوکت سرور TCP ایجاد می کند.
مولفه های
- خواص
SocketProperties اختیاری است
ویژگی های سوکت (اختیاری).
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:(createInfo: CreateInfo) => void
- createInfo
نتیجه ایجاد سوکت.
برمی گرداند
Promise< CreateInfo >
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
disconnect()
chrome.sockets.tcpServer.disconnect(
socketId: number,
callback?: function,
)
سوکت گوش دادن را قطع می کند، یعنی پذیرش اتصالات جدید را متوقف می کند و آدرس/پورتی را که سوکت به آن متصل است آزاد می کند. شناسه سوکت معتبر باقی می ماند، به عنوان مثال می توان از آن با اتصالات listen
دادن به پذیرش در یک پورت و آدرس جدید استفاده کرد.
مولفه های
- socketId
عدد
شناسه سوکت
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:() => void
برمی گرداند
قول<باطل>
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
getInfo()
chrome.sockets.tcpServer.getInfo(
socketId: number,
callback?: function,
)
وضعیت سوکت داده شده را بازیابی می کند.
مولفه های
- socketId
عدد
شناسه سوکت
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:(socketInfo: SocketInfo) => void
- socketInfo
شی حاوی اطلاعات سوکت.
برمی گرداند
Promise< SocketInfo >
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
getSockets()
chrome.sockets.tcpServer.getSockets(
callback?: function,
)
لیست سوکت های باز شده در حال حاضر متعلق به برنامه را بازیابی می کند.
مولفه های
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:(socketInfos: SocketInfo[]) => void
- socketInfos
SocketInfo []
آرایه ای از شی حاوی اطلاعات سوکت.
برمی گرداند
Promise< SocketInfo []>
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
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
عدد
- مکث کرد
بولی
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:() => void
برمی گرداند
قول<باطل>
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
update()
chrome.sockets.tcpServer.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
ویژگی های سوکت را به روز می کند.
مولفه های
- socketId
عدد
شناسه سوکت
- خواص
خواص برای به روز رسانی
- پاسخ به تماس
عملکرد اختیاری
پارامتر
callback
به نظر می رسد:() => void
برمی گرداند
قول<باطل>
Chrome 121+Promises فقط برای Manifest V3 و نسخههای جدیدتر پشتیبانی میشود، پلتفرمهای دیگر باید از callback استفاده کنند.
مناسبت ها
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
- اطلاعات