Safe Haskell	None
Language	Haskell2010

Database.CQL.IO.Connection.Settings

Contents

Timeouts
Limits
Authentication

Synopsis

data ConnectionSettings
newtype ConnId = ConnId Unique
defSettings :: ConnectionSettings
defKeyspace :: Lens' ConnectionSettings (Maybe Keyspace)
compression :: Lens' ConnectionSettings Compression
tlsContext :: Lens' ConnectionSettings (Maybe SSLContext)
newtype Milliseconds = Ms {
- ms :: Int
}
connectTimeout :: Lens' ConnectionSettings Milliseconds
sendTimeout :: Lens' ConnectionSettings Milliseconds
responseTimeout :: Lens' ConnectionSettings Milliseconds
maxStreams :: Lens' ConnectionSettings Int
maxRecvBuffer :: Lens' ConnectionSettings Int
authenticators :: Lens' ConnectionSettings (HashMap AuthMechanism Authenticator)
newtype AuthMechanism = AuthMechanism Text
data Authenticator = Authenticator {
- authMechanism :: !AuthMechanism
- authOnRequest :: AuthContext -> IO (AuthResponse, s)
- authOnChallenge :: Maybe (s -> AuthChallenge -> IO (AuthResponse, s))
- authOnSuccess :: s -> AuthSuccess -> IO ()
}
data AuthContext = AuthContext {
- _authConnId :: !ConnId
- _authHost :: !InetAddr
}
authConnId :: Lens' AuthContext ConnId
authHost :: Lens' AuthContext InetAddr
passwordAuthenticator :: AuthUser -> AuthPass -> Authenticator
newtype AuthUser = AuthUser Text
newtype AuthPass = AuthPass Text

Documentation

data ConnectionSettings Source #

newtype ConnId Source #

Constructors

ConnId Unique

Instances

Eq ConnId Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods (==) :: ConnId -> ConnId -> Bool # (/=) :: ConnId -> ConnId -> Bool #
Ord ConnId Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods compare :: ConnId -> ConnId -> Ordering # (<) :: ConnId -> ConnId -> Bool # (<=) :: ConnId -> ConnId -> Bool # (>) :: ConnId -> ConnId -> Bool # (>=) :: ConnId -> ConnId -> Bool # max :: ConnId -> ConnId -> ConnId # min :: ConnId -> ConnId -> ConnId #
Hashable ConnId Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods hashWithSalt :: Int -> ConnId -> Int # hash :: ConnId -> Int #

defSettings :: ConnectionSettings Source #

defKeyspace :: Lens' ConnectionSettings (Maybe Keyspace) Source #

compression :: Lens' ConnectionSettings Compression Source #

tlsContext :: Lens' ConnectionSettings (Maybe SSLContext) Source #

Timeouts

newtype Milliseconds Source #

Constructors

Ms
Fields ms :: Int

Instances

Eq Milliseconds Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods (==) :: Milliseconds -> Milliseconds -> Bool # (/=) :: Milliseconds -> Milliseconds -> Bool #
Show Milliseconds Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods showsPrec :: Int -> Milliseconds -> ShowS # show :: Milliseconds -> String # showList :: [Milliseconds] -> ShowS #

connectTimeout :: Lens' ConnectionSettings Milliseconds Source #

sendTimeout :: Lens' ConnectionSettings Milliseconds Source #

responseTimeout :: Lens' ConnectionSettings Milliseconds Source #

Limits

maxStreams :: Lens' ConnectionSettings Int Source #

maxRecvBuffer :: Lens' ConnectionSettings Int Source #

Authentication

authenticators :: Lens' ConnectionSettings (HashMap AuthMechanism Authenticator) Source #

newtype AuthMechanism Source #

The (unique) name of a SASL authentication mechanism.

In the case of Cassandra, this is currently always the fully-qualified Java class name of the configured server-side IAuthenticator implementation.

Constructors

AuthMechanism Text

Instances

Eq AuthMechanism Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods (==) :: AuthMechanism -> AuthMechanism -> Bool # (/=) :: AuthMechanism -> AuthMechanism -> Bool #
Ord AuthMechanism Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods compare :: AuthMechanism -> AuthMechanism -> Ordering # (<) :: AuthMechanism -> AuthMechanism -> Bool # (<=) :: AuthMechanism -> AuthMechanism -> Bool # (>) :: AuthMechanism -> AuthMechanism -> Bool # (>=) :: AuthMechanism -> AuthMechanism -> Bool # max :: AuthMechanism -> AuthMechanism -> AuthMechanism # min :: AuthMechanism -> AuthMechanism -> AuthMechanism #
Show AuthMechanism Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods showsPrec :: Int -> AuthMechanism -> ShowS # show :: AuthMechanism -> String # showList :: [AuthMechanism] -> ShowS #
IsString AuthMechanism Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods fromString :: String -> AuthMechanism #
Hashable AuthMechanism Source #
Instance details Defined in Database.CQL.IO.Connection.Settings Methods hashWithSalt :: Int -> AuthMechanism -> Int # hash :: AuthMechanism -> Int #

data Authenticator Source #

A client authentication handler.

The fields of an Authenticator must implement the client-side of an (SASL) authentication mechanism as follows:

When a Cassandra server requests authentication on a new connection, authOnRequest is called with the AuthContext of the connection.
If additional challenges are posed by the server, authOnChallenge is called, if available, otherwise an AuthenticationError is thrown, i.e. every challenge must be answered.
Upon successful authentication authOnSuccess is called.

The existential type s is chosen by an implementation and can be used to thread arbitrary state through the sequence of callback invocations during an authentication exchange.

AuthContext
Fields _authConnId :: !ConnId _authHost :: !InetAddr