Struct UnixSocket 

pub struct UnixSocket { /* private fields */ }

The data of a socket is stored in the “Inner” struct. Because both ends have separate locks, care must be taken to avoid taking both locks since there is no way to tell what order to take them in.

When writing, data is buffered in the “other” end of the socket’s Inner.MessageQueue:

       UnixSocket end #1          UnixSocket end #2
       +---------------+          +---------------+
       |               |          |   +-------+   |

Writes ––––––––––––––––>| Inner |——> Reads | | | +—––+ | | +—––+ | | | Reads <——| Inner |<–––––––––––––––– Writes | +—––+ | | | +—————+ +—————+

Implementations

impl UnixSocket

pub fn new(_socket_type: SocketType) -> UnixSocket

pub fn new_pair<L>( locked: &mut Locked<L>, current_task: &CurrentTask, domain: SocketDomain, socket_type: SocketType, open_flags: OpenFlags, ) -> Result<(FileHandle, FileHandle), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Creates a pair of connected sockets.

Parameters

• domain: The domain of the socket (e.g., AF_UNIX).
• socket_type: The type of the socket (e.g., SOCK_STREAM).

pub fn check_type_for_connect( &self, socket: &Socket, peer: &Socket, peer_address: &Option<SocketAddress>, ) -> Result<(), Errno>

pub fn bind_socket_to_node( &self, socket: &SocketHandle, address: SocketAddress, node: &FsNodeHandle, ) -> Result<(), Errno>

Trait Implementations

impl SocketOps for UnixSocket

fn shutdown( &self, _locked: &mut Locked<FileOpsCore>, _socket: &Socket, how: SocketShutdownFlags, ) -> Result<(), Errno>

Shuts down this socket according to how, preventing any future reads and/or writes.

Used by the shutdown syscalls.

fn close( &self, _locked: &mut Locked<FileOpsCore>, _current_task: &CurrentTask, socket: &Socket, )

Close this socket.

Called by SocketFile when the file descriptor that is holding this socket is closed.

Close differs from shutdown in two ways. First, close will call mark_peer_closed_with_unread_data if this socket has unread data, which changes how read() behaves on that socket. Second, close transitions the internal state of this socket to Closed, which breaks the reference cycle that exists in the connected state.

fn getsockname( &self, _locked: &mut Locked<FileOpsCore>, socket: &Socket, ) -> Result<SocketAddress, Errno>

Returns the name of this socket.

The name is derived from the address and domain. A socket will always have a name, even if it is not bound to an address.

fn getpeername( &self, locked: &mut Locked<FileOpsCore>, _socket: &Socket, ) -> Result<SocketAddress, Errno>

Returns the name of the peer of this socket, if such a peer exists.

Returns an error if the socket is not connected.

fn connect( &self, locked: &mut Locked<FileOpsCore>, socket: &SocketHandle, current_task: &CurrentTask, peer: SocketPeer, ) -> Result<(), Errno>

Connect the socket to the listening peer. On success a new socket is created and added to the accept queue.

fn listen( &self, _locked: &mut Locked<FileOpsCore>, socket: &Socket, backlog: i32, credentials: ucred, ) -> Result<(), Errno>

Start listening at the bound address for connect calls.

fn accept( &self, _locked: &mut Locked<FileOpsCore>, socket: &Socket, _current_task: &CurrentTask, ) -> Result<SocketHandle, Errno>

Returns the eariest socket on the accept queue of this listening socket. Returns EAGAIN if the queue is empty.

fn bind( &self, _locked: &mut Locked<FileOpsCore>, _socket: &Socket, _current_task: &CurrentTask, socket_address: SocketAddress, ) -> Result<(), Errno>

Binds this socket to a socket_address.

fn read( &self, _locked: &mut Locked<FileOpsCore>, socket: &Socket, _current_task: &CurrentTask, data: &mut dyn OutputBuffer, flags: SocketMessageFlags, ) -> Result<MessageReadInfo, Errno>

Reads the specified number of bytes from the socket, if possible.

fn write( &self, locked: &mut Locked<FileOpsCore>, socket: &Socket, current_task: &CurrentTask, data: &mut dyn InputBuffer, dest_address: &mut Option<SocketAddress>, ancillary_data: &mut Vec<AncillaryData>, ) -> Result<usize, Errno>

Writes the data in the provided user buffers to this socket.

fn wait_async( &self, _locked: &mut Locked<FileOpsCore>, _socket: &Socket, _current_task: &CurrentTask, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> WaitCanceler

Queues an asynchronous wait for the specified events on the waiter. Note that no wait occurs until a wait functions is called on the waiter.

fn query_events( &self, _locked: &mut Locked<FileOpsCore>, _socket: &Socket, _current_task: &CurrentTask, ) -> Result<FdEvents, Errno>

Return the events that are currently active on the socket.

fn setsockopt( &self, _locked: &mut Locked<FileOpsCore>, _socket: &Socket, current_task: &CurrentTask, level: u32, optname: u32, optval: SockOptValue, ) -> Result<(), Errno>

Sets socket-specific options.

fn getsockopt( &self, _locked: &mut Locked<FileOpsCore>, socket: &Socket, current_task: &CurrentTask, level: u32, optname: u32, _optlen: u32, ) -> Result<Vec<u8>, Errno>

Retrieves socket-specific options.

fn ioctl( &self, locked: &mut Locked<Unlocked>, socket: &Socket, file: &FileObject, current_task: &CurrentTask, request: u32, arg: SyscallArg, ) -> Result<SyscallResult, Errno>

Implements ioctl.

fn get_socket_info( &self, ) -> Result<(SocketDomain, SocketType, SocketProtocol), Errno>

Returns the domain, type and protocol of the socket. This is only used for socket that are build without previous knowledge of this information, and can be ignored if all sockets are build with it.

fn to_handle( &self, _socket: &Socket, _current_task: &CurrentTask, ) -> Result<Option<NullableHandle>, Errno>

Return a handle that allows access to this file descritor through the zxio protocols.