Miso.WebSocket

Types

data WebSocket action

WebSocket connection messages

Constructors

WebSocketMessage action

WebSocketClose CloseCode WasClean Reason

WebSocketOpen

WebSocketError MisoString

Instances

Eq action => Eq (WebSocket action)

Defined in Miso.WebSocket

Methods

(==) :: WebSocket action -> WebSocket action -> Bool

(/=) :: WebSocket action -> WebSocket action -> Bool

Show action => Show (WebSocket action)

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> WebSocket action -> ShowS

show :: WebSocket action -> String

showList :: [WebSocket action] -> ShowS

newtype URL

URL of Websocket server

Constructors

URL MisoString

Instances

Eq URL

Defined in Miso.WebSocket

Methods

(==) :: URL -> URL -> Bool

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

Show URL

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> URL -> ShowS

show :: URL -> String

showList :: [URL] -> ShowS

newtype Protocols

Protocols for Websocket connection

Constructors

Protocols [MisoString]

Instances

Eq Protocols

Defined in Miso.WebSocket

Methods

(==) :: Protocols -> Protocols -> Bool

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

Show Protocols

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> Protocols -> ShowS

show :: Protocols -> String

showList :: [Protocols] -> ShowS

data SocketState

SocketState corresponding to current WebSocket connection

Constructors

CONNECTING

0

OPEN

1

CLOSING

2

CLOSED

3

Instances

Enum SocketState

Defined in Miso.WebSocket

Methods

succ :: SocketState -> SocketState

pred :: SocketState -> SocketState

toEnum :: Int -> SocketState

fromEnum :: SocketState -> Int

enumFrom :: SocketState -> [SocketState]

enumFromThen :: SocketState -> SocketState -> [SocketState]

enumFromTo :: SocketState -> SocketState -> [SocketState]

enumFromThenTo :: SocketState -> SocketState -> SocketState -> [SocketState]

Eq SocketState

Defined in Miso.WebSocket

Methods

(==) :: SocketState -> SocketState -> Bool

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

Ord SocketState

Defined in Miso.WebSocket

Methods

compare :: SocketState -> SocketState -> Ordering

(<) :: SocketState -> SocketState -> Bool

(<=) :: SocketState -> SocketState -> Bool

(>) :: SocketState -> SocketState -> Bool

(>=) :: SocketState -> SocketState -> Bool

max :: SocketState -> SocketState -> SocketState

min :: SocketState -> SocketState -> SocketState

Show SocketState

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> SocketState -> ShowS

show :: SocketState -> String

showList :: [SocketState] -> ShowS

data CloseCode

Code corresponding to a closed connection https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent

Constructors

CLOSE_NORMAL

1000, Normal closure; the connection successfully completed whatever purpose for which it was created.

CLOSE_GOING_AWAY

1001, The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.

CLOSE_PROTOCOL_ERROR

1002, The endpoint is terminating the connection due to a protocol error.

CLOSE_UNSUPPORTED

1003, The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a textonly endpoint received binary data).

CLOSE_NO_STATUS

1005, Reserved. Indicates that no status code was provided even though one was expected.

CLOSE_ABNORMAL

1006, Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.

Unsupported_Data

1007, The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., nonUTF8 data within a text message).

Policy_Violation

1008, The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.

CLOSE_TOO_LARGE

1009, The endpoint is terminating the connection because a data frame was received that is too large.

Missing_Extension

1010, The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.

Internal_Error

1011, The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.

Service_Restart

1012, The server is terminating the connection because it is restarting.

Try_Again_Later

1013, The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients.

TLS_Handshake

1015, Reserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).

OtherCode Int

OtherCode that is reserved and not in the range 0999

Instances

Eq CloseCode

Defined in Miso.WebSocket

Methods

(==) :: CloseCode -> CloseCode -> Bool

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

Show CloseCode

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> CloseCode -> ShowS

show :: CloseCode -> String

showList :: [CloseCode] -> ShowS

Generic CloseCode

Defined in Miso.WebSocket

Associated Types

type Rep CloseCode :: Type -> Type

Methods

from :: CloseCode -> Rep CloseCode x

to :: Rep CloseCode x -> CloseCode

type Rep CloseCode

Defined in Miso.WebSocket

type Rep CloseCode = D1 (MetaData "CloseCode" "Miso.WebSocket" "miso-1.2.0.0-8WfDR0qmtJ3HUVt5rkWEps" False) (((C1 (MetaCons "CLOSE_NORMAL" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "CLOSE_GOING_AWAY" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CLOSE_PROTOCOL_ERROR" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "CLOSE_UNSUPPORTED" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CLOSE_NO_STATUS" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "CLOSE_ABNORMAL" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Unsupported_Data" PrefixI False) (U1 :: Type -> Type)))) :+: (((C1 (MetaCons "Policy_Violation" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CLOSE_TOO_LARGE" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Missing_Extension" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Internal_Error" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "Service_Restart" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Try_Again_Later" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "TLS_Handshake" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "OtherCode" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))))

newtype WasClean

Wether or not the connection closed was done so cleanly

Constructors

WasClean Bool

Instances

Eq WasClean

Defined in Miso.WebSocket

Methods

(==) :: WasClean -> WasClean -> Bool

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

Show WasClean

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> WasClean -> ShowS

show :: WasClean -> String

showList :: [WasClean] -> ShowS

newtype Reason

Reason for closed connection

Constructors

Reason MisoString

Instances

Eq Reason

Defined in Miso.WebSocket

Methods

(==) :: Reason -> Reason -> Bool

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

Show Reason

Defined in Miso.WebSocket

Methods

showsPrec :: Int -> Reason -> ShowS

show :: Reason -> String

showList :: [Reason] -> ShowS