sockjs 0.3.0

SockJS server for Actix
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use actix::*;

use protocol::Frame;
use context::SockJSContext;

/// Session state
#[derive(PartialEq, Debug)]
pub enum SessionState {
    /// Newly create session
    New,
    /// Transport is connected
    Running,
    /// Session interrupted
    Interrupted,
    /// Session is closed
    Closed,
}

#[derive(Debug, Message)]
pub struct Message(pub String);

impl From<Message> for Frame {
    fn from(m: Message) -> Frame {
        Frame::Message(m.0)
    }
}

impl From<&'static str> for Message {
    fn from(s: &'static str) -> Message {
        Message(s.to_owned())
    }
}

impl From<String> for Message {
    fn from(s: String) -> Message {
        Message(s)
    }
}

#[doc(hidden)]
#[derive(Debug, PartialEq)]
pub enum SessionError {
    Acquired,
    Interrupted,
    Closing,
    InternalError,
}

#[derive(Debug)]
/// Reason for closing session
pub enum CloseReason {
    /// Session closed session
    Normal,
    /// Session expired
    Expired,
    /// Peer get disconnected
    Interrupted,
}

/// This trait defines sockjs session
#[allow(unused_variables)]
pub trait Session: Actor<Context=SockJSContext<Self>> + Default + Handler<Message> {

    /// Method get called when session get opened
    fn opened(&mut self, ctx: &mut SockJSContext<Self>) {}

    /// Method get called when transport acquires this session
    fn acquired(&mut self, ctx: &mut SockJSContext<Self>) {}

    /// Method get called when transport releases this session
    fn released(&mut self, ctx: &mut SockJSContext<Self>) {}

    /// Method get called when session get closed
    fn closed(&mut self, ctx: &mut SockJSContext<Self>, reason: CloseReason) {}
}