Safe Haskell	None
Language	Haskell2010

Database.Franz.Client

Synopsis

data FranzPath
- = FranzPath {
  - franzHost :: !HostName
  - franzPort :: !PortNumber
  - franzDir :: !FilePath
  }
- | LocalFranzPath !FilePath
fromFranzPath :: (Monoid a, IsString a) => FranzPath -> a
toFranzPath :: String -> Either String FranzPath
defaultPort :: PortNumber
data Connection
withConnection :: FranzPath -> (Connection -> IO r) -> IO r
connect :: FranzPath -> IO Connection
disconnect :: Connection -> IO ()
newtype StreamName = StreamName {
- unStreamName :: ByteString
}
data Query = Query {
- reqStream :: !StreamName
- reqFrom :: !ItemRef
- reqTo :: !ItemRef
- reqType :: !RequestType
}
data ItemRef
- = BySeqNum !Int
- | ByIndex !IndexName !Int
data RequestType
- = AllItems
- | LastItem
defQuery :: StreamName -> Query
type Response = Either Contents (STM Contents)
awaitResponse :: STM (Either a (STM a)) -> STM a
data Contents
fetch :: Connection -> Query -> (STM Response -> IO r) -> IO r
fetchSimple :: Connection -> Int -> Query -> IO (Maybe Contents)
atomicallyWithin :: Int -> STM a -> IO (Maybe a)
data FranzException
- = MalformedRequest !String
- | StreamNotFound !FilePath
- | IndexNotFound !IndexName ![IndexName]
- | InternalError !String
- | ClientError !String

Documentation

data FranzPath Source #

Constructors

FranzPath
Fields franzHost :: !HostName franzPort :: !PortNumber franzDir :: !FilePath Prefix of franz directories
LocalFranzPath !FilePath

Instances

Instances details

Eq FranzPath Source #
Instance details Defined in Database.Franz.Internal.URI Methods (==) :: FranzPath -> FranzPath -> Bool # (/=) :: FranzPath -> FranzPath -> Bool #
Ord FranzPath Source #
Instance details Defined in Database.Franz.Internal.URI Methods compare :: FranzPath -> FranzPath -> Ordering # (<) :: FranzPath -> FranzPath -> Bool # (<=) :: FranzPath -> FranzPath -> Bool # (>) :: FranzPath -> FranzPath -> Bool # (>=) :: FranzPath -> FranzPath -> Bool # max :: FranzPath -> FranzPath -> FranzPath # min :: FranzPath -> FranzPath -> FranzPath #
Show FranzPath Source #
Instance details Defined in Database.Franz.Internal.URI Methods showsPrec :: Int -> FranzPath -> ShowS # show :: FranzPath -> String # showList :: [FranzPath] -> ShowS #

fromFranzPath :: (Monoid a, IsString a) => FranzPath -> a Source #

Render FranzPath as a franz URI.

toFranzPath :: String -> Either String FranzPath Source #

Parse a franz URI (franz:/host:portpath or franz-local:path).

defaultPort :: PortNumber Source #

data Connection Source #

withConnection :: FranzPath -> (Connection -> IO r) -> IO r Source #

connect :: FranzPath -> IO Connection Source #

disconnect :: Connection -> IO () Source #

newtype StreamName Source #

Constructors

StreamName
Fields unStreamName :: ByteString

Instances

Instances details

Eq StreamName Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods (==) :: StreamName -> StreamName -> Bool # (/=) :: StreamName -> StreamName -> Bool #
Ord StreamName Source #
Instance details 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 Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods showsPrec :: Int -> StreamName -> ShowS # show :: StreamName -> String # showList :: [StreamName] -> ShowS #
IsString StreamName Source #	UTF-8 encoded
Instance details Defined in Database.Franz.Internal.Protocol Methods fromString :: String -> StreamName #
Serialize StreamName Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods put :: Putter StreamName # get :: Get StreamName #
Hashable StreamName Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods hashWithSalt :: Int -> StreamName -> Int # hash :: StreamName -> Int #

data Query Source #

Constructors

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

Instances

Instances details

Show Query Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
Generic Query Source #
Instance details 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 Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods put :: Putter Query # get :: Get Query #
type Rep Query Source #
Instance details Defined in Database.Franz.Internal.Protocol type Rep Query = D1 ('MetaData "Query" "Database.Franz.Internal.Protocol" "franz-0.5-KxXJcuIWnOq5voPsLQF7IG" '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 ItemRef Source #

Constructors

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

Instances

Instances details

Show ItemRef Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods showsPrec :: Int -> ItemRef -> ShowS # show :: ItemRef -> String # showList :: [ItemRef] -> ShowS #
Generic ItemRef Source #
Instance details 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 Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods put :: Putter ItemRef # get :: Get ItemRef #
type Rep ItemRef Source #
Instance details Defined in Database.Franz.Internal.Protocol type Rep ItemRef = D1 ('MetaData "ItemRef" "Database.Franz.Internal.Protocol" "franz-0.5-KxXJcuIWnOq5voPsLQF7IG" '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 #

Constructors

AllItems
LastItem

Instances

Instances details

Show RequestType Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods showsPrec :: Int -> RequestType -> ShowS # show :: RequestType -> String # showList :: [RequestType] -> ShowS #
Generic RequestType Source #
Instance details 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 Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods put :: Putter RequestType # get :: Get RequestType #
type Rep RequestType Source #
Instance details Defined in Database.Franz.Internal.Protocol type Rep RequestType = D1 ('MetaData "RequestType" "Database.Franz.Internal.Protocol" "franz-0.5-KxXJcuIWnOq5voPsLQF7IG" 'False) (C1 ('MetaCons "AllItems" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LastItem" 'PrefixI 'False) (U1 :: Type -> Type))

defQuery :: StreamName -> Query Source #

type Response = Either Contents (STM Contents) Source #

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

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

data Contents Source #

fetch Source #

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 Source #

Arguments

:: Connection
-> Int	timeout in microseconds
-> Query
-> IO (Maybe Contents)

Send a single query and wait for the result.

atomicallyWithin Source #

Arguments

:: Int	timeout in microseconds
-> STM a
-> IO (Maybe a)

data FranzException Source #

Constructors

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

Instances

Instances details

Show FranzException Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods showsPrec :: Int -> FranzException -> ShowS # show :: FranzException -> String # showList :: [FranzException] -> ShowS #
Generic FranzException Source #
Instance details 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 Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods toException :: FranzException -> SomeException # fromException :: SomeException -> Maybe FranzException # displayException :: FranzException -> String #
Serialize FranzException Source #
Instance details Defined in Database.Franz.Internal.Protocol Methods put :: Putter FranzException # get :: Get FranzException #
type Rep FranzException Source #
Instance details Defined in Database.Franz.Internal.Protocol type Rep FranzException = D1 ('MetaData "FranzException" "Database.Franz.Internal.Protocol" "franz-0.5-KxXJcuIWnOq5voPsLQF7IG" '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)))))