Crate tokio_seqpacket 

Unix seqpacket sockets for tokio.

Seqpacket sockets combine a number of useful properties:

• They are connection oriented.
• They guarantee in-order message delivery.
• They provide datagrams with well-defined semantics for passing along file descriptors.

These properties make seqpacket sockets very well suited for local servers that need to pass file-descriptors around with their clients.

You can create a UnixSeqpacketListener to start accepting connections, or create a UnixSeqpacket to connect to a listening socket. You can also create a pair of connected sockets with UnixSeqpacket::pair().

Passing file descriptors and other ancillary data.

You can use send_vectored_with_ancillary and recv_vectored_with_ancillary to send and receive ancillary data. This can be used to pass file descriptors and unix credentials over sockets.

&self versus &mut self

Seqpacket sockets have well-defined semantics when sending or receiving on the same socket from different threads. Although the order is not guaranteed in that scenario, each datagram will be delivered intact. Since tokio 0.3, it is also possible for multiple tasks to await the same file descriptor. As such, all I/O functions now take &self instead of &mut self, and the split() API has been deprecated.

Example

use tokio_seqpacket::UnixSeqpacket;

let mut socket = UnixSeqpacket::connect("/run/foo.sock").await?;
socket.send(b"Hello!").await?;

let mut buffer = [0u8; 128];
let msg_info = socket.recv(&mut buffer).await?;
let len = msg_info.bytes_read();
println!("{}", String::from_utf8_lossy(&buffer[..len]));

Non-portable features

This crate mostly exposes APIs for portable POSIX functionality. However, it also supports some OS-specific features, such sending and receiving credentials as ancillary data, and peeking at the contents of ancillary data. To avoid accidentally writing non-portable code, these are gated behind the non-portable crate feature.

Modules

ancillary

Support for reading / writing ancillary data.

borrow_fd

Utility module for borrowing file descriptors with a specific lifetime.

Structs

MessageInfo

Information about a received seqpacket message.

UCred

Credentials of a process

UnixSeqpacket

Unix seqpacket socket.

UnixSeqpacketListener

Listener for Unix seqpacket sockets.