romp 0.5.2

STOMP server and WebSockets platform
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


pub mod ack;
pub mod admin;
pub mod closure;
pub mod connect;
pub mod disconnect;
pub mod http;
pub mod log;
pub mod persist;
pub mod ping;
pub mod echo;
pub mod receipt;
pub mod requires_auth;
pub mod resend;
pub mod send;
pub mod subscribe;

use crate::message::stomp_message::StompMessage;
use crate::workflow::context::Context;
use std::fmt::Debug;

#[derive(Debug)]
pub struct FilterError  {
    /// Message sent to client in the ERROR response
    pub reply_message: Option<String>,
    /// Text logged by the server
    pub log_message: Option<String>,
    /// if true session will be shutdown
    pub fatal: bool,
}

/// Outer Filter for processing StompMessage that may be HTTP
pub trait MessageFilter: Debug {

    fn init(&mut self);

    /// handle a message, return true if the message was fully processed or false if the filter
    /// expects the chain to continue.
    fn do_filter(&self, context: &mut Context, message: &mut StompMessage) -> Result<bool, FilterError>;

}


#[derive(Debug)]
pub struct HttpError  {
    pub log_message: Option<String>,
}

/// Inner filters that only deal with HTTP messages
pub trait HttpFilter: Debug {

    fn init(&mut self);

    /// handle a message, return true if the message was fully processed or false if the filter
    /// expects the chain to continue.
    fn do_filter(&self, context: &mut Context, message: &mut StompMessage) -> Result<bool, HttpError>;

}

/// Inner filters that only deal with /virt/admin/ STOMP messages
pub trait AdminFilter {

    fn init(&mut self);

    /// handle a message, return true if the message was fully processed or false if the filter
    /// expects the chain to continue.
    fn do_filter(&self, context: &mut Context, message: &mut StompMessage) -> Result<bool, FilterError>;

}