Network.Nakadi.Types

This module provides the Nakadi API Types.

Documentation

module Network.Nakadi.Types.Config

module Network.Nakadi.Types.Exceptions

module Network.Nakadi.Types.Logger

module Network.Nakadi.Types.Problem

module Network.Nakadi.Types.Service

data CommitStrategy

This type encodes the supported strategies for subscription cursor committing.

Constructors

CommitSync

This strategy synchronously commits every cursor.

CommitAsync CommitBufferingStrategy

This strategy sends cursors to be committed to a dedicated thread responsible for committing them. Cursors are commited one by one, without special buffering logic.

Instances

HasNakadiCommitStrategy (Config m) CommitStrategy

Defined in Network.Nakadi.Internal.Lenses

Methods

commitStrategy :: Lens' (Config m) CommitStrategy

data CommitBufferingStrategy

This type encodes the supported buffering strategies for asynchronous subscription cursor committing.

Constructors

CommitNoBuffer

No buffering at all.

CommitTimeBuffer Int32

Buffer for the specified duration, given in milliseconds.

CommitSmartBuffer

Buffer for a fixed duration, but committing cursors immediately if the number of events processed since the last commit crosses a threshold derived from maxUncommittedEvents.

newtype CommitTimeout

This type is used for specifying subscription commit timeouts in seconds.

Constructors

CommitTimeout

Fields

• unCommitTimeout :: Int32

Instances

Eq CommitTimeout

Defined in Network.Nakadi.Internal.Types.Subscriptions

Methods

(==) :: CommitTimeout -> CommitTimeout -> Bool

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

Ord CommitTimeout

Defined in Network.Nakadi.Internal.Types.Subscriptions

Methods

compare :: CommitTimeout -> CommitTimeout -> Ordering

(<) :: CommitTimeout -> CommitTimeout -> Bool

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

(>) :: CommitTimeout -> CommitTimeout -> Bool

(>=) :: CommitTimeout -> CommitTimeout -> Bool

max :: CommitTimeout -> CommitTimeout -> CommitTimeout

min :: CommitTimeout -> CommitTimeout -> CommitTimeout

Show CommitTimeout

Defined in Network.Nakadi.Internal.Types.Subscriptions

Methods

showsPrec :: Int -> CommitTimeout -> ShowS

show :: CommitTimeout -> String

showList :: [CommitTimeout] -> ShowS

HasNakadiCommitTimeout (Config m) (Maybe CommitTimeout)

Defined in Network.Nakadi.Internal.Lenses

Methods

commitTimeout :: Lens' (Config m) (Maybe CommitTimeout)

class (Monad b, Monad m) => MonadNakadiBase b m where

Minimal complete definition

Nothing

Methods

nakadiLiftBase :: b a -> m a

nakadiLiftBase :: (MonadNakadiBase b n, MonadTrans t, m ~ t n) => b a -> m a

Instances

MonadNakadiBase IO IO

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: IO a -> IO a

