Struct Socket 

pub struct Socket {
    pub domain: SocketDomain,
    pub socket_type: SocketType,
    pub protocol: SocketProtocol,
    pub security: SocketState,
    /* private fields */
}

A Socket represents one endpoint of a bidirectional communication channel.

Fields

domain: SocketDomain

The domain of this socket.

socket_type: SocketType

The type of this socket.

protocol: SocketProtocol

The protocol of this socket.

security: SocketState

Security module state associated with this socket. Note that the socket’s security label is applied to the associated fs_node.

Implementations

impl Socket

pub fn new<L>( locked: &mut Locked<L>, current_task: &CurrentTask, domain: SocketDomain, socket_type: SocketType, protocol: SocketProtocol, kernel_private: bool, ) -> Result<SocketHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Creates a new unbound socket.

Parameters

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

pub fn new_with_ops(ops: Box<dyn SocketOps>) -> Result<SocketHandle, Errno>

pub fn new_with_ops_and_info( ops: Box<dyn SocketOps>, domain: SocketDomain, socket_type: SocketType, protocol: SocketProtocol, ) -> SocketHandle

pub fn get_from_file(file: &FileHandle) -> Result<&SocketHandle, Errno>

Returns the Socket that this FileHandle refers to. If this file is not a socket file, returns ENOTSOCK.

pub fn downcast_socket<T>(&self) -> Option<&T>

where T: 'static,

pub fn getsockname<L>( &self, locked: &mut Locked<L>, ) -> Result<SocketAddress, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn getpeername<L>( &self, locked: &mut Locked<L>, ) -> Result<SocketAddress, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn setsockopt<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, level: u32, optname: u32, optval: SockOptValue, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn getsockopt<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, level: u32, optname: u32, optlen: u32, ) -> Result<Vec<u8>, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn receive_timeout(&self) -> Option<MonotonicDuration>

pub fn send_timeout(&self) -> Option<MonotonicDuration>

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

pub fn bind<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, socket_address: SocketAddress, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn listen<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, backlog: i32, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn accept<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, ) -> Result<SocketHandle, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn read<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, data: &mut dyn OutputBuffer, flags: SocketMessageFlags, ) -> Result<MessageReadInfo, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

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

where L: LockEqualOrBefore<FileOpsCore>,

pub fn wait_async<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> WaitCanceler

where L: LockEqualOrBefore<FileOpsCore>,

pub fn query_events<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, ) -> Result<FdEvents, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn shutdown<L>( &self, locked: &mut Locked<L>, current_task: &CurrentTask, how: SocketShutdownFlags, ) -> Result<(), Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn close<L>(&self, locked: &mut Locked<L>, current_task: &CurrentTask)

where L: LockEqualOrBefore<FileOpsCore>,

pub fn to_handle( &self, _file: &FileObject, current_task: &CurrentTask, ) -> Result<Option<NullableHandle>, Errno>

pub fn fs_node(&self) -> Option<FsNodeHandle>

Returns the crate::vfs::FsNode unique to this Socket.