You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
80 lines
2.8 KiB
80 lines
2.8 KiB
//! Methods to accept an incoming WebSocket connection on a server.
|
|
|
|
pub use crate::handshake::server::ServerHandshake;
|
|
|
|
use crate::handshake::server::{Callback, NoCallback};
|
|
use crate::handshake::HandshakeError;
|
|
|
|
use crate::protocol::{WebSocket, WebSocketConfig};
|
|
|
|
use crate::extensions::uncompressed::UncompressedExt;
|
|
use crate::extensions::WebSocketExtension;
|
|
use std::io::{Read, Write};
|
|
|
|
/// Accept the given Stream as a WebSocket.
|
|
///
|
|
/// Uses a configuration provided as an argument. Calling it with `None` will use the default one
|
|
/// used by `accept()`.
|
|
///
|
|
/// This function starts a server WebSocket handshake over the given stream.
|
|
/// If you want TLS support, use `native_tls::TlsStream` or `openssl::ssl::SslStream`
|
|
/// for the stream here. Any `Read + Write` streams are supported, including
|
|
/// those from `Mio` and others.
|
|
pub fn accept_with_config<Stream, Ext>(
|
|
stream: Stream,
|
|
config: Option<WebSocketConfig<Ext>>,
|
|
) -> Result<WebSocket<Stream, Ext>, HandshakeError<ServerHandshake<Stream, NoCallback, Ext>>>
|
|
where
|
|
Stream: Read + Write,
|
|
Ext: WebSocketExtension,
|
|
{
|
|
accept_hdr_with_config(stream, NoCallback, config)
|
|
}
|
|
|
|
/// Accept the given Stream as a WebSocket.
|
|
///
|
|
/// This function starts a server WebSocket handshake over the given stream.
|
|
/// If you want TLS support, use `native_tls::TlsStream` or `openssl::ssl::SslStream`
|
|
/// for the stream here. Any `Read + Write` streams are supported, including
|
|
/// those from `Mio` and others.
|
|
pub fn accept<S: Read + Write>(
|
|
stream: S,
|
|
) -> Result<
|
|
WebSocket<S, UncompressedExt>,
|
|
HandshakeError<ServerHandshake<S, NoCallback, UncompressedExt>>,
|
|
> {
|
|
accept_with_config(stream, None)
|
|
}
|
|
|
|
/// Accept the given Stream as a WebSocket.
|
|
///
|
|
/// Uses a configuration provided as an argument. Calling it with `None` will use the default one
|
|
/// used by `accept_hdr()`.
|
|
///
|
|
/// This function does the same as `accept()` but accepts an extra callback
|
|
/// for header processing. The callback receives headers of the incoming
|
|
/// requests and is able to add extra headers to the reply.
|
|
pub fn accept_hdr_with_config<S, C, Ext>(
|
|
stream: S,
|
|
callback: C,
|
|
config: Option<WebSocketConfig<Ext>>,
|
|
) -> Result<WebSocket<S, Ext>, HandshakeError<ServerHandshake<S, C, Ext>>>
|
|
where
|
|
S: Read + Write,
|
|
C: Callback,
|
|
Ext: WebSocketExtension,
|
|
{
|
|
ServerHandshake::start(stream, callback, config).handshake()
|
|
}
|
|
|
|
/// Accept the given Stream as a WebSocket.
|
|
///
|
|
/// This function does the same as `accept()` but accepts an extra callback
|
|
/// for header processing. The callback receives headers of the incoming
|
|
/// requests and is able to add extra headers to the reply.
|
|
pub fn accept_hdr<S: Read + Write, C: Callback>(
|
|
stream: S,
|
|
callback: C,
|
|
) -> Result<WebSocket<S, UncompressedExt>, HandshakeError<ServerHandshake<S, C, UncompressedExt>>> {
|
|
accept_hdr_with_config(stream, callback, None)
|
|
}
|
|
|