Web.Dependencies.Sparrow.Types

Conceptual

Server

data ServerArgs m deltaOut

Constructors

ServerArgs

Fields

• serverDeltaReject :: m ()
• serverSendCurrent :: deltaOut -> m ()

data ServerReturn m f initOut deltaIn deltaOut

Constructors

ServerReturn

Fields

• serverInitOut :: initOut
• serverOnOpen :: ServerArgs m deltaOut -> m (TVar (f (Async ())))

  invoked once, and should return a linked long-lived thread to kill when the subscription dies

• serverOnReceive :: ServerArgs m deltaOut -> deltaIn -> m ()

  invoked for each receive

data ServerContinue m f initOut deltaIn deltaOut

Constructors

ServerContinue

Fields

• serverContinue :: Broadcast m -> m (ServerReturn m f initOut deltaIn deltaOut)
• serverOnUnsubscribe :: m ()

type Server m f initIn initOut deltaIn deltaOut = initIn -> m (Maybe (ServerContinue m f initOut deltaIn deltaOut))

staticServer

Arguments

:: MonadIO m

=> Alternative f

=> (initIn -> m (Maybe initOut))

Produce an initOut

-> Server m f initIn initOut JSONVoid JSONVoid

Client

data ClientReturn m initOut deltaIn

Constructors

ClientReturn

Fields

• clientSendCurrent :: deltaIn -> m ()
• clientInitOut :: initOut
• clientUnsubscribe :: m ()

data ClientArgs m initIn initOut deltaIn deltaOut

Constructors

ClientArgs

Fields

• clientReceive :: ClientReturn m initOut deltaIn -> deltaOut -> m ()
• clientInitIn :: initIn
• clientOnReject :: m ()

  Run if the server decides to randomly kick the client

type Client m initIn initOut deltaIn deltaOut = (ClientArgs m initIn initOut deltaIn deltaOut -> m (Maybe (ClientReturn m initOut deltaIn))) -> m ()

staticClient

Arguments

:: Monad m

=> ((initIn -> m (Maybe initOut)) -> m ())

Obtain an initOut

-> Client m initIn initOut JSONVoid JSONVoid

Topic

newtype Topic

Constructors

Topic

Fields

• getTopic :: [Text]

Instances

Eq Topic

Methods

(==) :: Topic -> Topic -> Bool

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

Ord Topic

Methods

compare :: Topic -> Topic -> Ordering

(<) :: Topic -> Topic -> Bool

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

(>) :: Topic -> Topic -> Bool

(>=) :: Topic -> Topic -> Bool

max :: Topic -> Topic -> Topic

min :: Topic -> Topic -> Topic

Show Topic

Methods

showsPrec :: Int -> Topic -> ShowS

show :: Topic -> String

showList :: [Topic] -> ShowS

Generic Topic

Associated Types

type Rep Topic :: * -> *

Methods

from :: Topic -> Rep Topic x

to :: Rep Topic x -> Topic

ToJSON Topic

Methods

toJSON :: Topic -> Value

toEncoding :: Topic -> Encoding

FromJSON Topic

Methods

parseJSON :: Value -> Parser Topic

NFData Topic

Methods

rnf :: Topic -> ()

Hashable Topic

Methods

hashWithSalt :: Int -> Topic -> Int

hash :: Topic -> Int

type Rep Topic

type Rep Topic = D1 * (MetaData "Topic" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" True) (C1 * (MetaCons "Topic" PrefixI True) (S1 * (MetaSel (Just Symbol "getTopic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Text])))

Broadcast

type Broadcast m = Topic -> m (Maybe (Value -> Maybe (m ())))

JSON Encodings

data JSONVoid

Instances

ToJSON JSONVoid

Methods

toJSON :: JSONVoid -> Value

toEncoding :: JSONVoid -> Encoding

FromJSON JSONVoid

Methods

parseJSON :: Value -> Parser JSONVoid

data WithSessionID a

Constructors

WithSessionID

Fields

• withSessionIDSessionID :: !SessionID
• withSessionIDContent :: a

Instances

Eq a => Eq (WithSessionID a)

Methods

(==) :: WithSessionID a -> WithSessionID a -> Bool

(/=) :: WithSessionID a -> WithSessionID a -> Bool

Show a => Show (WithSessionID a)

Methods

showsPrec :: Int -> WithSessionID a -> ShowS

show :: WithSessionID a -> String

