Struct NetTransportOptions

pub struct NetTransportOptions<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> { /* private fields */ }

Used to configure a net transport.

Implementations

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> NetTransportOptions<I, A, S>

pub const fn id(&self) -> &I

Get the id of the node.

pub const fn bind_addresses(&self) -> &IndexSet<A::Address>

Get a set of addresses to bind to for both TCP and UDP communications.

pub const fn resolver(&self) -> &A::Options

Get the address resolver options.

pub const fn stream_layer(&self) -> &S::Options

Get the stream layer options.

pub const fn cidrs_policy(&self) -> &CIDRsPolicy

Get the policy for Classless Inter-Domain Routing (CIDR).

pub const fn max_packet_size(&self) -> usize

Get the maximum payload size can be sent by UDP. Default is 1472 bytes.

pub const fn recv_buffer_size(&self) -> usize

Get the UDP receive window. Default is 2MB.

pub fn metric_labels(&self) -> Option<&MetricLabels>

Available on crate feature metrics only.

Get the metrics labels.

pub fn with_id(self, val: I) -> Self

Set the id of the node. (Builder pattern)

pub fn with_bind_addresses(self, val: IndexSet<A::Address>) -> Self

Set the set of addresses to bind to for both TCP and UDP communications. (Builder pattern)

pub fn with_resolver(self, val: A::Options) -> Self

Set the address resolver options. (Builder pattern)

pub fn with_stream_layer(self, val: S::Options) -> Self

Set the stream layer options. (Builder pattern)

pub fn with_cidrs_policy(self, val: CIDRsPolicy) -> Self

Set the policy for Classless Inter-Domain Routing (CIDR). (Builder pattern)

pub fn with_max_packet_size(self, val: usize) -> Self

Set the maximum payload size can be sent by UDP. Default is 1472 bytes. (Builder pattern)

pub fn with_recv_buffer_size(self, val: usize) -> Self

Set the UDP receive window. Default is 2MB. (Builder pattern)

pub fn with_metric_labels(self, val: Option<Arc<MetricLabels>>) -> Self

Available on crate feature metrics only.

Set the metrics labels. (Builder pattern)

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> NetTransportOptions<I, A, S>

where A::Options: Default, S::Options: Default,

pub fn new(id: I) -> Self

Creates a new net transport options by id, other configurations are left default.

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> NetTransportOptions<I, A, S>

where S::Options: Default,

pub fn with_resolver_options(id: I, resolver_options: A::Options) -> Self

Creates a new net transport options by id and resolver options, other configurations are left default.

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> NetTransportOptions<I, A, S>

where A::Options: Default,

pub fn with_stream_layer_options( id: I, stream_layer_options: S::Options, ) -> Self

Creates a new net transport options by id and stream layer options, other configurations are left default.

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> NetTransportOptions<I, A, S>

pub fn with_resolver_options_and_stream_layer_options( id: I, resolver_options: A::Options, stream_layer_opts: S::Options, ) -> Self

Creates a new net transport options by id, resolver options and stream layer options, other configurations are left default.

pub fn add_bind_address(&mut self, addr: A::Address) -> &mut Self

Add bind address

Trait Implementations

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> Clone for NetTransportOptions<I, A, S>

where I: Clone, A::Options: Clone, S::Options: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, A: Debug + AddressResolver<ResolvedAddress = SocketAddr>, S: Debug + StreamLayer> Debug for NetTransportOptions<I, A, S>

where A::Address: Debug, A::Options: Debug, S::Options: Debug,

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

Formats the value using the given formatter.

impl<'de, I, A, S: StreamLayer> Deserialize<'de> for NetTransportOptions<I, A, S>

where I: Deserialize<'de>, A: AddressResolver + AddressResolver<ResolvedAddress = SocketAddr>, A::Address: Deserialize<'de>, A::ResolvedAddress: Deserialize<'de>, A::Options: Deserialize<'de>, S::Options: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I, A: AddressResolver<ResolvedAddress = SocketAddr>, S: StreamLayer> From<NetTransportOptions<I, A, S>> for (A::Options, S::Options, Options<I, A>)

fn from( opts: NetTransportOptions<I, A, S>, ) -> (A::Options, S::Options, Options<I, A>)

Converts to this type from the input type.

impl<I, A, S: StreamLayer> Serialize for NetTransportOptions<I, A, S>

where I: Serialize, A: AddressResolver + AddressResolver<ResolvedAddress = SocketAddr>, A::Address: Serialize, A::ResolvedAddress: Serialize, A::Options: Serialize, S::Options: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.