Database.Franz.Network

Documentation

defaultPort :: PortNumber

data Connection

withConnection :: String -> PortNumber -> ByteString -> (Connection -> IO r) -> IO r

connect :: String -> PortNumber -> ByteString -> IO Connection

disconnect :: Connection -> IO ()

data Query

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

Defined in Database.Franz.Protocol

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

Generic Query

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

Defined in Database.Franz.Protocol

Methods

put :: Putter Query

get :: Get Query

type Rep Query

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 ItemRef

Constructors

BySeqNum !Int

sequential number

ByIndex !IndexName !Int

index name and value

Instances

Show ItemRef

Defined in Database.Franz.Protocol

Methods

showsPrec :: Int -> ItemRef -> ShowS

show :: ItemRef -> String

showList :: [ItemRef] -> ShowS

Generic ItemRef

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

Defined in Database.Franz.Protocol

Methods

put :: Putter ItemRef

get :: Get ItemRef

type Rep ItemRef

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 RequestType

Constructors

AllItems

LastItem

Instances

Show RequestType

Defined in Database.Franz.Protocol

Methods

showsPrec :: Int -> RequestType -> ShowS

show :: RequestType -> String

showList :: [RequestType] -> ShowS

Generic RequestType

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

Defined in Database.Franz.Protocol

Methods

put :: Putter RequestType

get :: Get RequestType

type Rep RequestType

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))

defQuery :: ByteString -> Query

type Response = Either Contents (STM Contents)

When it is Right, it might block until the content arrives.

awaitResponse :: STM (Either a (STM a)) -> STM a

type SomeIndexMap = HashMap IndexName Int64

type Contents = Vector (Int, SomeIndexMap, ByteString)

(seqno, indices, payloads)

fetch

Arguments

:: Connection

-> Query

-> (STM Response -> IO r)

Wait for the response in a blocking manner. You should only run the continuation inside a fetch block: leaking the STM action and running it outside will result in a ClientError exception.

-> IO r

Fetch requested data from the server.

Termination of fetch continuation cancels the request, allowing flexible control of its lifetime.

fetchSimple

Arguments

:: Connection

-> Int

timeout in microseconds

-> Query

-> IO Contents

Send a single query and wait for the result. If it timeouts, it returns an empty list.

atomicallyWithin

Arguments

:: Int

timeout in microseconds

-> STM a

-> IO (Maybe a)

data FranzException

Constructors

MalformedRequest !String

StreamNotFound !FilePath

IndexNotFound !IndexName ![IndexName]

InternalError !String

ClientError !String

Instances

Show FranzException

Defined in Database.Franz.Protocol

Methods

showsPrec :: Int -> FranzException -> ShowS

show :: FranzException -> String

showList :: [FranzException] -> ShowS

Generic FranzException

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

Defined in Database.Franz.Protocol

Methods

toException :: FranzException -> SomeException

fromException :: SomeException -> Maybe FranzException

displayException :: FranzException -> String

Serialize FranzException

Defined in Database.Franz.Protocol

Methods

put :: Putter FranzException

get :: Get FranzException

type Rep FranzException

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)))))