Struct rubble::l2cap::ChannelData

pub struct ChannelData<'a, P: ?Sized> {
    response_channel: Channel,
    protocol: &'a mut P,
    pdu: u8,
}

Data associated with a connected L2CAP channel.

Fields

response_channel: Channel

Channel to which responses should be addressed.

For fixed, predefined channels, this is always the same value for both devices, but dynamically allocated channels can have different CIDs on both devices.

protocol: &'a mut P

The protocol listening on this channel.

pdu: u8

Outgoing PDU size of the protocol.

This is the number of bytes that must be available to the protocol in the TX buffer to guarantee that all of the protocol’s PDUs will fit.

Implementations

impl<'a> ChannelData<'a, dyn ProtocolObj + 'a>

fn new_dyn<T: Protocol + 'a>(
    response_channel: Channel,
    protocol: &'a mut T
) -> Self

Creates a ChannelData carrying a dynamically-dispatched dyn ProtocolObj from a concrete Protocol implementor T.

impl<'a, P: Protocol> ChannelData<'a, P>

fn new(response_channel: Channel, protocol: &'a mut P) -> Self

impl<'a, P: ?Sized> ChannelData<'a, P>

pub fn response_channel(&self) -> Channel

Returns the Channel to which the response should be sent.

pub fn pdu_size(&self) -> u8

Returns the PDU size required by the protocol.

This is the minimum size in Bytes the protocol needs to have provided for any of its outgoing PDUs. Protocol implementations may make use of additional space as well, but this is the very minimum.

The L2CAP implementation will not forward incoming PDUs to the protocol unless this amount of space is available in the TX buffer. This guarantees that the response will always fit.

pub fn protocol(&mut self) -> &mut P

Returns the protocol connected to the channel.

pub fn into_protocol(self) -> &'a mut P

Consumes self and returns the protocol connected to the channel, with lifetime 'a.

This can be useful when the lifetime of the reference must not be tied to self, as would be the case with protocol().