chrome.bluetoothSocket

توضیحات

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

آشکار

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

"bluetooth"

انواع

AcceptError

Enum

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

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

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

Enum

"قطع"
اتصال قطع شد.

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

"not_connected"
سوکت وصل نشده است.

ReceiveErrorInfo

خواص

  • خطا

    ReceiveError

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

  • errorMessage

    رشته

    پیام خطا.

  • socketId

    شماره

    شناسه سوکت

ReceiveInfo

خواص

  • داده ها

    ArrayBuffer

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

  • socketId

    شماره

    شناسه سوکت

SocketInfo

خواص

  • آدرس

    رشته اختیاری

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

  • bufferSize

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

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

  • متصل است

    بولی

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

  • نام

    رشته اختیاری

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

  • مکث کرد

    بولی

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

  • مداوم

    بولی

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

  • socketId

    شماره

    شناسه سوکت

  • uuid

    رشته اختیاری

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

SocketProperties

خواص

  • bufferSize

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

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

  • نام

    رشته اختیاری

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

  • مداوم

    بولی اختیاری

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

روش ها

close()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

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

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

create()

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

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

پارامترها

  • خواص

    SocketProperties اختیاری است

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

  • پاسخ به تماس

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

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

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

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

برمی گرداند

  • Promise< CreateInfo >

    Chrome 91+

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

disconnect()

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

سوکت را جدا می کند. شناسه سوکت همچنان معتبر است.

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

getInfo()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • پاسخ به تماس

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

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

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

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

برمی گرداند

  • Promise< SocketInfo >

    Chrome 91+

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

getSockets()

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

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

پارامترها

  • پاسخ به تماس

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

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

    (sockets: SocketInfo[]) => void

برمی گرداند

  • Promise< SocketInfo []>

    Chrome 91+

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

listenUsingL2cap()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • uuid

    رشته

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

  • گزینه ها

    ListenOptions اختیاری است

    گزینه های اضافی اختیاری برای خدمات.

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

listenUsingRfcomm()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • uuid

    رشته

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

  • گزینه ها

    ListenOptions اختیاری است

    گزینه های اضافی اختیاری برای خدمات.

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

send()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

  • داده ها

    ArrayBuffer

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

  • پاسخ به تماس

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

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

    (bytesSent: number) => void

    • bytesSent

      شماره

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

برمی گرداند

  • قول <تعداد>

    Chrome 91+

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

setPaused()

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

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

پارامترها

  • socketId

    شماره

  • مکث کرد

    بولی

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

update()

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

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

پارامترها

  • socketId

    شماره

    شناسه سوکت

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

  • پاسخ به تماس

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

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

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 91+

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

رویدادها

onAccept

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

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

پارامترها

  • پاسخ به تماس

    تابع

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

    (info: AcceptInfo) => void

onAcceptError

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

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

پارامترها

onReceive

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

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

پارامترها

  • پاسخ به تماس

    تابع

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

    (info: ReceiveInfo) => void

onReceiveError

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

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

پارامترها