MonadNakadiBase b m => MonadNakadiBase b (ResourceT m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> ResourceT m a

MonadNakadiBase b m => MonadNakadiBase b (NoLoggingT m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> NoLoggingT m a

MonadNakadiBase b m => MonadNakadiBase b (LoggingT m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> LoggingT m a

MonadNakadiBase b m => MonadNakadiBase b (StateT s m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> StateT s m a

MonadNakadiBase b m => MonadNakadiBase b (StateT s m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> StateT s m a

(MonadNakadiBase b m, Monoid w) => MonadNakadiBase b (WriterT w m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> WriterT w m a

(MonadNakadiBase b m, Monoid w) => MonadNakadiBase b (WriterT w m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> WriterT w m a

MonadNakadiBase b m => MonadNakadiBase b (NakadiT b m)

MonadNakadiBase

Defined in Network.Nakadi.Internal.Types

Methods

nakadiLiftBase :: b a -> NakadiT b m a

MonadNakadiBase b m => MonadNakadiBase b (ReaderT r m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: b a -> ReaderT r m a

Monad m => MonadNakadiBase (LoggingT (ReaderT r m)) (LoggingT (ReaderT r m))

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: LoggingT (ReaderT r m) a -> LoggingT (ReaderT r m) a

Monad m => MonadNakadiBase (NakadiBaseT m) (NakadiBaseT m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: NakadiBaseT m a -> NakadiBaseT m a

Monad m => MonadNakadiBase (ReaderT r m) (ReaderT r m)

Defined in Network.Nakadi.Internal.Types.Base

Methods

nakadiLiftBase :: ReaderT r m a -> ReaderT r m a

class (MonadNakadiBase b m, MonadThrow b, MonadMask b, MonadThrow m, MonadCatch m) => MonadNakadi b m | m -> b where

The MonadNakadi typeclass is implemented by monads in which Nakadi can be called. The first parameter (b) denotes the `base monad`. This is the monad in which the core actions are run. This includes executing (non-streaming) HTTP requests and running user-provided callbacks. The typeclass provides methods for * retrieving the Nakadi configuration * locally changing the Nakadi configuration * extracting specific Nakadi configuration values * lifting actions from the The MonadNakadi typeclass is modelled closely after MonadReader.

Minimal complete definition

Nothing

Methods

nakadiAsk :: m (Config b)

nakadiAsk :: (MonadNakadi b n, MonadTrans t, m ~ t n) => m (Config b)

Instances

MonadNakadi IO IO

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: IO (Config IO)

MonadNakadi b m => MonadNakadi b (ResourceT m)

ResourceT.

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: ResourceT m (Config b)

MonadNakadi b m => MonadNakadi b (NoLoggingT m)

NoLoggingT

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: NoLoggingT m (Config b)

MonadNakadi b m => MonadNakadi b (LoggingT m)

LoggingT

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: LoggingT m (Config b)

MonadNakadi b m => MonadNakadi b (StateT s m)

StateT (lazy)

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: StateT s m (Config b)

MonadNakadi b m => MonadNakadi b (StateT s m)

StateT (strict)

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: StateT s m (Config b)

(MonadNakadi b m, Monoid w) => MonadNakadi b (WriterT w m)

WriterT (strict)

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: WriterT w m (Config b)

(MonadNakadi b m, Monoid w) => MonadNakadi b (WriterT w m)

WriterT (lazy)

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: WriterT w m (Config b)

(MonadCatch m, MonadMask b, MonadNakadiBase b (NakadiT b m)) => MonadNakadi b (NakadiT b m)

NakadiT

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: NakadiT b m (Config b)

(MonadMask b, MonadCatch m, MonadNakadiBase b (ReaderT r m), HasNakadiConfig b r) => MonadNakadi b (ReaderT r m)

ReaderT

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: ReaderT r m (Config b)

class HasNakadiConfig b r | r -> b where

Methods

nakadiConfig :: r -> Config b

data NakadiT b m a

The NakadiT type is just a specialized ReaderT monad.

Instances

(Monad b, MonadReader r m) => MonadReader r (NakadiT b m)

MonadReader

Defined in Network.Nakadi.Internal.Types

Methods

ask :: NakadiT b m r

local :: (r -> r) -> NakadiT b m a -> NakadiT b m a

reader :: (r -> a) -> NakadiT b m a

(Monad b, MonadState s m) => MonadState s (NakadiT b m)

MonadState

Defined in Network.Nakadi.Internal.Types

Methods

get :: NakadiT b m s

put :: s -> NakadiT b m ()

state :: (s -> (a, s)) -> NakadiT b m a

(Monad m, MonadBase b' m) => MonadBase b' (NakadiT b m)

MonadBase

Defined in Network.Nakadi.Internal.Types

Methods

liftBase :: b' α -> NakadiT b m α

MonadBaseControl b' m => MonadBaseControl b' (NakadiT b m)

MonadBaseControl

Defined in Network.Nakadi.Internal.Types

Associated Types

type StM (NakadiT b m) a :: Type

Methods

liftBaseWith :: (RunInBase (NakadiT b m) b' -> b' a) -> NakadiT b m a

restoreM :: StM (NakadiT b m) a -> NakadiT b m a

MonadNakadiBase b m => MonadNakadiBase b (NakadiT b m)

MonadNakadiBase

Defined in Network.Nakadi.Internal.Types

Methods

nakadiLiftBase :: b a -> NakadiT b m a

(MonadCatch m, MonadMask b, MonadNakadiBase b (NakadiT b m)) => MonadNakadi b (NakadiT b m)

NakadiT

Defined in Network.Nakadi.Internal.Types

Methods

nakadiAsk :: NakadiT b m (Config b)

MonadTrans (NakadiT b)

MonadTrans

Defined in Network.Nakadi.Internal.Types

Methods

lift :: Monad m => m a -> NakadiT b m a

MonadTransControl (NakadiT b)

MonadTransControl

Defined in Network.Nakadi.Internal.Types

Associated Types

type StT (NakadiT b) a :: Type

Methods

liftWith :: Monad m => (Run (NakadiT b) -> m a) -> NakadiT b m a

restoreT :: Monad m => m (StT (NakadiT b) a) -> NakadiT b m a

Monad m => Monad (NakadiT b m)

Monad

Defined in Network.Nakadi.Internal.Types

Methods

(>>=) :: NakadiT b m a -> (a -> NakadiT b m b0) -> NakadiT b m b0

(>>) :: NakadiT b m a -> NakadiT b m b0 -> NakadiT b m b0

return :: a -> NakadiT b m a

fail :: String -> NakadiT b m a

Functor m => Functor (NakadiT b m)

Functor for NakadiT.

Defined in Network.Nakadi.Internal.Types

Methods

fmap :: (a -> b0) -> NakadiT b m a -> NakadiT b m b0

(<$) :: a -> NakadiT b m b0 -> NakadiT b m a

Applicative m => Applicative (NakadiT b m)

Applicative for NakadiT.

Defined in Network.Nakadi.Internal.Types

Methods

pure :: a -> NakadiT b m a

(<*>) :: NakadiT b m (a -> b0) -> NakadiT b m a -> NakadiT b m b0

liftA2 :: (a -> b0 -> c) -> NakadiT b m a -> NakadiT b m b0 -> NakadiT b m c

(*>) :: NakadiT b m a -> NakadiT b m b0 -> NakadiT b m b0

(<*) :: NakadiT b m a -> NakadiT b m b0 -> NakadiT b m a

(Monad b, MonadIO m) => MonadIO (NakadiT b m)

MonadIO

Defined in Network.Nakadi.Internal.Types

Methods

liftIO :: IO a -> NakadiT b m a

(Monad b, MonadUnliftIO m) => MonadUnliftIO (NakadiT b m)

MonadUnliftIO

Defined in Network.Nakadi.Internal.Types

Methods

askUnliftIO :: NakadiT b m (UnliftIO (NakadiT b m))

withRunInIO :: ((forall a. NakadiT b m a -> IO a) -> IO b0) -> NakadiT b m b0

(Monad b, MonadResource m) => MonadResource (NakadiT b m)

Defined in Network.Nakadi.Internal.Types

Methods

liftResourceT :: ResourceT IO a -> NakadiT b m a

(Monad b, MonadThrow m) => MonadThrow (NakadiT b m)

MonadThrow

Defined in Network.Nakadi.Internal.Types

Methods

throwM :: Exception e => e -> NakadiT b m a

(Monad b, MonadCatch m) => MonadCatch (NakadiT b m)

MonadCatch

Defined in Network.Nakadi.Internal.Types

Methods

catch :: Exception e => NakadiT b m a -> (e -> NakadiT b m a) -> NakadiT b m a

(Monad b, MonadMask m) => MonadMask (NakadiT b m)

MonadMask

Defined in Network.Nakadi.Internal.Types

Methods

mask :: ((forall a. NakadiT b m a -> NakadiT b m a) -> NakadiT b m b0) -> NakadiT b m b0

uninterruptibleMask :: ((forall a. NakadiT b m a -> NakadiT b m a) -> NakadiT b m b0) -> NakadiT b m b0

generalBracket :: NakadiT b m a -> (a -> ExitCase b0 -> NakadiT b m c) -> (a -> NakadiT b m b0) -> NakadiT b m (b0, c)

MonadLogger m => MonadLogger (NakadiT b m)

MonadLogger

Defined in Network.Nakadi.Internal.Types

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> NakadiT b m ()

(Monad b, MonadLoggerIO m) => MonadLoggerIO (NakadiT b m)

MonadLoggerIO

Defined in Network.Nakadi.Internal.Types

Methods

askLoggerIO :: NakadiT b m (Loc -> LogSource -> LogLevel -> LogStr -> IO ())

type StT (NakadiT b) a

Defined in Network.Nakadi.Internal.Types

type StT (NakadiT b) a = a

type StM (NakadiT b m) a

Defined in Network.Nakadi.Internal.Types

type StM (NakadiT b m) a = ComposeSt (NakadiT b) m a

runNakadiT :: Config b -> NakadiT b m a -> m a