Enum HttpServerRequest 

pub enum HttpServerRequest {
    Http(IncomingHttpRequest),
    WebSocketOpen {
        path: String,
        channel_id: u32,
        source_socket_addr: Option<String>,
        forwarded_for: Option<String>,
    },
    WebSocketPush {
        channel_id: u32,
        message_type: WsMessageType,
    },
    WebSocketClose(u32),
}

crate::Request received from the http-server:distro:sys service as a result of either an HTTP or WebSocket binding, created via HttpServerAction.

Variants

Http(IncomingHttpRequest)

WebSocketOpen

Processes will receive this kind of request when a client connects to them. If a process does not want this websocket open, they should issue a crate::Request containing a HttpServerAction::WebSocketClose message and this channel ID.

Fields

path: String

channel_id: u32

source_socket_addr: Option<String>

forwarded_for: Option<String>

IP address from proxy headers (X-Forwarded-For, X-Real-IP, Cf-Connecting-Ip)

WebSocketPush

Processes can both SEND and RECEIVE this kind of crate::Request (send as HttpServerAction::WebSocketPush). When received, will contain the message bytes as crate::LazyLoadBlob.

Fields

channel_id: u32

message_type: WsMessageType

WebSocketClose(u32)

Receiving will indicate that the client closed the socket. Can be sent to close from the server-side, as HttpServerAction::WebSocketClose.

Implementations

impl HttpServerRequest

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Parse a byte slice into an HttpServerRequest.

pub fn request(self) -> Option<IncomingHttpRequest>

Filter the general-purpose HttpServerRequest, which contains HTTP requests and WebSocket messages, into just the HTTP request. Consumes the original request and returns None if the request was WebSocket-related.

Trait Implementations

impl Clone for HttpServerRequest

fn clone(&self) -> HttpServerRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpServerRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpServerRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HttpServerRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.