Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- defaultPort :: PortNumber
- data Connection
- withConnection :: String -> PortNumber -> ByteString -> (Connection -> IO r) -> IO r
- connect :: String -> PortNumber -> ByteString -> IO Connection
- disconnect :: Connection -> IO ()
- data Query = Query {
- reqStream :: !ByteString
- reqFrom :: !ItemRef
- reqTo :: !ItemRef
- reqType :: !RequestType
- data ItemRef
- data RequestType
- defQuery :: ByteString -> Query
- type Response = Either Contents (STM Contents)
- awaitResponse :: STM (Either a (STM a)) -> STM a
- type SomeIndexMap = HashMap IndexName Int64
- type Contents = Vector (Int, SomeIndexMap, ByteString)
- fetch :: Connection -> Query -> (STM Response -> IO r) -> IO r
- fetchSimple :: Connection -> Int -> Query -> IO Contents
- atomicallyWithin :: Int -> STM a -> IO (Maybe a)
- data FranzException
Documentation
data Connection Source #
withConnection :: String -> PortNumber -> ByteString -> (Connection -> IO r) -> IO r Source #
connect :: String -> PortNumber -> ByteString -> IO Connection Source #
disconnect :: Connection -> IO () Source #
Query | |
|
Instances
Show Query Source # | |
Generic Query Source # | |
Serialize Query Source # | |
type Rep Query Source # | |
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)))) |
Instances
Show ItemRef Source # | |
Generic ItemRef Source # | |
Serialize ItemRef Source # | |
type Rep ItemRef Source # | |
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 Source #
Instances
Show RequestType Source # | |
Defined in Database.Franz.Protocol showsPrec :: Int -> RequestType -> ShowS # show :: RequestType -> String # showList :: [RequestType] -> ShowS # | |
Generic RequestType Source # | |
Defined in Database.Franz.Protocol type Rep RequestType :: Type -> Type # from :: RequestType -> Rep RequestType x # to :: Rep RequestType x -> RequestType # | |
Serialize RequestType Source # | |
Defined in Database.Franz.Protocol put :: Putter RequestType # get :: Get RequestType # | |
type Rep RequestType Source # | |
defQuery :: ByteString -> Query Source #
type Response = Either Contents (STM Contents) Source #
When it is Right
, it might block until the content arrives.
type Contents = Vector (Int, SomeIndexMap, ByteString) Source #
(seqno, indices, payloads)
:: Connection | |
-> Query | |
-> (STM Response -> IO r) | Wait for the response in a blocking manner. You should only run
the continuation inside a |
-> IO r |
Fetch requested data from the server.
Termination of fetch
continuation cancels the request, allowing
flexible control of its lifetime.
:: 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.
data FranzException Source #
MalformedRequest !String | |
StreamNotFound !FilePath | |
IndexNotFound !IndexName ![IndexName] | |
InternalError !String | |
ClientError !String |