Struct SessionClientResponse 

pub(crate) struct SessionClientResponse {

    pub target: String,
    pub destination: Address,
    pub forward_path: RoutingOptions,
    pub return_path: RoutingOptions,
    pub protocol: IpProtocol,
    pub ip: String,
    pub port: u16,
    pub hopr_mtu: usize,
    pub surb_len: usize,
    pub active_clients: Vec<String>,
    pub max_client_sessions: usize,
    pub max_surb_upstream: Option<Bandwidth>,
    pub response_buffer: Option<ByteSize>,
    pub session_pool: Option<usize>,
}

Response body for creating a new client session.

Fields

target: String

Target of the Session.

destination: Address

Destination node (exit node) of the Session.

forward_path: RoutingOptions

Forward routing path.

return_path: RoutingOptions

Return routing path.

protocol: IpProtocol

IP protocol used by Session’s listening socket.

ip: String

Listening IP address of the Session’s socket.

port: u16

Listening port of the Session’s socket.

hopr_mtu: usize

MTU used by the underlying HOPR transport.

surb_len: usize

Size of a Single Use Reply Block used by the protocol.

This is useful for SURB balancing calculations.

active_clients: Vec<String>

Lists Session IDs of all active clients.

Can contain multiple entries on TCP sessions, but currently always only a single entry on UDP sessions.

max_client_sessions: usize

The maximum number of client sessions that the listener can spawn.

This currently applies only to the TCP sessions, as UDP sessions cannot have multiple clients (defaults to 1 for UDP).

max_surb_upstream: Option<Bandwidth>

The maximum throughput at which artificial SURBs might be generated and sent to the recipient of the Session.

response_buffer: Option<ByteSize>

The amount of response data the Session counterparty can deliver back to us, without us sending any SURBs to them.

session_pool: Option<usize>

How many Sessions to pool for clients.

Trait Implementations

impl Clone for SessionClientResponse

fn clone(&self) -> SessionClientResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for SessionClientResponse

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for SessionClientResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionClientResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionClientResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for SessionClientResponse

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.