MagicWormhole.Internal.WebSockets

Help interaction with websockets.

Documentation

data WebSocketEndpoint

Endpoint for a websocket connection.

Construct directly or with parseWebSocketEndpoint.

Constructors

WebSocketEndpoint Hostname Port Path

Instances

Eq WebSocketEndpoint

Methods

(==) :: WebSocketEndpoint -> WebSocketEndpoint -> Bool

(/=) :: WebSocketEndpoint -> WebSocketEndpoint -> Bool

Show WebSocketEndpoint

Methods

showsPrec :: Int -> WebSocketEndpoint -> ShowS

show :: WebSocketEndpoint -> String

showList :: [WebSocketEndpoint] -> ShowS

parseWebSocketEndpoint :: String -> Maybe WebSocketEndpoint

Parse a WebSocketEndpoint.

uriToWebSocketEndpoint :: URI -> Maybe WebSocketEndpoint

Turn a URI into a WebSocketEndpoint, if we can.

Requires that the URI has an authority (i.e. host & port). Discards information from scheme, query, and fragment.

type Hostname = String

Host name for a websocket endpoint. e.g. example.com.

type Port = Int

Port number for a websocket endpoint. e.g. 80

type Path = String

Path to a websocket endpoint. e.g. /v1/foo