Struct lemmy_server::api_routes_websocket::WsChatSession

pub struct WsChatSession {
    pub id: ConnectionId,
    pub ip: IpAddr,
    pub hb: Instant,
    /* private fields */
}

Fields

id: ConnectionId

unique session id

ip: IpAddr

hb: Instant

Client must send ping at least once per 10 seconds (CLIENT_TIMEOUT), otherwise we drop connection.

Trait Implementations

impl Actor for WsChatSession

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

Method is called on actor start. We register ws session with ChatServer

type Context = WebsocketContext<WsChatSession>

Actor execution context type

fn stopping(&mut self, _: &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.

impl Handler<WsMessage> for WsChatSession

Handle messages from chat server, we simply send it to peer websocket

type Result = ()

The type of value that this handler will return.

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

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

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

WebSocket message handler

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) -> SpawnHandlewhere S: Stream + 'static, Self: StreamHandler<<S as Stream>::Item>, Self::Context: AsyncContext<Self>,

Register a Stream to the actor context.