Network.WebSockets.Connection

Documentation

data PendingConnection

A new client connected to the server. We haven't accepted the connection yet, though.

Constructors

PendingConnection

Fields

pendingOptions :: ConnectionOptions

Options, passed as-is to the Connection

pendingRequest :: RequestHead

Useful for e.g. inspecting the request path.

pendingOnAccept :: Connection -> IO ()

One-shot callback fired when a connection is accepted, i.e., *after* the accepting response is sent to the client.

pendingIn :: InputStream ByteString

Input stream

pendingOut :: OutputStream Builder

Output stream

acceptRequest :: PendingConnection -> IO Connection

rejectRequest :: PendingConnection -> ByteString -> IO ()

data Connection

Constructors

Connection

Fields

connectionOptions :: ConnectionOptions

connectionType :: ConnectionType

connectionProtocol :: Protocol

connectionIn :: InputStream Message

connectionOut :: OutputStream Message

data ConnectionOptions

Constructors

ConnectionOptions

Fields

connectionOnPong :: IO ()

defaultConnectionOptions :: ConnectionOptions

receive :: Connection -> IO Message

receiveDataMessage :: Connection -> IO DataMessage

Receive an application message. Automatically respond to control messages.

receiveData :: WebSocketsData a => Connection -> IO a

Receive a message, converting it to whatever format is needed.

send :: Connection -> Message -> IO ()

sendDataMessage :: Connection -> DataMessage -> IO ()

Send a DataMessage

sendTextData :: WebSocketsData a => Connection -> a -> IO ()

Send a message as text

sendBinaryData :: WebSocketsData a => Connection -> a -> IO ()

Send a message as binary data

sendClose :: WebSocketsData a => Connection -> a -> IO ()

Send a friendly close message

sendPing :: WebSocketsData a => Connection -> a -> IO ()

Send a ping