showList :: [WithSessionID a] -> ShowS

Generic (WithSessionID a)

Associated Types

type Rep (WithSessionID a) :: * -> *

Methods

from :: WithSessionID a -> Rep (WithSessionID a) x

to :: Rep (WithSessionID a) x -> WithSessionID a

ToJSON a => ToJSON (WithSessionID a)

Methods

toJSON :: WithSessionID a -> Value

toEncoding :: WithSessionID a -> Encoding

FromJSON a => FromJSON (WithSessionID a)

Methods

parseJSON :: Value -> Parser (WithSessionID a)

NFData a => NFData (WithSessionID a)

Methods

rnf :: WithSessionID a -> ()

type Rep (WithSessionID a)

type Rep (WithSessionID a) = D1 * (MetaData "WithSessionID" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) (C1 * (MetaCons "WithSessionID" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "withSessionIDSessionID") SourceUnpack SourceStrict DecidedStrict) (Rec0 * SessionID)) (S1 * (MetaSel (Just Symbol "withSessionIDContent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a))))

data WithTopic a

Constructors

WithTopic

Fields

• withTopicTopic :: !Topic
• withTopicContent :: a

Instances

Eq a => Eq (WithTopic a)

Methods

(==) :: WithTopic a -> WithTopic a -> Bool

(/=) :: WithTopic a -> WithTopic a -> Bool

Show a => Show (WithTopic a)

Methods

showsPrec :: Int -> WithTopic a -> ShowS

show :: WithTopic a -> String

showList :: [WithTopic a] -> ShowS

Generic (WithTopic a)

Associated Types

type Rep (WithTopic a) :: * -> *

Methods

from :: WithTopic a -> Rep (WithTopic a) x

to :: Rep (WithTopic a) x -> WithTopic a

ToJSON a => ToJSON (WithTopic a)

Methods

toJSON :: WithTopic a -> Value

toEncoding :: WithTopic a -> Encoding

FromJSON a => FromJSON (WithTopic a)

Methods

parseJSON :: Value -> Parser (WithTopic a)

NFData a => NFData (WithTopic a)

Methods

rnf :: WithTopic a -> ()

type Rep (WithTopic a)

type Rep (WithTopic a) = D1 * (MetaData "WithTopic" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) (C1 * (MetaCons "WithTopic" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "withTopicTopic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Topic)) (S1 * (MetaSel (Just Symbol "withTopicContent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a))))

data InitResponse a

Constructors

InitBadEncoding !ByteString

InitDecodingError !String

InitRejected

InitResponse a

Instances

Eq a => Eq (InitResponse a)

Methods

(==) :: InitResponse a -> InitResponse a -> Bool

(/=) :: InitResponse a -> InitResponse a -> Bool

Show a => Show (InitResponse a)

Methods

showsPrec :: Int -> InitResponse a -> ShowS

show :: InitResponse a -> String

showList :: [InitResponse a] -> ShowS

Generic (InitResponse a)

Associated Types

type Rep (InitResponse a) :: * -> *

Methods

from :: InitResponse a -> Rep (InitResponse a) x

to :: Rep (InitResponse a) x -> InitResponse a

ToJSON a => ToJSON (InitResponse a)

Methods

toJSON :: InitResponse a -> Value

toEncoding :: InitResponse a -> Encoding

FromJSON a => FromJSON (InitResponse a)

Methods

parseJSON :: Value -> Parser (InitResponse a)

NFData a => NFData (InitResponse a)

Methods

rnf :: InitResponse a -> ()

type Rep (InitResponse a)

type Rep (InitResponse a) = D1 * (MetaData "InitResponse" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) ((:+:) * ((:+:) * (C1 * (MetaCons "InitBadEncoding" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ByteString))) (C1 * (MetaCons "InitDecodingError" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * String)))) ((:+:) * (C1 * (MetaCons "InitRejected" PrefixI False) (U1 *)) (C1 * (MetaCons "InitResponse" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a)))))

data WSHTTPResponse

Constructors

NoSessionID

Instances

Eq WSHTTPResponse

Methods

(==) :: WSHTTPResponse -> WSHTTPResponse -> Bool

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

Show WSHTTPResponse

Methods

showsPrec :: Int -> WSHTTPResponse -> ShowS

show :: WSHTTPResponse -> String

showList :: [WSHTTPResponse] -> ShowS

Generic WSHTTPResponse

Associated Types

