Struct websocket::server::Server

pub struct Server<'a> {
    // some fields omitted
}

Represents a WebSocket server which can work with either normal (non-secure) connections, or secure WebSocket connections.

This is a convenient way to implement WebSocket servers, however it is possible to use any sendable Reader and Writer to obtain a WebSocketClient, so if needed, an alternative server implementation can be used.

Non-secure Servers

extern crate websocket;
use std::thread;
use websocket::{Server, Message};

let server = Server::bind("127.0.0.1:1234").unwrap();

for connection in server {
    // Spawn a new thread for each connection.
    thread::spawn(move || {
           let request = connection.unwrap().read_request().unwrap(); // Get the request
           let response = request.accept(); // Form a response
           let mut client = response.send().unwrap(); // Send the response

           let message = Message::Text("Hello, client!".to_string());
           let _ = client.send_message(message);

           // ...
    });
}

Secure Servers

extern crate websocket;
extern crate openssl;
use std::thread;
use std::path::Path;
use websocket::{Server, Message};
use openssl::ssl::{SslContext, SslMethod};
use openssl::x509::X509FileType;

let mut context = SslContext::new(SslMethod::Tlsv1).unwrap();
let _ = context.set_certificate_file(&(Path::new("cert.pem")), X509FileType::PEM);
let _ = context.set_private_key_file(&(Path::new("key.pem")), X509FileType::PEM);
let server = Server::bind_secure("127.0.0.1:1234", &context).unwrap();

for connection in server {
    // Spawn a new thread for each connection.
    thread::spawn(move || {
           let request = connection.unwrap().read_request().unwrap(); // Get the request
           let response = request.accept(); // Form a response
           let mut client = response.send().unwrap(); // Send the response

           let message = Message::Text("Hello, client!".to_string());
           let _ = client.send_message(message);

           // ...
    });
}

Methods

impl<'a> Server<'a>

fn bind<T: ToSocketAddrs>(addr: T) -> Result<Server<'a>>

Bind this Server to this socket

fn bind_secure<T: ToSocketAddrs>(addr: T, context: &'a SslContext) -> Result<Server<'a>>

Bind this Server to this socket, utilising the given SslContext

fn local_addr(&mut self) -> Result<SocketAddr>

Get the socket address of this server

fn try_clone(&self) -> Result<Server<'a>>

Create a new independently owned handle to the underlying socket.

fn accept(&mut self) -> Result<Connection<WebSocketStream, WebSocketStream>>

Wait for and accept an incoming WebSocket connection, returning a WebSocketRequest

Trait Implementations

impl<'a> Iterator for Server<'a>

type Item = Result<Connection<WebSocketStream, WebSocketStream>>

fn next(&mut self) -> Option<Self::Item>

fn size_hint(&self) -> (usize, Option<usize>)

fn count(self) -> usize

fn last(self) -> Option<Self::Item>

fn nth(&mut self, n: usize) -> Option<Self::Item>

fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>

fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator

fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B

fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>

fn enumerate(self) -> Enumerate<Self>

fn peekable(self) -> Peekable<Self>

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool

fn skip(self, n: usize) -> Skip<Self>

fn take(self, n: usize) -> Take<Self>

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where F: FnMut(Self::Item) -> U, U: IntoIterator

fn fuse(self) -> Fuse<Self>

fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()

fn by_ref(&mut self) -> &mut Self

fn collect<B>(self) -> B where B: FromIterator<Self::Item>

fn partition<B, F>(self, f: F) -> (B, B) where F: FnMut(&Self::Item) -> bool, B: Default + Extend<Self::Item>

fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B

fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool

fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool

fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where Self: ExactSizeIterator + DoubleEndedIterator, P: FnMut(Self::Item) -> bool

fn max(self) -> Option<Self::Item> where Self::Item: Ord

fn min(self) -> Option<Self::Item> where Self::Item: Ord

fn min_max(self) -> MinMaxResult<Self::Item> where Self::Item: Ord

fn max_by<B, F>(self, f: F) -> Option<Self::Item> where F: FnMut(&Self::Item) -> B, B: Ord

fn min_by<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B

fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where Self: Iterator<Item=(A, B)>, FromB: Default + Extend<B>, FromA: Default + Extend<A>

fn cloned<'a, T>(self) -> Cloned<Self> where T: 'a + Clone, Self: Iterator<Item=&'a T>

fn cycle(self) -> Cycle<Self> where Self: Clone

fn reverse_in_place<'a, T>(&mut self) where Self: Iterator<Item=&'a mut T> + DoubleEndedIterator, T: 'a

fn sum<S = Self::Item>(self) -> S where S: Add<Self::Item, Output=S> + Zero

fn product<P = Self::Item>(self) -> P where P: Mul<Self::Item, Output=P> + One