Struct ScionStack 

pub struct ScionStack { /* private fields */ }

The SCION stack can be used to create path-aware SCION sockets or even Quic over SCION connections.

The SCION stack abstracts over the underlay stack that is used for the underlying transport.

Implementations

impl ScionStack

pub async fn bind( &self, bind_addr: Option<SocketAddr>, ) -> Result<UdpScionSocket, ScionSocketBindError>

Create a path-aware SCION socket with automatic path management.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.

Returns

A path-aware SCION socket.

pub async fn bind_with_config( &self, bind_addr: Option<SocketAddr>, socket_config: SocketConfig, ) -> Result<UdpScionSocket, ScionSocketBindError>

Create a path-aware SCION socket with custom configuration.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.
• socket_config - Configuration for the socket.

Returns

A path-aware SCION socket.

pub async fn connect( &self, remote_addr: SocketAddr, bind_addr: Option<SocketAddr>, ) -> Result<UdpScionSocket, ScionSocketBindError>

Create a connected path-aware SCION socket with automatic path management.

Arguments

• remote_addr - The remote address to connect to.
• bind_addr - The address to bind the socket to. If None, an available address will be used.

Returns

A connected path-aware SCION socket.

pub async fn connect_with_config( &self, remote_addr: SocketAddr, bind_addr: Option<SocketAddr>, socket_config: SocketConfig, ) -> Result<UdpScionSocket, ScionSocketBindError>

Create a connected path-aware SCION socket with custom configuration.

Arguments

• remote_addr - The remote address to connect to.
• bind_addr - The address to bind the socket to. If None, an available address will be used.
• socket_config - Configuration for the socket

Returns

A connected path-aware SCION socket.

pub async fn bind_with_time( &self, bind_addr: Option<SocketAddr>, now: Instant, ) -> Result<UdpScionSocket, ScionSocketBindError>

Bind a socket with controlled time for port allocation.

This allows tests to control port reservation timing without sleeping.

pub async fn bind_scmp( &self, bind_addr: Option<SocketAddr>, ) -> Result<ScmpScionSocket, ScionSocketBindError>

Create a socket that can send and receive SCMP messages.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.

Returns

A SCMP socket.

pub async fn bind_raw( &self, bind_addr: Option<SocketAddr>, ) -> Result<RawScionSocket, ScionSocketBindError>

Create a raw SCION socket. A raw SCION socket can be used to send and receive raw SCION packets. It is still bound to a specific UDP port because this is needed for packets to be routed in a dispatcherless autonomous system. See https://docs.scion.org/en/latest/dev/design/router-port-dispatch.html for a more detailed explanation.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.

Returns

A raw SCION socket.

pub async fn bind_path_unaware( &self, bind_addr: Option<SocketAddr>, ) -> Result<PathUnawareUdpScionSocket, ScionSocketBindError>

Create a path-unaware SCION socket for advanced use cases.

This socket can send and receive datagrams, but requires explicit paths for sending. Use this when you need full control over path selection.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.

Returns

A path-unaware SCION socket.

pub async fn quic_endpoint( &self, bind_addr: Option<SocketAddr>, config: EndpointConfig, server_config: Option<ServerConfig>, runtime: Option<Arc<dyn Runtime>>, ) -> Result<Endpoint>

Create a QUIC over SCION endpoint.

This is a convenience method that creates a QUIC (quinn) endpoint over a SCION socket.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.
• config - The quinn endpoint configuration.
• server_config - The quinn server configuration.
• runtime - The runtime to spawn tasks on.

Returns

A QUIC endpoint that can be used to accept or create QUIC connections.

pub async fn quic_endpoint_with_config( &self, bind_addr: Option<SocketAddr>, config: EndpointConfig, server_config: Option<ServerConfig>, runtime: Option<Arc<dyn Runtime>>, socket_config: SocketConfig, ) -> Result<Endpoint>

Create a QUIC over SCION endpoint using custom socket configuration.

This is a convenience method that creates a QUIC (quinn) endpoint over a SCION socket.

Arguments

• bind_addr - The address to bind the socket to. If None, an available address will be used.
• config - The quinn endpoint configuration.
• server_config - The quinn server configuration.
• runtime - The runtime to spawn tasks on.
• socket_config - Scion Socket configuration

Returns

A QUIC endpoint that can be used to accept or create QUIC connections.

pub fn local_addresses(&self) -> Vec<EndhostAddr>

Get the list of local addresses assigned to the endhost.

Returns

A list of local addresses assigned to the endhost.

pub fn create_path_manager(&self) -> Arc<CachingPathManager>

Creates a path manager with default configuration.

Trait Implementations

impl Debug for ScionStack

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

Formats the value using the given formatter.