Safe Haskell	None
Language	Haskell2010

Database.Franz.Protocol

Synopsis

apiVersion :: ByteString
defaultPort :: PortNumber
type IndexName = ByteString
data FranzException
- = MalformedRequest !String
- | StreamNotFound !FilePath
- | IndexNotFound !IndexName ![IndexName]
- | InternalError !String
- | ClientError !String
data RequestType
- = AllItems
- | LastItem
data ItemRef
- = BySeqNum !Int
- | ByIndex !IndexName !Int
data Query = Query {
- reqStream :: !ByteString
- reqFrom :: !ItemRef
- reqTo :: !ItemRef
- reqType :: !RequestType
}
data RawRequest
- = RawRequest !ResponseId !Query
- | RawClean !ResponseId
type ResponseId = Int
data ResponseHeader
- = Response !ResponseId
- | ResponseWait !ResponseId
- | ResponseError !ResponseId !FranzException
data PayloadHeader = PayloadHeader !Int !Int !Int ![ByteString]

Documentation

apiVersion :: ByteString Source #

defaultPort :: PortNumber Source #

type IndexName = ByteString Source #

data FranzException Source #

Constructors

MalformedRequest !String
StreamNotFound !FilePath
IndexNotFound !IndexName ![IndexName]
InternalError !String
ClientError !String

Instances

Show FranzException Source #
Instance details Defined in Database.Franz.Protocol Methods showsPrec :: Int -> FranzException -> ShowS # show :: FranzException -> String # showList :: [FranzException] -> ShowS #
Generic FranzException Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep FranzException :: Type -> Type # Methods from :: FranzException -> Rep FranzException x # to :: Rep FranzException x -> FranzException #
Exception FranzException Source #
Instance details Defined in Database.Franz.Protocol Methods toException :: FranzException -> SomeException # fromException :: SomeException -> Maybe FranzException # displayException :: FranzException -> String #
Serialize FranzException Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter FranzException # get :: Get FranzException #
type Rep FranzException Source #
Instance details Defined in Database.Franz.Protocol type Rep FranzException = D1 (MetaData "FranzException" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) ((C1 (MetaCons "MalformedRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)) :+: C1 (MetaCons "StreamNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FilePath))) :+: (C1 (MetaCons "IndexNotFound" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [IndexName])) :+: (C1 (MetaCons "InternalError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)) :+: C1 (MetaCons "ClientError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)))))

data RequestType Source #

Constructors

AllItems
LastItem

Instances

Show RequestType Source #
Instance details Defined in Database.Franz.Protocol Methods showsPrec :: Int -> RequestType -> ShowS # show :: RequestType -> String # showList :: [RequestType] -> ShowS #
Generic RequestType Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep RequestType :: Type -> Type # Methods from :: RequestType -> Rep RequestType x # to :: Rep RequestType x -> RequestType #
Serialize RequestType Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter RequestType # get :: Get RequestType #
type Rep RequestType Source #
Instance details Defined in Database.Franz.Protocol type Rep RequestType = D1 (MetaData "RequestType" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) (C1 (MetaCons "AllItems" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "LastItem" PrefixI False) (U1 :: Type -> Type))

data ItemRef Source #

Constructors

BySeqNum !Int	sequential number
ByIndex !IndexName !Int	index name and value

Instances

Show ItemRef Source #
Instance details Defined in Database.Franz.Protocol Methods showsPrec :: Int -> ItemRef -> ShowS # show :: ItemRef -> String # showList :: [ItemRef] -> ShowS #
Generic ItemRef Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep ItemRef :: Type -> Type # Methods from :: ItemRef -> Rep ItemRef x # to :: Rep ItemRef x -> ItemRef #
Serialize ItemRef Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter ItemRef # get :: Get ItemRef #
type Rep ItemRef Source #
Instance details Defined in Database.Franz.Protocol type Rep ItemRef = D1 (MetaData "ItemRef" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) (C1 (MetaCons "BySeqNum" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: C1 (MetaCons "ByIndex" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndexName) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

data Query Source #

Constructors

Query
Fields reqStream :: !ByteString reqFrom :: !ItemRef name of the index to search reqTo :: !ItemRef name of the index to search reqType :: !RequestType

Instances

Show Query Source #
Instance details Defined in Database.Franz.Protocol Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
Generic Query Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep Query :: Type -> Type # Methods from :: Query -> Rep Query x # to :: Rep Query x -> Query #
Serialize Query Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter Query # get :: Get Query #
type Rep Query Source #
Instance details Defined in Database.Franz.Protocol type Rep Query = D1 (MetaData "Query" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) (C1 (MetaCons "Query" PrefixI True) ((S1 (MetaSel (Just "reqStream") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ByteString) :: S1 (MetaSel (Just "reqFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ItemRef)) :: (S1 (MetaSel (Just "reqTo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ItemRef) :*: S1 (MetaSel (Just "reqType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RequestType))))

data RawRequest Source #

Constructors

RawRequest !ResponseId !Query
RawClean !ResponseId

Instances

Generic RawRequest Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep RawRequest :: Type -> Type # Methods from :: RawRequest -> Rep RawRequest x # to :: Rep RawRequest x -> RawRequest #
Serialize RawRequest Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter RawRequest # get :: Get RawRequest #
type Rep RawRequest Source #
Instance details Defined in Database.Franz.Protocol type Rep RawRequest = D1 (MetaData "RawRequest" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) (C1 (MetaCons "RawRequest" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Query)) :+: C1 (MetaCons "RawClean" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseId)))

type ResponseId = Int Source #

data ResponseHeader Source #

Constructors

Response !ResponseId	response ID, number of streams; there are items satisfying the query
ResponseWait !ResponseId	response ID; requested elements are not available right now
ResponseError !ResponseId !FranzException	something went wrong

Instances

Show ResponseHeader Source #
Instance details Defined in Database.Franz.Protocol Methods showsPrec :: Int -> ResponseHeader -> ShowS # show :: ResponseHeader -> String # showList :: [ResponseHeader] -> ShowS #
Generic ResponseHeader Source #
Instance details Defined in Database.Franz.Protocol Associated Types type Rep ResponseHeader :: Type -> Type # Methods from :: ResponseHeader -> Rep ResponseHeader x # to :: Rep ResponseHeader x -> ResponseHeader #
Serialize ResponseHeader Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter ResponseHeader # get :: Get ResponseHeader #
type Rep ResponseHeader Source #
Instance details Defined in Database.Franz.Protocol type Rep ResponseHeader = D1 (MetaData "ResponseHeader" "Database.Franz.Protocol" "franz-0.3.0.1-4eG3N4JtDSvJ7a7VTycdfn" False) (C1 (MetaCons "Response" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseId)) :+: (C1 (MetaCons "ResponseWait" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseId)) :+: C1 (MetaCons "ResponseError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ResponseId) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FranzException))))

data PayloadHeader Source #

Initial seqno, final seqno, base offset, index names

Constructors

PayloadHeader !Int !Int !Int ![ByteString]

Instances

Serialize PayloadHeader Source #
Instance details Defined in Database.Franz.Protocol Methods put :: Putter PayloadHeader # get :: Get PayloadHeader #