chrome.bluetoothSocket

شرح

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

دردسترس بودن

فقط ChromeOS

مانیفست

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

"bluetooth"

انواع

AcceptError

شمارشی

«system_error»
خطای سیستم رخ داد و ممکن است اتصال قابل‌بازیابی نباشد.

"not_listening"
سوکت درحال گوش دادن نیست.

AcceptErrorInfo

مشخصات

  • خطا

    AcceptError

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

  • errorMessage

    رشته

    پیام خطا.

  • socketId

    شماره

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

AcceptInfo

مشخصات

  • clientSocketId

    شماره

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

  • socketId

    شماره

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

CreateInfo

مشخصات

  • socketId

    شماره

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

ListenOptions

مشخصات

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

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

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

  • کانال

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

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

  • psm

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

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

ReceiveError

شمارشی

«قطع شد»
اتصال قطع شد.

«system_error»
خطای سیستم رخ داد و ممکن است اتصال قابل‌بازیابی نباشد.

«not_connected»
سوکت متصل نشده است.

ReceiveErrorInfo

مشخصات

  • خطا

    ReceiveError

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

  • errorMessage

    رشته

    پیام خطا.

  • socketId

    شماره

    شناسه سوکت.

ReceiveInfo

مشخصات

  • داده

    ArrayBuffer

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

  • socketId

    شماره

    شناسه سوکت.

SocketInfo

مشخصات

  • نشانی

    رشته اختیاری

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

  • bufferSize

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

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

  • اتصال برقرار شد

    بولی

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

  • نام

    رشته اختیاری

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

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

    بولی

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

  • دائمی

    بولی

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

  • socketId

    شماره

    شناسه سوکت.

  • uuid

    رشته اختیاری

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

SocketProperties

مشخصات

  • bufferSize

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

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

  • نام

    رشته اختیاری

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

  • دائمی

    بولی اختیاری

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

روش‌ها

close()

قول 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

connect()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • نشانی

    رشته

    نشانی دستگاه بلوتوث.

  • uuid

    رشته

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

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

create()

قول 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

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

پارامترها

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

    SocketProperties اختیاری

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

  • تماس برگشتی

    تابع اختیاری

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

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

بازگشتی‌ها

  • Promise<CreateInfo>

    Chrome نسخه ۹۱ به بالا

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

disconnect()

قول 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

getInfo()

قول 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • تماس برگشتی

    تابع اختیاری

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

بازگشتی‌ها

  • Promise<SocketInfo>

    Chrome نسخه ۹۱ به بالا

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

getSockets()

قول 
chrome.bluetoothSocket.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

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

پارامترها

  • تماس برگشتی

    تابع اختیاری

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

    (sockets: SocketInfo[]) => void

    • پریزها

      SocketInfo[]

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

بازگشتی‌ها

  • Promise<SocketInfo[]>

    Chrome نسخه ۹۱ به بالا

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

listenUsingL2cap()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • uuid

    رشته

    شناسه منحصربه‌فرد جهانی (UUID) سرویس برای گوش دادن.

  • گزینه‌ها

    ListenOptions اختیاری

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

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

listenUsingRfcomm()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • uuid

    رشته

    شناسه منحصربه‌فرد جهانی (UUID) سرویس برای گوش دادن.

  • گزینه‌ها

    ListenOptions اختیاری

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

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

send()

قول 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<number>

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

  • داده

    ArrayBuffer

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

  • تماس برگشتی

    تابع اختیاری

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

    (bytesSent: number) => void

    • bytesSent

      شماره

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

بازگشتی‌ها

  • Promise<number>

    Chrome نسخه ۹۱ به بالا

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

setPaused()

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

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

پارامترها

  • socketId

    شماره

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

    بولی

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

update()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت.

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

    SocketProperties

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

  • تماس برگشتی

    تابع اختیاری

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

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۹۱ به بالا

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

رویدادها

onAccept

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

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (info: AcceptInfo) => void

onAcceptError

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

Event raised when a network error occurred while the runtime was waiting for new connections on the given socket. وقتی این رویداد مطرح می‌شود، سوکت روی paused تنظیم می‌شود و دیگر هیچ رویداد onAccept برای این سوکت مطرح نمی‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (info: AcceptErrorInfo) => void

onReceive

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

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (info: ReceiveInfo) => void

onReceiveError

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

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

پارامترها