Struct ws_tool::simple::ClientConfig

pub struct ClientConfig {
    pub read_buf: usize,
    pub write_buf: usize,
    pub certs: Vec<PathBuf>,
    pub window: Option<WindowBit>,
    pub context_take_over: bool,
    pub extra_headers: HashMap<String, String>,
    pub set_socket_fn: Box<dyn FnMut(&TcpStream) -> Result<(), WsError>>,
}

client connection config

Fields

read_buf: usize

read buffer size

write_buf: usize

write buffer size

certs: Vec<PathBuf>

custom certification path

window: Option<WindowBit>

deflate window size, if none, deflate will be disabled

context_take_over: bool

enable/disable deflate context taker over parameter

extra_headers: HashMap<String, String>

extra header when perform websocket protocol handshake

set_socket_fn: Box<dyn FnMut(&TcpStream) -> Result<(), WsError>>

modified socket option after create tcp socket, this function will be applied before start tls session

Implementations

impl ClientConfig

pub fn buffered() -> Self

use default buffer size 8192

pub fn connect_with<C, F>( &mut self, uri: impl TryInto<Uri, Error = InvalidUri>, check_fn: F ) -> Result<C, WsError>

where F: FnMut(String, Response<()>, BufStream<SyncStream>) -> Result<C, WsError>,

perform websocket handshake, use custom codec

pub fn connect( &mut self, uri: impl TryInto<Uri, Error = InvalidUri> ) -> Result<DeflateCodec<BufStream<SyncStream>>, WsError>

perform websocket handshake

Trait Implementations

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.