Struct general_pub_sub::PubSub

pub struct PubSub<'a, TClient: Client<TIdentifier, TMessage>, TIdentifier: UniqueIdentifier, TMessage> { /* fields omitted */ }

A PubSub

Implementations

impl<'a, TClient: Client<TIdentifier, TMessage>, TIdentifier: UniqueIdentifier, TMessage: Clone + Copy> PubSub<'a, TClient, TIdentifier, TMessage>

Implementation for a PubSub

The standard workflow for a PubSub is to:

1. Create a new PubSub.
2. Add one or more Clients.
3. Subscribe the Clients to Channels of interest.
4. Publish Messages to the Channels. The Message is broadcast to all Clients subscribed to the Channel.

pub fn new() -> PubSub<'a, TClient, TIdentifier, TMessage>

Creates a new PubSub

All Clients of the PubSub must use the same type of Identifier and receive the same type of Message.

pub fn add_client(&mut self, client: TClient)

Adds a Client to the PubSub

pub fn remove_client(&mut self, client: TClient)

pub fn sub_client(
    &mut self,
    client: TClient,
    channel: &'a str
) -> Result<(), PubSubError>

Subscribes a Client to a Channel.

Results in a PubSubError when a Client attempts to subscribe to a Channel that it is already subscribed to.

pub fn unsub_client(
    &mut self,
    client: TClient,
    channel: &'a str
) -> Result<(), PubSubError>

Unsubscribes a Client from a Channel

Results in a PubSubError when a Client attempts to unsubscribe from a Channel it is not subscribed to.

pub fn pub_message<TInputMessage: Into<TMessage>>(
    &mut self,
    channel: &str,
    msg: TInputMessage
)

Publishes a Message to all Clients subscribed to the provided Channel.

Trait Implementations

impl<'a, TClient: Client<TIdentifier, TMessage>, TIdentifier: UniqueIdentifier, TMessage: Clone + Copy> Default for PubSub<'a, TClient, TIdentifier, TMessage>

fn default() -> Self

Returns the “default value” for a type.