Database.Franz.Internal.Protocol

Documentation

apiVersion :: ByteString

defaultPort :: PortNumber

type IndexName = ByteString

newtype StreamName

Constructors

StreamName

Fields

• unStreamName :: ByteString

Instances

Eq StreamName

Defined in Database.Franz.Internal.Protocol

Methods

(==) :: StreamName -> StreamName -> Bool

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

Ord StreamName

Defined in Database.Franz.Internal.Protocol

Methods

compare :: StreamName -> StreamName -> Ordering

(<) :: StreamName -> StreamName -> Bool

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

(>) :: StreamName -> StreamName -> Bool

(>=) :: StreamName -> StreamName -> Bool

max :: StreamName -> StreamName -> StreamName

min :: StreamName -> StreamName -> StreamName

Show StreamName

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> StreamName -> ShowS

show :: StreamName -> String

showList :: [StreamName] -> ShowS

IsString StreamName

UTF-8 encoded

Defined in Database.Franz.Internal.Protocol

Methods

fromString :: String -> StreamName

Serialize StreamName

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter StreamName

get :: Get StreamName

Hashable StreamName

Defined in Database.Franz.Internal.Protocol

Methods

hashWithSalt :: Int -> StreamName -> Int

hash :: StreamName -> Int

streamNameToPath :: StreamName -> FilePath

data FranzException

Constructors

MalformedRequest !String

StreamNotFound !FilePath

IndexNotFound !IndexName ![IndexName]

InternalError !String

ClientError !String

Instances

Show FranzException

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> FranzException -> ShowS

show :: FranzException -> String

showList :: [FranzException] -> ShowS

Generic FranzException

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep FranzException :: Type -> Type

Methods

from :: FranzException -> Rep FranzException x

to :: Rep FranzException x -> FranzException

Exception FranzException

Defined in Database.Franz.Internal.Protocol

Methods

toException :: FranzException -> SomeException

fromException :: SomeException -> Maybe FranzException

displayException :: FranzException -> String

Serialize FranzException

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter FranzException

get :: Get FranzException

type Rep FranzException

Defined in Database.Franz.Internal.Protocol

type Rep FranzException = D1 ('MetaData "FranzException" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" '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

Constructors

AllItems

LastItem

FirstItem

Instances

Eq RequestType

Defined in Database.Franz.Internal.Protocol

Methods

(==) :: RequestType -> RequestType -> Bool

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

Show RequestType

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> RequestType -> ShowS

show :: RequestType -> String

showList :: [RequestType] -> ShowS

Generic RequestType

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep RequestType :: Type -> Type

Methods

from :: RequestType -> Rep RequestType x

to :: Rep RequestType x -> RequestType

Serialize RequestType

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter RequestType

get :: Get RequestType

type Rep RequestType

Defined in Database.Franz.Internal.Protocol

type Rep RequestType = D1 ('MetaData "RequestType" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" 'False) (C1 ('MetaCons "AllItems" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LastItem" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FirstItem" 'PrefixI 'False) (U1 :: Type -> Type)))

data ItemRef

Constructors

BySeqNum !Int

sequential number

ByIndex !IndexName !Int

index name and value

Instances

Eq ItemRef

Defined in Database.Franz.Internal.Protocol

Methods

(==) :: ItemRef -> ItemRef -> Bool

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

Show ItemRef

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> ItemRef -> ShowS

show :: ItemRef -> String

showList :: [ItemRef] -> ShowS

Generic ItemRef

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep ItemRef :: Type -> Type

Methods

from :: ItemRef -> Rep ItemRef x

to :: Rep ItemRef x -> ItemRef

Serialize ItemRef

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter ItemRef

get :: Get ItemRef

type Rep ItemRef

Defined in Database.Franz.Internal.Protocol

type Rep ItemRef = D1 ('MetaData "ItemRef" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" '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

Constructors

Query

Fields

• reqStream :: !StreamName
• reqFrom :: !ItemRef

  name of the index to search

• reqTo :: !ItemRef

  name of the index to search

• reqType :: !RequestType

Instances

Eq Query

Defined in Database.Franz.Internal.Protocol

Methods

(==) :: Query -> Query -> Bool

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

Show Query

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

Generic Query

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep Query :: Type -> Type

Methods

from :: Query -> Rep Query x

to :: Rep Query x -> Query

Serialize Query

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter Query

get :: Get Query

type Rep Query

Defined in Database.Franz.Internal.Protocol

type Rep Query = D1 ('MetaData "Query" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" 'False) (C1 ('MetaCons "Query" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reqStream") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StreamName) :*: 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

Constructors

RawRequest !ResponseId !Query

RawClean !ResponseId

Instances

Generic RawRequest

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep RawRequest :: Type -> Type

Methods

from :: RawRequest -> Rep RawRequest x

to :: Rep RawRequest x -> RawRequest

Serialize RawRequest

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter RawRequest

get :: Get RawRequest

type Rep RawRequest

Defined in Database.Franz.Internal.Protocol

type Rep RawRequest = D1 ('MetaData "RawRequest" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" '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

data ResponseHeader

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

Defined in Database.Franz.Internal.Protocol

Methods

showsPrec :: Int -> ResponseHeader -> ShowS

show :: ResponseHeader -> String

showList :: [ResponseHeader] -> ShowS

Generic ResponseHeader

Defined in Database.Franz.Internal.Protocol

Associated Types

type Rep ResponseHeader :: Type -> Type

Methods

from :: ResponseHeader -> Rep ResponseHeader x

to :: Rep ResponseHeader x -> ResponseHeader

Serialize ResponseHeader

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter ResponseHeader

get :: Get ResponseHeader

type Rep ResponseHeader

Defined in Database.Franz.Internal.Protocol

type Rep ResponseHeader = D1 ('MetaData "ResponseHeader" "Database.Franz.Internal.Protocol" "franz-0.5.2-DT0DpRlq3Nv7ChWZTFVJ1G" '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

Initial seqno, final seqno, base offset, index names

Constructors

PayloadHeader !Int !Int !Int !(Vector IndexName)

Instances

Serialize PayloadHeader

Defined in Database.Franz.Internal.Protocol

Methods

put :: Putter PayloadHeader

get :: Get PayloadHeader