Skip to main content

SessionConfig

Struct SessionConfig 

Source
pub struct SessionConfig {
    pub queue_capacity: usize,
    pub apdu_timeout_ms: u64,
    pub apdu_retries: u8,
    pub max_apdu_length: u16,
    pub read_work_limit: usize,
    pub min_request_interval_ms: u64,
}
Expand description

Session tuning (bounded queues, client timers, the responder’s read work limit).

Typed at the public boundary: every field is validated where it matters (queue_capacity == 0, read_work_limit == 0 or a min_request_interval_ms past an hour fails EndpointSession::new; APDU/timer values flow into the client role config unchanged).

use bacnet_endpoint::session::SessionConfig;

let config = SessionConfig::default();
assert!(config.queue_capacity > 0);
assert_eq!(config.max_apdu_length, 480);
assert_eq!(config.read_work_limit, 256);
assert_eq!(config.min_request_interval_ms, 0);

Fields§

§queue_capacity: usize

Bounded capacity for each ingress queue + egress channel.

Must be greater than zero; EndpointSession::new returns Error::Encoding otherwise.

§apdu_timeout_ms: u64

Client APDU timeout (ms).

§apdu_retries: u8

Client APDU retries.

§max_apdu_length: u16

Client max APDU length.

Standalone default is 480. Composing a DeviceIdentity via device overrides this at start with the identity’s ceiling resolved against the transport’s stable local receive capacity (480 for standard MS/TP, 1476 for extended MS/TP).

§read_work_limit: usize

Result rows one ReadProperty served by the server role may expand (default 256).

The endpoint’s counterpart of the server’s ReadPropertyMultipleBudget::max_result_elements, with the same default. A read counts its own row, and a Group’s Present_Value adds one row per member property after ALL, REQUIRED and OPTIONAL expand. A read past the limit is answered with an Abort carrying OUT_OF_RESOURCES before any member is read.

Must be greater than zero; EndpointSession::new returns Error::Encoding otherwise.

§min_request_interval_ms: u64

Least time, in milliseconds, between the client role’s confirmed requests to one destination (default 0: no pacing), measured as ClientConfig::min_request_interval_ms says for BACnetClient (#1542).

Only new confirmed requests wait: a retry keeps its request’s turn, and replies, notifications and unconfirmed requests go at once. Stopping or dropping the session ends a wait at once with the shutdown error. At most MAX_MIN_REQUEST_INTERVAL_MS, an hour; EndpointSession::new returns Error::Encoding past it.

Trait Implementations§

Source§

impl Clone for SessionConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SessionConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more