chrome.bluetoothSocket

توضیحات

از API مربوط chrome.bluetoothSocket برای ارسال و دریافت داده به دستگاه‌های بلوتوث با استفاده از اتصالات RFCOMM و L2CAP استفاده کنید.

مانیفست

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

"bluetooth"

انواع

AcceptError

شمارشی

"خطای سیستم"
خطایی در سیستم رخ داده و اتصال ممکن است غیرقابل بازیابی باشد.

"گوش_ندادن"
سوکت گوش نمی‌دهد.

AcceptErrorInfo

خواص

  • کد خطایی که نشان می‌دهد چه مشکلی پیش آمده است.

  • پیام خطا

    رشته

    پیام خطا.

  • شناسه سوکت

    شماره

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

AcceptInfo

خواص

  • شناسه سوکت کلاینت

    شماره

    شناسه سوکت کلاینت، یعنی شناسه سوکت اتصال تازه برقرار شده. این شناسه سوکت فقط باید با توابعی از فضای نام chrome.bluetoothSocket استفاده شود. توجه داشته باشید که سوکت کلاینت در ابتدا متوقف شده است و باید به صراحت توسط برنامه از حالت مکث خارج شود تا شروع به دریافت داده کند.

  • شناسه سوکت

    شماره

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

CreateInfo

خواص

  • شناسه سوکت

    شماره

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

ListenOptions

خواص

  • کارهای عقب افتاده

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

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

  • کانال

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

    کانال RFCOMM که توسط listenUsingRfcomm استفاده می‌شود. در صورت مشخص شدن، این کانال نباید قبلاً مورد استفاده قرار گرفته باشد، در غیر این صورت فراخوانی متد با شکست مواجه می‌شود. در صورت مشخص نشدن، یک کانال استفاده نشده به طور خودکار اختصاص داده می‌شود.

  • پی اس ام

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

    PSM مربوط به L2CAP که توسط listenUsingL2cap استفاده می‌شود. در صورت مشخص شدن، این PSM نباید قبلاً در حال استفاده باشد یا فراخوانی متد با شکست مواجه شود. در صورت مشخص نشدن، یک PSM استفاده نشده به طور خودکار اختصاص داده می‌شود.

ReceiveError

شمارشی

"قطع ارتباط"
ارتباط قطع شد.

"خطای سیستم"
خطایی در سیستم رخ داده و اتصال ممکن است غیرقابل بازیابی باشد.

"متصل_نیست"
سوکت وصل نشده است.

ReceiveErrorInfo

خواص

  • کد خطایی که نشان می‌دهد چه مشکلی پیش آمده است.

  • پیام خطا

    رشته

    پیام خطا.

  • شناسه سوکت

    شماره

    شناسه سوکت.

ReceiveInfo

خواص

  • داده‌ها

    آرایه بافر

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

  • شناسه سوکت

    شماره

    شناسه سوکت.

SocketInfo

خواص

  • آدرس

    رشته اختیاری

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

  • اندازه بافر

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

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

  • متصل

    بولی

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

  • نام

    رشته اختیاری

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

  • مکث کرد

    بولی

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

  • مداوم

    بولی

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

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • یویید

    رشته اختیاری

    اگر سوکت زیرین متصل باشد، حاوی اطلاعاتی در مورد UUID سرویسی است که به آن متصل است، در غیر این صورت اگر سوکت زیرین در حال گوش دادن باشد، حاوی اطلاعاتی در مورد UUID سرویسی است که به آن گوش می‌دهد.

SocketProperties

خواص

  • اندازه بافر

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

    اندازه بافر مورد استفاده برای دریافت داده‌ها. مقدار پیش‌فرض ۴۰۹۶ است.

  • نام

    رشته اختیاری

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

  • مداوم

    بولی اختیاری

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

روش‌ها

close()

وعده
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

connect()

وعده
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
): Promise<void>

سوکت را به یک دستگاه بلوتوث از راه دور متصل می‌کند. هنگامی که عملیات connect با موفقیت انجام شود، رویدادهای onReceive هنگام دریافت داده‌ها از طرف دیگر اجرا می‌شوند. اگر در حین دریافت بسته‌ها در زمان اجرا، خطای شبکه رخ دهد، یک رویداد onReceiveError اجرا می‌شود که در آن نقطه، تا زمانی که متد setPaused(false) فراخوانی نشود، رویداد onReceive دیگری برای این سوکت اجرا نخواهد شد.

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • آدرس

    رشته

    آدرس دستگاه بلوتوث.

  • یویید

    رشته

    UUID سرویسی که قرار است به آن متصل شوید.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

create()

وعده
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

یک سوکت بلوتوث ایجاد می‌کند.

پارامترها

  • خواص

    SocketProperties اختیاری است

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (createInfo: CreateInfo) => void

بازگشت‌ها

  • کروم ۹۱+

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

disconnect()

وعده
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

getInfo()

وعده
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

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

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (socketInfo: SocketInfo) => void

بازگشت‌ها

  • قول< SocketInfo >

    کروم ۹۱+

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

getSockets()

وعده
chrome.bluetoothSocket.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

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

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (sockets: SocketInfo[]) => void

    • سوکت‌ها

      اطلاعات سوکت []

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

بازگشت‌ها

  • قول< SocketInfo []>

    کروم ۹۱+

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

listenUsingL2cap()

وعده
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

با استفاده از پروتکل L2CAP به اتصالات گوش دهید.

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • یویید

    رشته

    UUID سرویس برای گوش دادن.

  • گزینه‌ها

    گزینه‌های گوش دادن اختیاری

    گزینه‌های اضافی اختیاری برای سرویس.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

listenUsingRfcomm()

وعده
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

با استفاده از پروتکل RFCOMM به دنبال اتصالات باشید.

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • یویید

    رشته

    UUID سرویس برای گوش دادن.

  • گزینه‌ها

    گزینه‌های گوش دادن اختیاری

    گزینه‌های اضافی اختیاری برای سرویس.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

send()

وعده
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<number>

داده‌ها را روی سوکت بلوتوث داده شده ارسال می‌کند.

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

  • داده‌ها

    آرایه بافر

    داده‌ای که باید ارسال شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (bytesSent: number) => void

    • بایت‌های ارسالی

      شماره

      تعداد بایت‌های ارسالی.

بازگشت‌ها

  • قول<number>

    کروم ۹۱+

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

setPaused()

وعده
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

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

پارامترها

  • شناسه سوکت

    شماره

  • مکث کرد

    بولی

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

update()

وعده
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

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

پارامترها

  • شناسه سوکت

    شماره

    شناسه سوکت.

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۹۱+

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

رویدادها

onAccept

chrome.bluetoothSocket.onAccept.addListener(
  callback: function,
)

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

پارامترها

onAcceptError

chrome.bluetoothSocket.onAcceptError.addListener(
  callback: function,
)

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

پارامترها

onReceive

chrome.bluetoothSocket.onReceive.addListener(
  callback: function,
)

این رویداد زمانی رخ می‌دهد که داده‌ها برای یک سوکت مشخص دریافت شده باشند.

پارامترها

onReceiveError

chrome.bluetoothSocket.onReceiveError.addListener(
  callback: function,
)

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

پارامترها