8 releases (4 breaking)

0.5.2 Jun 12, 2021
0.5.0 Jan 27, 2021
0.4.2 Dec 26, 2020
0.3.0 Nov 6, 2020

#34 in Unix APIs

Download history 1259/week @ 2021-02-25 1028/week @ 2021-03-04 1120/week @ 2021-03-11 936/week @ 2021-03-18 1737/week @ 2021-03-25 1055/week @ 2021-04-01 1160/week @ 2021-04-08 1067/week @ 2021-04-15 848/week @ 2021-04-22 1575/week @ 2021-04-29 1283/week @ 2021-05-06 1401/week @ 2021-05-13 964/week @ 2021-05-20 1326/week @ 2021-05-27 1731/week @ 2021-06-03 1468/week @ 2021-06-10

5,437 downloads per month
Used in fizyr-rpc

BSD-2-Clause

47KB
910 lines

Docs.rs Tests

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 len = socket.recv(&mut buffer).await?;
println!("{}", String::from_utf8_lossy(&buffer[..len]));

Dependencies

~2.5MB
~38K SLoC