Struct bluer::rfcomm::Socket

source · [−]

pub struct Socket { /* private fields */ }

This is supported on crate feature rfcomm only.

Expand description

An RFCOMM socket that has not yet been converted to a Listener or Stream.

The primary use of this is to configure the socket before connecting or listening.

Implementations

source

impl Socket

source

pub fn new() -> Result<Self>

Creates a new socket of stream type.

source

pub fn listen(self, backlog: u32) -> Result<Listener>

Convert the socket into a Listener.

backlog defines the maximum number of pending connections are queued by the operating system at any given time.

This will not register an SDP record for this channel. Register a Bluetooth RFCOMM profile instead, if you need a service record.

source

pub async fn connect(self, sa: SocketAddr) -> Result<Stream>

Establish a stream connection with a peer at the specified socket address.

This requires knowledge of the channel number. Register a Bluetooth RFCOMM profile, if you need to discover the channel number using a service record.

source

pub fn bind(&self, sa: SocketAddr) -> Result<()>

Bind the socket to the given address.

source

pub fn local_addr(&self) -> Result<SocketAddr>

Get the local address of this socket.

source

pub fn security(&self) -> Result<Security>

Get socket security.

This corresponds to the BT_SECURITY socket option.

source

pub fn set_security(&self, security: Security) -> Result<()>

Set socket security.

This corresponds to the BT_SECURITY socket option.

source

pub fn recv_buffer(&self) -> Result<i32>

Gets the maximum socket receive buffer in bytes.

This corresponds to the SO_RCVBUF socket option.

source

pub fn set_recv_buffer(&self, recv_buffer: i32) -> Result<()>

Sets the maximum socket receive buffer in bytes.

This corresponds to the SO_RCVBUF socket option.

source

pub fn conn_info(&self) -> Result<ConnInfo>

Gets the RFCOMM socket connection information.

This corresponds to the RFCOMM_CONNINFO socket option.

source

pub fn is_master(&self) -> Result<bool>

Gets whether the RFCOMM socket is the master.

This corresponds to the RFCOMM_LM socket option and option bit RFCOMM_LM_MASTER.

source

pub fn set_master(&self, master: bool) -> Result<()>

sets whether the RFCOMM socket is the master.

This corresponds to the RFCOMM_LM socket option and option bit RFCOMM_LM_MASTER.

source

pub fn input_buffer(&self) -> Result<u32>

Get the number of bytes in the input buffer.

This corresponds to the TIOCINQ IOCTL.

source

pub fn output_buffer(&self) -> Result<u32>

Get the number of bytes in the output buffer.

This corresponds to the TIOCOUTQ IOCTL.

source

pub fn create_tty(&self, dev_id: i16) -> Result<i16>

Creates a TTY (virtual serial port) for this RFCOMM connection.

Set dev_id to -1 to automatically allocate an id. Returns the allocated device id.

This corresponds to the RFCOMMCREATEDEV IOCTL.

source

pub fn release_tty(dev_id: i16) -> Result<()>

Releases a TTY (virtual serial port) for this RFCOMM connection.

This corresponds to the RFCOMMRELEASEDEV IOCTL.

source

pub unsafe fn from_raw_fd(fd: RawFd) -> Result<Self>

Constructs a new Socket from the given raw file descriptor.

The file descriptor must have been set to non-blocking mode.

This function consumes ownership of the specified file descriptor. The returned object will take responsibility for closing it when the object goes out of scope.