Struct SocketFanOut 

pub struct SocketFanOut { /* private fields */ }

Delivers relayed broadcasts to the sockets in a Rooms registry.

use std::sync::Arc;
use rainier_framework::relay::SocketFanOut;
use rainier_websocket::Rooms;

let rooms = Arc::new(Rooms::new());

// Channels are named `private-orders.7`; this application's rooms are
// named `orders.7`.
let fan_out = SocketFanOut::new(Arc::clone(&rooms))
    .naming_rooms(|channel| Some(channel.trim_start_matches("private-").to_string()));

Implementations

impl SocketFanOut

pub fn new(rooms: Arc<Rooms>) -> Self

Deliver to rooms, with the room named exactly as the channel is.

pub fn naming_rooms<F>(self, room_for: F) -> Self

where F: Fn(&str) -> Option<String> + Send + Sync + 'static,

Decide the room a channel’s broadcasts belong in.

None drops the broadcast, which is how a relay ignores channels this process does not serve — a topic shared with another application, or a channel that only a Pusher client listens to.

pub fn deliver(&self, broadcast: &RelayedBroadcast) -> usize

Send one broadcast to whoever is in the room. Returns how many got it.

to_others is honoured here, at the point of delivery, because this is the only place that knows which sockets it is talking to. An identity minted by another replica names no socket in this process, so nothing is skipped and everyone here is told — which is the correct answer, not a fallback.

pub fn rooms(&self) -> &Arc<Rooms>

The registry being fanned out to.

Trait Implementations

impl Clone for SocketFanOut

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.