⚠️ VeridianOS Kernel Documentation - This is low-level kernel code. All functions are unsafe unless explicitly marked otherwise. no_std

Socket

Struct Socket 

Source
pub struct Socket {
    pub id: usize,
    pub domain: SocketDomain,
    pub socket_type: SocketType,
    pub protocol: SocketProtocol,
    pub state: SocketState,
    pub local_addr: Option<SocketAddr>,
    pub remote_addr: Option<SocketAddr>,
    pub options: SocketOptions,
    /* private fields */
}
Expand description

Generic socket handle

Fields§

§id: usize§domain: SocketDomain§socket_type: SocketType§protocol: SocketProtocol§state: SocketState§local_addr: Option<SocketAddr>§remote_addr: Option<SocketAddr>§options: SocketOptions

Implementations§

Source§

impl Socket

Source

pub fn new( domain: SocketDomain, socket_type: SocketType, protocol: SocketProtocol, ) -> Result<Self, KernelError>

Create a new socket

Source

pub fn bind(&mut self, addr: SocketAddr) -> Result<(), KernelError>

Bind socket to local address

Source

pub fn listen(&mut self, backlog: usize) -> Result<(), KernelError>

Listen for connections (TCP only)

Source

pub fn connect(&mut self, addr: SocketAddr) -> Result<(), KernelError>

Connect to remote address

Source

pub fn accept(&self) -> Result<(Socket, SocketAddr), KernelError>

Accept incoming connection (TCP only)

Source

pub fn send(&mut self, data: &[u8], _flags: u32) -> Result<usize, KernelError>

Send data

Source

pub fn send_to( &self, data: &[u8], dest: SocketAddr, _flags: u32, ) -> Result<usize, KernelError>

Send data to specific address (UDP)

Source

pub fn recv( &mut self, buffer: &mut [u8], _flags: u32, ) -> Result<usize, KernelError>

Receive data

Source

pub fn recv_from( &mut self, buffer: &mut [u8], _flags: u32, ) -> Result<(usize, SocketAddr), KernelError>

Receive data with source address

Source

pub fn close(&mut self) -> Result<(), KernelError>

Close socket

Source

pub fn set_option(&mut self, option: SocketOption) -> Result<(), KernelError>

Set socket option

Trait Implementations§

Source§

impl Clone for Socket

Source§

fn clone(&self) -> Socket

Returns a duplicate of the value. Read more
1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Socket

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Socket

§

impl RefUnwindSafe for Socket

§

impl Send for Socket

§

impl Sync for Socket

§

impl Unpin for Socket

§

impl UnwindSafe for Socket

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.