Class WebBluetoothTransport

Web Bluetooth transport.

Hierarchy (View Summary)

Transport
- WebBluetoothTransport

Index

Properties

Accessors

Methods

close reopen toString tx request

Properties

`Readonly`attributes

attributes: Transport.Attributes

Attributes of the transport.

`Readonly`rx

Iterable of incoming packets received through the transport.

Accessors

mtu

get mtu(): number
Return the transport MTU.

Returns number
Remarks
The transport should be able to send TLV structure of up to this size. If not overridden, return a conservative number.

Note that this does not restrict incoming packet size.
Inherited from Transport.mtu
- Defined in l3face/lib/transport.d.ts:24

Methods

close

close(): void
Returns void
- Defined in web-bluetooth-transport/src/web-bluetooth-transport.ts:77

reopen

reopen(): Promise<Transport>
Reopen the transport after it has failed.

Returns Promise<Transport>
The same transport or a new transport after it has been reconnected.

Throws
@ndn/l3face!Transport.ReopenNotSupportedError Thrown to indicate the transport does not support reopening.
Inherited from Transport.reopen
- Defined in l3face/lib/transport.d.ts:41

toString

toString(): string
Returns string
Inherited from Transport.toString
- Defined in l3face/lib/transport.d.ts:42

tx

tx(iterable: TxIterable): Promise<void>
Function to accept outgoing packet stream.
Parameters
- iterable: TxIterable
  Iterable of outgoing packets sent through the transport. Size of each packet cannot exceed .mtu.
Returns Promise<void>
Promise that resolves when iterable is exhausted or rejects upon error.
Overrides Transport.tx
- Defined in web-bluetooth-transport/src/web-bluetooth-transport.ts:67

`Static`request

request(): Promise<WebBluetoothTransport>
Request for a connection.

Returns Promise<WebBluetoothTransport>
See
WebBluetoothTransport.createFace
- Defined in web-bluetooth-transport/src/web-bluetooth-transport.ts:18