Module client
Available on crate features
http and std and ws only.Expand description
WebSocket client types and utilities
Modules§
- websocket_
builder_ mode - WebSocket request-builder execution modes.
Structs§
- Accepted
WebSocket Data - Blocking
Client WebSocket - A connected blocking client WebSocket and its HTTP handshake metadata.
- Client
WebSocket ClientWebSocket, used as input-output stream.- Handshake
Request - Request data to be used by an http client to initiate an http request.
- Negotiated
Handshake Request - Intermediate websocket handshake created by
WebSocketRequestBuilder::initiate_handshake. - WebSocket
Request Builder - Builder that can be used by clients to initiate the WebSocket handshake.
- With
Service WebSocketRequestBuilderinner wrapper type used for a builder, which includes a service, and thus is there to actually send the request as well and even follow up.
Enums§
- Handshake
Error - Client error which can be triggered in case the handshake phase failed.
- Response
Validate Error - Client error which can be triggered in case the response validation failed
Traits§
- Blocking
Http Client WebSocket Ext - Extends a blocking HTTP client with WebSocket handshake builders.
- Http
Client WebSocket Ext - Extends an Http Client with high level features WebSocket features.
Functions§
- apply_
response_ data_ to_ base_ websocket_ config - Utility which can be used my Mitm proxies to update the base config of a client websocket config.
- validate_
http_ server_ response - Validate the “accept” response from the http server with whom the client is trying to establish a WebSocket connection.
Type Aliases§
- Blocking
WebSocket - A synchronous WebSocket over an upgraded HTTP transport driven by a Rama blocking runtime.
- Blocking
WebSocket Request Builder - A WebSocket request builder whose terminal handshake operations block the calling thread.