Struct Config 

pub struct Config {

    pub network_id: u32,
    pub ecdsa_key: Option<SecretKey>,
    pub session_manager: Option<String>,
    pub session_sk: Option<String>,
    pub internal_api_port: u16,
    pub external_api_addr: String,
    pub endpoint_url: String,
    pub ice_servers: String,
    pub stabilize_interval: u64,
    pub online_node_heartbeat_interval_secs: u64,
    pub online_node_ttl_secs: u64,
    pub online_node_type: OnlineNodeType,
    pub advertise_presence: bool,
    pub advertise_onion_relay: bool,
    pub advertise_onion_exit: bool,
    pub onion_exit_heartbeat_interval_secs: u64,
    pub onion_exit_ttl_secs: u64,
    pub onion_exit_services: Vec<OnionExitService>,
    pub onion_exit_policy: OnionExitPolicy,
    pub onion_http_proxy_addr: Option<String>,
    pub onion_http_proxy_service: OnionServiceName,
    pub onion_http_proxy_hop_count: usize,
    pub onion_http_proxy_allow_short_paths: bool,
    pub onion_http_proxy_header_timeout_secs: u64,
    pub onion_http_proxy_max_connections: usize,
    pub gateway: Option<NativeGatewayConfig>,
    pub dht_virtual_nodes: u16,
    pub external_ip: Option<String>,
    pub webrtc_udp_port_min: Option<u16>,
    pub webrtc_udp_port_max: Option<u16>,
    pub data_storage: StorageConfig,
    pub measure_storage: StorageConfig,
}

Serializable native-node configuration.

Fields

network_id: u32

Rings network identifier this node joins.

ecdsa_key: Option<SecretKey>

Deprecated ECDSA key field retained for backward-compatible config reads.

session_manager: Option<String>

Deprecated session manager field retained for backward-compatible config reads.

session_sk: Option<String>

Session secret key file path or legacy raw session key string.

internal_api_port: u16

Internal JSON-RPC API port.

external_api_addr: String

External JSON-RPC listener address.

endpoint_url: String

Internal endpoint URL used by local clients.

ice_servers: String

WebRTC ICE server list, independent from optional gateway ingress.

stabilize_interval: u64

Chord stabilization interval in seconds.

online_node_heartbeat_interval_secs: u64

Presence descriptor heartbeat interval in seconds.

online_node_ttl_secs: u64

Presence descriptor time-to-live in seconds.

online_node_type: OnlineNodeType

Node type advertised in online-node descriptors.

advertise_presence: bool

Whether this node publishes online-node descriptors.

advertise_onion_relay: bool

Whether this node advertises onion relay capability.

advertise_onion_exit: bool

Whether this node advertises onion exit capability.

onion_exit_heartbeat_interval_secs: u64

Onion-exit descriptor heartbeat interval in seconds.

onion_exit_ttl_secs: u64

Onion-exit descriptor time-to-live in seconds.

onion_exit_services: Vec<OnionExitService>

Onion-exit services this node can publish.

onion_exit_policy: OnionExitPolicy

Onion-exit target and resource policy.

onion_http_proxy_addr: Option<String>

Optional local HTTP CONNECT proxy listener address.

onion_http_proxy_service: OnionServiceName

Onion service name used by the HTTP CONNECT proxy.

onion_http_proxy_hop_count: usize

Requested hop count for HTTP CONNECT proxy routes.

onion_http_proxy_allow_short_paths: bool

Whether the HTTP CONNECT proxy may use shorter routes when needed.

onion_http_proxy_header_timeout_secs: u64

Timeout for reading HTTP CONNECT headers in seconds.

onion_http_proxy_max_connections: usize

Maximum simultaneous HTTP CONNECT proxy connections.

gateway: Option<NativeGatewayConfig>

Optional native TUN gateway started in the same foreground lifecycle.

dht_virtual_nodes: u16

Virtual DHT positions per storage owner.

external_ip: Option<String>

Optional externally reachable IP address hint.

webrtc_udp_port_min: Option<u16>

Optional lower bound for WebRTC UDP port allocation.

webrtc_udp_port_max: Option<u16>

Optional upper bound for WebRTC UDP port allocation.

data_storage: StorageConfig

Persistent DHT data storage configuration.

measure_storage: StorageConfig

Peer measurement storage configuration.

Implementations

impl Config

pub fn new<P>(session_sk: P) -> Self

where P: AsRef<Path>,

Creates a default native-node configuration using the supplied session key path.

pub fn write_fs<P>(&self, path: P) -> Result<String>

where P: AsRef<Path>,

Writes this configuration to a YAML file and returns the written path.

pub fn read_fs<P>(path: P) -> Result<Config>

where P: AsRef<Path>,

Reads a native-node configuration from a YAML file.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Config> for ProcessorConfigSerialized

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self>

Performs the conversion.

impl TryFrom<Config> for ProcessorConfig

type Error = Error

The type returned in the event of a conversion error.

fn try_from(config: Config) -> Result<Self>

Performs the conversion.