pub struct ServerBuilder<M: Metadata, S: Middleware<M>> { /* private fields */ }
Expand description
Builder for WebSockets
server
Implementations§
Source§impl<M: Metadata + Default, S: Middleware<M>> ServerBuilder<M, S>
impl<M: Metadata + Default, S: Middleware<M>> ServerBuilder<M, S>
Sourcepub fn new<T>(handler: T) -> Selfwhere
T: Into<MetaIoHandler<M, S>>,
pub fn new<T>(handler: T) -> Selfwhere
T: Into<MetaIoHandler<M, S>>,
Creates new ServerBuilder
Examples found in repository?
4fn main() {
5 let mut io = IoHandler::default();
6 io.add_sync_method("say_hello", |_params| {
7 println!("Processing");
8 Ok(Value::String("hello".to_owned()))
9 });
10
11 let server = ServerBuilder::new(io)
12 .start(&"0.0.0.0:3030".parse().unwrap())
13 .expect("Server must start with no issues");
14
15 server.wait().unwrap()
16}
Source§impl<M: Metadata, S: Middleware<M>> ServerBuilder<M, S>
impl<M: Metadata, S: Middleware<M>> ServerBuilder<M, S>
Sourcepub fn with_meta_extractor<T, E>(handler: T, extractor: E) -> Self
pub fn with_meta_extractor<T, E>(handler: T, extractor: E) -> Self
Creates new ServerBuilder
Sourcepub fn event_loop_executor(self, executor: TaskExecutor) -> Self
pub fn event_loop_executor(self, executor: TaskExecutor) -> Self
Utilize existing event loop executor to poll RPC results.
Sourcepub fn session_meta_extractor<T: MetaExtractor<M>>(self, extractor: T) -> Self
pub fn session_meta_extractor<T: MetaExtractor<M>>(self, extractor: T) -> Self
Sets a meta extractor.
Sourcepub fn allowed_origins(self, allowed_origins: DomainsValidation<Origin>) -> Self
pub fn allowed_origins(self, allowed_origins: DomainsValidation<Origin>) -> Self
Allowed origins.
Sourcepub fn allowed_hosts(self, allowed_hosts: DomainsValidation<Host>) -> Self
pub fn allowed_hosts(self, allowed_hosts: DomainsValidation<Host>) -> Self
Allowed hosts.
Sourcepub fn session_stats<T: SessionStats>(self, stats: T) -> Self
pub fn session_stats<T: SessionStats>(self, stats: T) -> Self
Session stats
Sourcepub fn request_middleware<T: RequestMiddleware>(self, middleware: T) -> Self
pub fn request_middleware<T: RequestMiddleware>(self, middleware: T) -> Self
Sets a request middleware. Middleware will be invoked before each handshake request. You can either terminate the handshake in the middleware or run a default behaviour after.
Sourcepub fn max_connections(self, max_connections: usize) -> Self
pub fn max_connections(self, max_connections: usize) -> Self
Maximal number of concurrent connections this server supports. Default: 100
Sourcepub fn max_payload(self, max_payload_bytes: usize) -> Self
pub fn max_payload(self, max_payload_bytes: usize) -> Self
Maximal size of the payload (in bytes) Default: 5MB
Sourcepub fn max_in_buffer_capacity(self, max_in_buffer_capacity: usize) -> Self
pub fn max_in_buffer_capacity(self, max_in_buffer_capacity: usize) -> Self
The maximum size to which the incoming buffer can grow. Default: 10,485,760
Sourcepub fn max_out_buffer_capacity(self, max_out_buffer_capacity: usize) -> Self
pub fn max_out_buffer_capacity(self, max_out_buffer_capacity: usize) -> Self
The maximum size to which the outgoing buffer can grow. Default: 10,485,760
Sourcepub fn start(self, addr: &SocketAddr) -> Result<Server>
pub fn start(self, addr: &SocketAddr) -> Result<Server>
Starts a new WebSocket
server in separate thread.
Returns a Server
handle which closes the server when droped.
Examples found in repository?
4fn main() {
5 let mut io = IoHandler::default();
6 io.add_sync_method("say_hello", |_params| {
7 println!("Processing");
8 Ok(Value::String("hello".to_owned()))
9 });
10
11 let server = ServerBuilder::new(io)
12 .start(&"0.0.0.0:3030".parse().unwrap())
13 .expect("Server must start with no issues");
14
15 server.wait().unwrap()
16}