Safe Haskell	None
Language	Haskell98

JavaScript.Web.WebSocket

Synopsis

data WebSocket
data WebSocketRequest = WebSocketRequest {
- url :: JSString
- protocols :: [JSString]
- onClose :: Maybe (CloseEvent -> IO ())
- onMessage :: Maybe (MessageEvent -> IO ())
}
data ReadyState
- = Connecting
- | Open
- | Closing
- | Closed
data BinaryType
- = Blob
- | ArrayBuffer
connect :: WebSocketRequest -> IO WebSocket
close :: Maybe Int -> Maybe JSString -> WebSocket -> IO ()
send :: JSString -> WebSocket -> IO ()
sendArrayBuffer :: ArrayBuffer -> WebSocket -> IO ()
sendBlob :: Blob -> WebSocket -> IO ()
getBufferedAmount :: WebSocket -> IO Int
getExtensions :: WebSocket -> IO JSString
getProtocol :: WebSocket -> IO JSString
getReadyState :: WebSocket -> IO ReadyState
getBinaryType :: WebSocket -> IO BinaryType
setBinaryType :: BinaryType -> WebSocket -> IO ()
getUrl :: WebSocket -> JSString

Documentation

data WebSocket Source #

data WebSocketRequest Source #

Constructors

WebSocketRequest
Fields url :: JSString protocols :: [JSString] onClose :: Maybe (CloseEvent -> IO ()) called when the connection closes (at most once) onMessage :: Maybe (MessageEvent -> IO ()) called for each message

data ReadyState Source #

Constructors

Connecting
Open
Closing
Closed

Instances

Enum ReadyState Source #
Instance details Defined in JavaScript.Web.WebSocket Methods succ :: ReadyState -> ReadyState # pred :: ReadyState -> ReadyState # toEnum :: Int -> ReadyState # fromEnum :: ReadyState -> Int # enumFrom :: ReadyState -> [ReadyState] # enumFromThen :: ReadyState -> ReadyState -> [ReadyState] # enumFromTo :: ReadyState -> ReadyState -> [ReadyState] # enumFromThenTo :: ReadyState -> ReadyState -> ReadyState -> [ReadyState] #
Eq ReadyState Source #
Instance details Defined in JavaScript.Web.WebSocket Methods (==) :: ReadyState -> ReadyState -> Bool # (/=) :: ReadyState -> ReadyState -> Bool #
Data ReadyState Source #
Instance details Defined in JavaScript.Web.WebSocket Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ReadyState -> c ReadyState gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ReadyState toConstr :: ReadyState -> Constr dataTypeOf :: ReadyState -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ReadyState) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ReadyState) gmapT :: (forall b. Data b => b -> b) -> ReadyState -> ReadyState gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ReadyState -> r gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ReadyState -> r gmapQ :: (forall d. Data d => d -> u) -> ReadyState -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> ReadyState -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> ReadyState -> m ReadyState gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadyState -> m ReadyState gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ReadyState -> m ReadyState
Ord ReadyState Source #
Instance details Defined in JavaScript.Web.WebSocket Methods compare :: ReadyState -> ReadyState -> Ordering # (<) :: ReadyState -> ReadyState -> Bool # (<=) :: ReadyState -> ReadyState -> Bool # (>) :: ReadyState -> ReadyState -> Bool # (>=) :: ReadyState -> ReadyState -> Bool # max :: ReadyState -> ReadyState -> ReadyState # min :: ReadyState -> ReadyState -> ReadyState #
Show ReadyState Source #
Instance details Defined in JavaScript.Web.WebSocket Methods showsPrec :: Int -> ReadyState -> ShowS # show :: ReadyState -> String # showList :: [ReadyState] -> ShowS #

data BinaryType Source #

Constructors

Blob
ArrayBuffer

Instances

Enum BinaryType Source #
Instance details Defined in JavaScript.Web.WebSocket Methods succ :: BinaryType -> BinaryType # pred :: BinaryType -> BinaryType # toEnum :: Int -> BinaryType # fromEnum :: BinaryType -> Int # enumFrom :: BinaryType -> [BinaryType] # enumFromThen :: BinaryType -> BinaryType -> [BinaryType] # enumFromTo :: BinaryType -> BinaryType -> [BinaryType] # enumFromThenTo :: BinaryType -> BinaryType -> BinaryType -> [BinaryType] #
Eq BinaryType Source #
Instance details Defined in JavaScript.Web.WebSocket Methods (==) :: BinaryType -> BinaryType -> Bool # (/=) :: BinaryType -> BinaryType -> Bool #
Data BinaryType Source #
Instance details Defined in JavaScript.Web.WebSocket Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BinaryType -> c BinaryType gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BinaryType toConstr :: BinaryType -> Constr dataTypeOf :: BinaryType -> DataType dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BinaryType) dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BinaryType) gmapT :: (forall b. Data b => b -> b) -> BinaryType -> BinaryType gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BinaryType -> r gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BinaryType -> r gmapQ :: (forall d. Data d => d -> u) -> BinaryType -> [u] gmapQi :: Int -> (forall d. Data d => d -> u) -> BinaryType -> u gmapM :: Monad m => (forall d. Data d => d -> m d) -> BinaryType -> m BinaryType gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BinaryType -> m BinaryType gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BinaryType -> m BinaryType
Ord BinaryType Source #
Instance details Defined in JavaScript.Web.WebSocket Methods compare :: BinaryType -> BinaryType -> Ordering # (<) :: BinaryType -> BinaryType -> Bool # (<=) :: BinaryType -> BinaryType -> Bool # (>) :: BinaryType -> BinaryType -> Bool # (>=) :: BinaryType -> BinaryType -> Bool # max :: BinaryType -> BinaryType -> BinaryType # min :: BinaryType -> BinaryType -> BinaryType #
Show BinaryType Source #
Instance details Defined in JavaScript.Web.WebSocket Methods showsPrec :: Int -> BinaryType -> ShowS # show :: BinaryType -> String # showList :: [BinaryType] -> ShowS #

connect :: WebSocketRequest -> IO WebSocket Source #

create a WebSocket

close :: Maybe Int -> Maybe JSString -> WebSocket -> IO () Source #

close a websocket and release the callbacks

send :: JSString -> WebSocket -> IO () Source #

sendArrayBuffer :: ArrayBuffer -> WebSocket -> IO () Source #

sendBlob :: Blob -> WebSocket -> IO () Source #

getBufferedAmount :: WebSocket -> IO Int Source #

getExtensions :: WebSocket -> IO JSString Source #

getProtocol :: WebSocket -> IO JSString Source #

getReadyState :: WebSocket -> IO ReadyState Source #

getBinaryType :: WebSocket -> IO BinaryType Source #

setBinaryType :: BinaryType -> WebSocket -> IO () Source #

getUrl :: WebSocket -> JSString Source #