Struct SessionClientResponse 

pub struct SessionClientResponse {

    pub active_clients: Vec<String>,
    pub destination: String,
    pub forward_path: RoutingOptions,
    pub hopr_mtu: u64,
    pub ip: String,
    pub max_client_sessions: u64,
    pub max_surb_upstream: Option<String>,
    pub port: i32,
    pub protocol: IpProtocol,
    pub response_buffer: Option<String>,
    pub return_path: RoutingOptions,
    pub session_pool: Option<u64>,
    pub surb_len: u64,
    pub target: String,
}

Response body for creating a new client session.

JSON schema

{
 "description": "Response body for creating a new client session.",
 "examples": [
   {
     "activeClients": [],
     "destination": "0x5112D584a1C72Fc250176B57aEba5fFbbB287D8F",
     "forwardPath": {
       "Hops": 1
     },
     "hoprMtu": 1002,
     "ip": "127.0.0.1",
     "maxClientSessions": 2,
     "maxSurbUpstream": "2000 kb/s",
     "port": 5542,
     "protocol": "tcp",
     "responseBuffer": "2 MB",
     "returnPath": {
       "Hops": 1
     },
     "sessionPool": 0,
     "surbLen": 398,
     "target": "example.com:80"
   }
 ],
 "type": "object",
 "required": [
   "activeClients",
   "destination",
   "forwardPath",
   "hoprMtu",
   "ip",
   "maxClientSessions",
   "port",
   "protocol",
   "returnPath",
   "surbLen",
   "target"
 ],
 "properties": {
   "activeClients": {
     "description": "Lists Session IDs of all active clients.\n\nCan contain multiple entries on TCP sessions, but currently\nalways only a single entry on UDP sessions.",
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "destination": {
     "description": "Destination node (exit node) of the Session.",
     "type": "string"
   },
   "forwardPath": {
     "$ref": "#/components/schemas/RoutingOptions"
   },
   "hoprMtu": {
     "description": "MTU used by the underlying HOPR transport.",
     "type": "integer",
     "minimum": 0.0
   },
   "ip": {
     "description": "Listening IP address of the Session's socket.",
     "examples": [
       "127.0.0.1"
     ],
     "type": "string"
   },
   "maxClientSessions": {
     "description": "The maximum number of client sessions that the listener can spawn.\n\nThis currently applies only to the TCP sessions, as UDP sessions cannot\nhave multiple clients (defaults to 1 for UDP).",
     "type": "integer",
     "minimum": 0.0
   },
   "maxSurbUpstream": {
     "description": "The maximum throughput at which artificial SURBs might be generated and sent\nto the recipient of the Session.",
     "type": [
       "string",
       "null"
     ]
   },
   "port": {
     "description": "Listening port of the Session's socket.",
     "examples": [
       5542
     ],
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "protocol": {
     "$ref": "#/components/schemas/IpProtocol"
   },
   "responseBuffer": {
     "description": "The amount of response data the Session counterparty can deliver back to us, without us\nsending any SURBs to them.",
     "type": [
       "string",
       "null"
     ]
   },
   "returnPath": {
     "$ref": "#/components/schemas/RoutingOptions"
   },
   "sessionPool": {
     "description": "How many Sessions to pool for clients.",
     "type": [
       "integer",
       "null"
     ],
     "minimum": 0.0
   },
   "surbLen": {
     "description": "Size of a Single Use Reply Block used by the protocol.\n\nThis is useful for SURB balancing calculations.",
     "type": "integer",
     "minimum": 0.0
   },
   "target": {
     "description": "Target of the Session.",
     "examples": [
       "example.com:80"
     ],
     "type": "string"
   }
 }
}

Fields

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.

destination: String

Destination node (exit node) of the Session.

forward_path: RoutingOptions

hopr_mtu: u64

MTU used by the underlying HOPR transport.

ip: String

Listening IP address of the Session’s socket.

max_client_sessions: u64

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<String>

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

port: i32

Listening port of the Session’s socket.

protocol: IpProtocol

response_buffer: Option<String>

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

return_path: RoutingOptions

session_pool: Option<u64>

How many Sessions to pool for clients.

surb_len: u64

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

This is useful for SURB balancing calculations.

target: String

Target of the Session.

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 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.