Struct WebSocketTunnelServer 

pub struct WebSocketTunnelServer { /* private fields */ }

Implementations

impl WebSocketTunnelServer

pub fn new(max_message_size: usize) -> Self

pub fn with_default_config() -> Self

pub async fn accept_upgrade( &self, stream: TcpStream, ) -> Result<BoxStream, WebSocketError>

Accept a WebSocket tunnel upgrade.

Security

The handshake does not validate the Origin header. This is correct for non-browser proxy tunnel usage; do not expose these endpoints to web browsers, where ignoring Origin permits cross-site WebSocket hijacking.

pub async fn accept_upgrade_over_stream<S>( &self, stream: S, ) -> Result<BoxStream, WebSocketError>

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

pub async fn accept_upgrade_with_config( &self, stream: TcpStream, config: WebSocketConfig, ) -> Result<BoxStream, WebSocketError>

pub async fn accept_upgrade_with_config_over_stream<S>( &self, stream: S, config: WebSocketConfig, ) -> Result<BoxStream, WebSocketError>

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,