type Rep WSHTTPResponse :: * -> *

Methods

from :: WSHTTPResponse -> Rep WSHTTPResponse x

to :: Rep WSHTTPResponse x -> WSHTTPResponse

ToJSON WSHTTPResponse

Methods

toJSON :: WSHTTPResponse -> Value

toEncoding :: WSHTTPResponse -> Encoding

FromJSON WSHTTPResponse

Methods

parseJSON :: Value -> Parser WSHTTPResponse

NFData WSHTTPResponse

Methods

rnf :: WSHTTPResponse -> ()

type Rep WSHTTPResponse

type Rep WSHTTPResponse = D1 * (MetaData "WSHTTPResponse" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) (C1 * (MetaCons "NoSessionID" PrefixI False) (U1 *))

data WSIncoming a

Constructors

WSUnsubscribe

Fields

• wsUnsubscribeTopic :: !Topic

WSIncoming a

Instances

Eq a => Eq (WSIncoming a)

Methods

(==) :: WSIncoming a -> WSIncoming a -> Bool

(/=) :: WSIncoming a -> WSIncoming a -> Bool

Show a => Show (WSIncoming a)

Methods

showsPrec :: Int -> WSIncoming a -> ShowS

show :: WSIncoming a -> String

showList :: [WSIncoming a] -> ShowS

Generic (WSIncoming a)

Associated Types

type Rep (WSIncoming a) :: * -> *

Methods

from :: WSIncoming a -> Rep (WSIncoming a) x

to :: Rep (WSIncoming a) x -> WSIncoming a

ToJSON a => ToJSON (WSIncoming a)

Methods

toJSON :: WSIncoming a -> Value

toEncoding :: WSIncoming a -> Encoding

FromJSON a => FromJSON (WSIncoming a)

Methods

parseJSON :: Value -> Parser (WSIncoming a)

NFData a => NFData (WSIncoming a)

Methods

rnf :: WSIncoming a -> ()

type Rep (WSIncoming a)

type Rep (WSIncoming a) = D1 * (MetaData "WSIncoming" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) ((:+:) * (C1 * (MetaCons "WSUnsubscribe" PrefixI True) (S1 * (MetaSel (Just Symbol "wsUnsubscribeTopic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Topic))) (C1 * (MetaCons "WSIncoming" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a))))

data WSOutgoing a

Constructors

WSTopicsSubscribed [Topic]

WSTopicAdded !Topic

WSTopicRemoved !Topic

WSTopicRejected !Topic

WSDecodingError !String

WSOutgoing a

Instances

Eq a => Eq (WSOutgoing a)

Methods

(==) :: WSOutgoing a -> WSOutgoing a -> Bool

(/=) :: WSOutgoing a -> WSOutgoing a -> Bool

Show a => Show (WSOutgoing a)

Methods

showsPrec :: Int -> WSOutgoing a -> ShowS

show :: WSOutgoing a -> String

showList :: [WSOutgoing a] -> ShowS

Generic (WSOutgoing a)

Associated Types

type Rep (WSOutgoing a) :: * -> *

Methods

from :: WSOutgoing a -> Rep (WSOutgoing a) x

to :: Rep (WSOutgoing a) x -> WSOutgoing a

ToJSON a => ToJSON (WSOutgoing a)

Methods

toJSON :: WSOutgoing a -> Value

toEncoding :: WSOutgoing a -> Encoding

FromJSON a => FromJSON (WSOutgoing a)

Methods

parseJSON :: Value -> Parser (WSOutgoing a)

NFData a => NFData (WSOutgoing a)

Methods

rnf :: WSOutgoing a -> ()

type Rep (WSOutgoing a)

type Rep (WSOutgoing a) = D1 * (MetaData "WSOutgoing" "Web.Dependencies.Sparrow.Types" "sparrow-0.0.2.0-D7ZuxEzWFiGJDCRXDtTnOR" False) ((:+:) * ((:+:) * (C1 * (MetaCons "WSTopicsSubscribed" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Topic]))) ((:+:) * (C1 * (MetaCons "WSTopicAdded" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Topic))) (C1 * (MetaCons "WSTopicRemoved" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Topic))))) ((:+:) * (C1 * (MetaCons "WSTopicRejected" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Topic))) ((:+:) * (C1 * (MetaCons "WSDecodingError" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * String))) (C1 * (MetaCons "WSOutgoing" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * a))))))