Network.WebSockets.Json

Extras for working with websockets & JSON.

This module allows to write simple websocket clients following a request/response pattern over some JSON encoded data.

Documentation

sendJson :: forall m. MonadIO m => Connection -> Encoding -> m ()

Send some JSON encoding through the given connection.

receiveJson :: forall m a. (MonadThrow m, MonadIO m) => Connection -> (Value -> Parser a) -> m a

Synchronously receive some JSON-encoded bytes through the given connection.

Throws MalformedOrUnexpectedResponseException upon failure.

data MalformedOrUnexpectedResponseException

An exception thrown when failing to decode a JSON payload.

Constructors

MalformedOrUnexpectedResponse

Fields

• bytesReceived :: !ByteString

  Actual bytes received from the websocket

• errorPath :: !JSONPath

  JSON path at which the decoding error occured

• hint :: !String

  A explanation of what's going on.

Instances

Exception MalformedOrUnexpectedResponseException

Defined in Network.WebSockets.Json

Methods

toException :: MalformedOrUnexpectedResponseException -> SomeException

fromException :: SomeException -> Maybe MalformedOrUnexpectedResponseException

displayException :: MalformedOrUnexpectedResponseException -> String

Show MalformedOrUnexpectedResponseException

Defined in Network.WebSockets.Json

Methods

showsPrec :: Int -> MalformedOrUnexpectedResponseException -> ShowS

show :: MalformedOrUnexpectedResponseException -> String

showList :: [MalformedOrUnexpectedResponseException] -> ShowS