Struct jamsocket_server::RoomActor

pub struct RoomActor { /* fields omitted */ }

Actor model representation of a “room”. A room is a set of clients that share an instance of a Jamsocket instance. Conceptually, this is like a room in a chat service. Events (such as messages) and their side-effects are isolated to the room in which they occur.

Implementations

impl RoomActor

pub fn new(
    room_id: String,
    service_actor: Recipient<MessageFromClient>,
    shutdown_policy: ServiceShutdownPolicy
) -> Self

Trait Implementations

impl Actor for RoomActor

type Context = Context<Self>

Actor execution context type

fn started(&mut self, ctx: &mut Self::Context)

Called when an actor gets polled the first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

fn start_in_arbiter<F>(wrk: &ArbiterHandle, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: 'static + FnOnce(&mut Context<Self>) -> Self + Send, 

Start new actor in arbiter’s thread.

fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl Handler<AssignClientId> for RoomActor

type Result = ClientId

The type of value that this handler will return.

fn handle(&mut self, _: AssignClientId, _ctx: &mut Context<Self>) -> ClientId

This method is called for every message received by this actor.

impl Handler<MessageFromClient> for RoomActor

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, message: MessageFromClient, ctx: &mut Context<Self>)

This method is called for every message received by this actor.

impl Handler<MessageFromServer> for RoomActor

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, message: MessageFromServer, _ctx: &mut Context<Self>)

This method is called for every message received by this actor.

impl MessageResponse<RoomActor, AssignClientId> for ClientId

fn handle(self, _: &mut Context<RoomActor>, tx: Option<OneshotSender<ClientId>>)