Skip to main content

GspClient

Struct GspClient 

Source
pub struct GspClient {
    pub muted: HashSet<u32>,
    pub members: HashSet<u32>,
    /* private fields */
}
Expand description

Stateful GSP client.

Tracks request_id deduplication, the current membership set and the mute-list. Membership is updated atomically when JOIN, LEAVE, MUTE or UNMUTE signals are accepted. The request_id set is LRU-bounded at [GSP_SEEN_CAP] entries per epoch.

The client observes the current group epoch on every GspClient::send or GspClient::accept call and automatically clears its request_id deduplication set when the epoch advances. Callers may also drive a reset explicitly via GspClient::reset.

Fields§

§muted: HashSet<u32>

Members that are currently muted.

§members: HashSet<u32>

Current membership set, driven by JOIN / LEAVE.

Implementations§

Source§

impl GspClient

Source

pub fn new() -> GspClient

Creates an empty client.

Source

pub fn send<S>( &mut self, node: &mut GroupNode, seal: &mut S, target: u32, signal: SignalType, role_claim: u32, request_id: u32, codec: PayloadCodec, ) -> Result<OutboundFrame, GspError>
where S: Sealer,

Sends a signal. Uses the O | R | A profile required by GSP §3. codec controls payload encoding; use PayloadCodec::Cbor for maximum compatibility.

Source

pub fn send_with_args<S>( &mut self, node: &mut GroupNode, seal: &mut S, target: u32, signal: SignalType, role_claim: u32, request_id: u32, args: &[u8], codec: PayloadCodec, ) -> Result<OutboundFrame, GspError>
where S: Sealer,

Sends a signal with opcode-specific args bytes. Use this for signals that require structured arguments (MUTE, UNMUTE, ROLE_CHANGE, STREAM_START, STREAM_STOP, CODEC_UPDATE). codec controls how the GspSignal envelope is encoded; args bytes are always opaque and carried as-is regardless of codec.

Source

pub fn accept( &mut self, plaintext: &[u8], current_epoch: u64, codec: PayloadCodec, ) -> Result<GspAccept, GspError>

Accepts a signal payload, applies the state effects defined in GSP §5 and returns the decoded GspAccept.

current_epoch is the receiver node’s current epoch — passing it lets the client auto-reset its request_id deduplication set when the epoch advances. codec must match [DeliveredPayload::codec].

Source

pub fn sync_epoch(&mut self, epoch: u64)

Synchronises the client’s view of the group epoch and resets the request_id deduplication set when the epoch has advanced. Called automatically by GspClient::send and GspClient::accept.

Source

pub fn reset(&mut self)

Clears the request-id deduplication set unconditionally.

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<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<T> Classify for T

Source§

type Classified = T

Source§

fn classify(self) -> T

Source§

impl<T> Declassify for T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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