Struct ForwardLimits 

pub struct ForwardLimits {
    pub join_request: TokenBucket,
    pub notify: TokenBucket,
    pub global_uplink: TokenBucket,
    pub overall: TokenBucket,
}

A relay’s four relay-wide limits, TS011-1.0.1 tables 23 and 24.

A join request spends a token of join_request and overall, an uplink from a trusted end device one of its own bucket, global_uplink and overall, and a notification of an unknown end device one of notify and overall.

Examples

use pamoja_lorawan::relay::ForwardLimits;

let mut limits = ForwardLimits::new();
assert_eq!(limits.join_request.reload_rate(), Some(4));
assert_eq!(limits.join_request.size(), 8);

// A relay starts with an hour's worth of tokens, so a fifth join request waits.
for _ in 0..4 {
    assert!(limits.join_request.take());
}
assert!(!limits.join_request.has_token());

// An hour on, four more arrive.
limits.reload(1);
assert_eq!(limits.join_request.tokens(), 4);

Fields

join_request: TokenBucket

Join requests forwarded.

notify: TokenBucket

Notifications of end devices the relay does not trust.

global_uplink: TokenBucket

Uplinks forwarded for every trusted end device together.

overall: TokenBucket

Everything the relay sends on behalf of others.

Implementations

impl ForwardLimits

pub const fn new() -> ForwardLimits

The limits of TS011-1.0.1 table 23, each holding one hour’s reload.

Returns

Four join requests and four notifications an hour, each bucket twice that; and eight uplinks and eight messages overall an hour, each bucket sixteen.

pub fn configure( &mut self, reset: CounterReset, reload_rates: [u8; 4], bucket_sizes: [u8; 4], )

Takes a ConfigureFwdLimitReq, TS011-1.0.1 section 10.6.

Arguments

• reset - what happens to the counters.
• reload_rates - the coded rates, join request, notify, global uplink and overall, 127 meaning no limit.
• bucket_sizes - the coded size multipliers in the same order, table 55.

pub fn reload(&mut self, hours: u64)

Adds what every bucket earns over some hours.

Arguments

• hours - the whole hours since the last reload.

pub fn restart(&mut self)

Sets every bucket to one hour’s reload, as TS011-1.0.1 section 8.8 has a relay do when it starts scanning.

Trait Implementations

impl Clone for ForwardLimits

fn clone(&self) -> ForwardLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ForwardLimits

impl Debug for ForwardLimits

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

Formats the value using the given formatter.

impl Default for ForwardLimits

fn default() -> ForwardLimits

Returns the “default value” for a type.

impl Eq for ForwardLimits

impl Hash for ForwardLimits

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ForwardLimits

fn eq(&self, other: &ForwardLimits) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ForwardLimits