Struct Channel

pub struct Channel { /* private fields */ }

A data channel to a remote Peer. Channels are the primary data transfer mechanism for Bluetooth profiles and protocols. Channel currently implements Deref<Target = Socket> to easily access the underlying socket, and also implements AsyncWrite using a forwarding implementation.

Implementations

impl Channel

pub const DEFAULT_MAX_TX: usize = 672usize

The default max tx size is the default MTU size for L2CAP minus the channel header content. See the Bluetooth Core Specification, Vol 3, Part A, Sec 5.1

pub fn from_socket(socket: Socket, max_tx_size: usize) -> Result<Self, Status>

Attempt to make a Channel from a zircon socket and a Maximum TX size received out of band. Returns Err(status) if there is an error.

pub fn from_socket_infallible(socket: Socket, max_tx_size: usize) -> Self

Make a Channel from a zircon socket and a Maximum TX size received out of band.

pub fn create() -> (Self, Self)

Makes a pair of channels which are connected to each other, used commonly for testing. The max_tx_size is set to Channel::DEFAULT_MAX_TX.

pub fn create_with_max_tx(max_tx_size: usize) -> (Self, Self)

Make a pair of channels which are connected to each other, used commonly for testing. The maximum transmittable unit is taken from max_tx_size.

pub fn max_tx_size(&self) -> usize

The maximum transmittable size of a packet, in bytes. Trying to send packets larger than this may cause the channel to be closed.

pub fn channel_mode(&self) -> &ChannelMode

pub fn flush_timeout(&self) -> Option<MonotonicDuration>

pub fn set_audio_priority( &self, dir: A2dpDirection, ) -> impl Future<Output = Result<(), Error>>

Returns a future which will set the audio priority of the channel. The future will return Err if setting the priority is not supported.

pub fn set_flush_timeout( &self, duration: Option<MonotonicDuration>, ) -> impl Future<Output = Result<Option<MonotonicDuration>, Error>>

Attempt to set the flush timeout for this channel. If the timeout is not already set within 1ms of duration, we attempt to set it using the L2cap parameter extension. duration can be infinite to set packets flushable without a timeout. Returns a future that when polled will set the flush timeout and return the new timeout, or return an error setting the parameter is not supported.

pub fn closed<'a>(&'a self) -> impl Future<Output = Result<(), Status>> + 'a

pub fn is_closed<'a>(&'a self) -> bool

pub fn poll_datagram( &self, cx: &mut Context<'_>, out: &mut Vec<u8>, ) -> Poll<Result<usize, Status>>

pub fn read_packet(&self) -> Result<Vec<u8>, Status>

Read from the channel, allocating a Vec for the packet. This will return zx::Status::SHOULD_WAIT if there is no data waiting to read.

pub fn read(&self, buf: &mut [u8]) -> Result<usize, Status>

Read from the channel. This will return zx::Status::SHOULD_WAIT if there is no data available. If buf is not large enough, the rest of the packet will be thrown out.

pub fn write(&self, bytes: &[u8]) -> Result<usize, Status>

Write to the channel. This will return zx::Status::SHOULD_WAIT if the the channel is too full. Use the poll_write for asynchronous writing.

Trait Implementations

impl AsyncRead for Channel

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for Channel

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for Channel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FusedStream for Channel

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl Stream for Channel

type Item = Result<Vec<u8>, Status>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl TryFrom<Channel> for Channel

type Error = Status

The type returned in the event of a conversion error.

fn try_from(fidl: Channel) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Channel> for Channel

type Error = Error

The type returned in the event of a conversion error.

fn try_from(channel: Channel) -> Result<Self, Self::Error>

Performs the conversion.