Struct jamsocket_server::ClientSocketConnection

pub struct ClientSocketConnection {
    pub room: Recipient<MessageFromClient>,
    pub client_id: ClientId,
    pub room_id: String,
    pub ip: String,
    pub last_seen: Instant,
    pub heartbeat_interval: Duration,
    pub heartbeat_timeout: Duration,
    pub interval_handle: Option<SpawnHandle>,
}

Represents a connection from a service to a client, which consists of a message receiver and a user ID.

Fields

room: Recipient<MessageFromClient>

client_id: ClientId

room_id: String

ip: String

last_seen: Instant

heartbeat_interval: Duration

heartbeat_timeout: Duration

interval_handle: Option<SpawnHandle>

Trait Implementations

impl Actor for ClientSocketConnection

type Context = WebsocketContext<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<MessageFromServer> for ClientSocketConnection

type Result = ()

The type of value that this handler will return.

fn handle(&mut self, msg: MessageFromServer, ctx: &mut Self::Context)

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

impl StreamHandler<Result<Message, ProtocolError>> for ClientSocketConnection

fn handle(
    &mut self,
    msg: Result<Message, ProtocolError>,
    ctx: &mut Self::Context
)

Called for every message emitted by the stream.

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

Called when stream emits first item.

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

Called when stream finishes.

fn add_stream<S>(stream: S, ctx: &mut Self::Context) -> SpawnHandle where
    Self: StreamHandler<<S as Stream>::Item>,
    S: 'static + Stream,
    Self::Context: AsyncContext<Self>, 

Register a Stream to the actor context.