Safe Haskell	None
Language	Haskell2010

Database.TDS.Types

Contents

Protocol Errors
Options
Connection object

Synopsis

data ClientState
- = Connecting
- | SentPreLogin
- | SentTLSSSLNegotiation
- | SentLogin7WithCompleteAuthenticationToken
- | SentLogin7WithSPNEGO
- | SentLogin7WithFAIR
- | LoggedIn
- | SentClientRequest
- | SentAttention
- | RoutingCompleted
- | Final
sendableInState :: PacketType sender resp d -> ClientState -> Bool
stateTransition :: PacketType sender resp d -> ClientState -> ClientState
newtype ConnectionTimeout = ConnectionTimeout Int
connectionTimeout :: ConnectionTimeout
data TDSErrorType
- = TDSNoSuchHost
- | TDSSocketError
- | TDSServerUninitialized
- | TDSServerBusy
- | TDSServerQuit
- | TDSInvalidStateTransition
- | TDSInvalidResponse
data TDSError where
- TDSError :: Show d => {..} -> TDSError
tdsErrorNoReq :: TDSErrorType -> ClientState -> String -> TDSError
data ConnectionInfo = ConnectionInfo {
- _tdsConnHost :: Maybe String
- _tdsConnPort :: Maybe Word16
}
data TdsAuth = TdsAuth
data Options = Options {
- _tdsOptionsSecure :: Bool
- _tdsAuth :: Maybe TdsAuth
- _tdsConnInfo :: ConnectionInfo
- _tdsOnMessage :: Message -> IO ()
- _tdsOnEnvChange :: EnvChange -> IO ()
- _tdsUser :: Text
- _tdsPassword :: Text
- _tdsDatabase :: Text
- _tdsAppName :: Text
- _tdsClientName :: Text
}
defaultOptions :: Options
tdsOptionSecure :: Options
tdsOptionHost :: String -> Options
tdsOptionPort :: Word16 -> Options
tdsOptionUserAndPassword :: Text -> Text -> Options
tdsOptionDatabase :: Text -> Options
tdsDebugLogging :: Options
data ResponseResult (ty :: ResponseType *) where
- ResponseResultCancelled :: ResponseResult (ResponseType True a)
- ResponseResultReceived :: Show a => a -> ResponseResult (ResponseType cancelable a)
data CancelInfo (canCancel :: Bool) where
- NonCancelable :: CancelInfo False
- Cancelable :: TVar Bool -> TMVar () -> CancelInfo True
class MkCancelable (canCancel :: Bool) where
- mkCancelable :: STM (CancelInfo canCancel)
data Connection = Connection {
- tdsSendPacket :: forall (sender :: Sender) (d :: *) (cancelable :: Bool) (res :: *). (Payload d, Response res, KnownBool cancelable, MkCancelable cancelable) => Packet Client (ExpectsResponse (ResponseType cancelable res)) d Identity -> IO (IO (ResponseResult (ResponseType cancelable res)))
- tdsCancel :: IO ()
- tdsQuit :: IO ()
- tdsConnectionState :: !(TVar ClientState)
- tdsConnectionOptions :: !Options
}
getReadyState :: Connection -> IO ClientState
isConnected :: Connection -> IO Bool
isReady :: Connection -> IO Bool
isBusy :: Connection -> IO Bool
isCancelable :: Connection -> IO Bool

Documentation

data ClientState Source #

Client state type based on recommendation on page 120

Constructors

Connecting
SentPreLogin
SentTLSSSLNegotiation
SentLogin7WithCompleteAuthenticationToken
SentLogin7WithSPNEGO
SentLogin7WithFAIR
LoggedIn
SentClientRequest
SentAttention
RoutingCompleted
Final

Instances

Bounded ClientState Source #
Instance details Defined in Database.TDS.Types Methods minBound :: ClientState # maxBound :: ClientState #
Enum ClientState Source #
Instance details Defined in Database.TDS.Types Methods succ :: ClientState -> ClientState # pred :: ClientState -> ClientState # toEnum :: Int -> ClientState # fromEnum :: ClientState -> Int # enumFrom :: ClientState -> [ClientState] # enumFromThen :: ClientState -> ClientState -> [ClientState] # enumFromTo :: ClientState -> ClientState -> [ClientState] # enumFromThenTo :: ClientState -> ClientState -> ClientState -> [ClientState] #
Eq ClientState Source #
Instance details Defined in Database.TDS.Types Methods (==) :: ClientState -> ClientState -> Bool # (/=) :: ClientState -> ClientState -> Bool #
Ord ClientState Source #
Instance details Defined in Database.TDS.Types Methods compare :: ClientState -> ClientState -> Ordering # (<) :: ClientState -> ClientState -> Bool # (<=) :: ClientState -> ClientState -> Bool # (>) :: ClientState -> ClientState -> Bool # (>=) :: ClientState -> ClientState -> Bool # max :: ClientState -> ClientState -> ClientState # min :: ClientState -> ClientState -> ClientState #
Show ClientState Source #
Instance details Defined in Database.TDS.Types Methods showsPrec :: Int -> ClientState -> ShowS # show :: ClientState -> String # showList :: [ClientState] -> ShowS #

sendableInState :: PacketType sender resp d -> ClientState -> Bool Source #

stateTransition :: PacketType sender resp d -> ClientState -> ClientState Source #

newtype ConnectionTimeout Source #

Constructors

ConnectionTimeout Int

Instances

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

connectionTimeout :: ConnectionTimeout Source #

Connection timeout in seconds

Protocol Errors

data TDSErrorType Source #

Constructors

TDSNoSuchHost
TDSSocketError
TDSServerUninitialized
TDSServerBusy
TDSServerQuit
TDSInvalidStateTransition
TDSInvalidResponse

Instances

Show TDSErrorType Source #
Instance details Defined in Database.TDS.Types Methods showsPrec :: Int -> TDSErrorType -> ShowS # show :: TDSErrorType -> String # showList :: [TDSErrorType] -> ShowS #

data TDSError where Source #

Constructors

TDSError
Fields :: Show d => { tdsErrorType :: !TDSErrorType , tdsErrorState :: !ClientState , tdsErrorRequest :: !(Maybe (Packet sender resp d Identity)) , tdsErrorMessage :: !String } -> TDSError

Instances

Show TDSError Source #
Instance details Defined in Database.TDS.Types Methods showsPrec :: Int -> TDSError -> ShowS # show :: TDSError -> String # showList :: [TDSError] -> ShowS #
Exception TDSError Source #
Instance details Defined in Database.TDS.Types Methods toException :: TDSError -> SomeException # fromException :: SomeException -> Maybe TDSError # displayException :: TDSError -> String #

tdsErrorNoReq :: TDSErrorType -> ClientState -> String -> TDSError Source #

Options

data ConnectionInfo Source #

Constructors

ConnectionInfo
Fields _tdsConnHost :: Maybe String _tdsConnPort :: Maybe Word16

Instances

Eq ConnectionInfo Source #
Instance details Defined in Database.TDS.Types Methods (==) :: ConnectionInfo -> ConnectionInfo -> Bool # (/=) :: ConnectionInfo -> ConnectionInfo -> Bool #
Ord ConnectionInfo Source #
Instance details Defined in Database.TDS.Types Methods compare :: ConnectionInfo -> ConnectionInfo -> Ordering # (<) :: ConnectionInfo -> ConnectionInfo -> Bool # (<=) :: ConnectionInfo -> ConnectionInfo -> Bool # (>) :: ConnectionInfo -> ConnectionInfo -> Bool # (>=) :: ConnectionInfo -> ConnectionInfo -> Bool # max :: ConnectionInfo -> ConnectionInfo -> ConnectionInfo # min :: ConnectionInfo -> ConnectionInfo -> ConnectionInfo #
Show ConnectionInfo Source #
Instance details Defined in Database.TDS.Types Methods showsPrec :: Int -> ConnectionInfo -> ShowS # show :: ConnectionInfo -> String # showList :: [ConnectionInfo] -> ShowS #
Semigroup ConnectionInfo Source #
Instance details Defined in Database.TDS.Types Methods (<>) :: ConnectionInfo -> ConnectionInfo -> ConnectionInfo # sconcat :: NonEmpty ConnectionInfo -> ConnectionInfo # stimes :: Integral b => b -> ConnectionInfo -> ConnectionInfo #
Monoid ConnectionInfo Source #
Instance details Defined in Database.TDS.Types Methods mempty :: ConnectionInfo # mappend :: ConnectionInfo -> ConnectionInfo -> ConnectionInfo # mconcat :: [ConnectionInfo] -> ConnectionInfo #

data TdsAuth Source #

Constructors

TdsAuth

Instances

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

data Options Source #

Constructors

Options
Fields _tdsOptionsSecure :: Bool _tdsAuth :: Maybe TdsAuth _tdsConnInfo :: ConnectionInfo _tdsOnMessage :: Message -> IO () _tdsOnEnvChange :: EnvChange -> IO () _tdsUser :: Text _tdsPassword :: Text _tdsDatabase :: Text _tdsAppName :: Text _tdsClientName :: Text

Instances

Semigroup Options Source #
Instance details Defined in Database.TDS.Types Methods (<>) :: Options -> Options -> Options # sconcat :: NonEmpty Options -> Options # stimes :: Integral b => b -> Options -> Options #
Monoid Options Source #
Instance details Defined in Database.TDS.Types Methods mempty :: Options # mappend :: Options -> Options -> Options # mconcat :: [Options] -> Options #

defaultOptions :: Options Source #

tdsOptionSecure :: Options Source #

tdsOptionHost :: String -> Options Source #

tdsOptionPort :: Word16 -> Options Source #

tdsOptionUserAndPassword :: Text -> Text -> Options Source #

tdsOptionDatabase :: Text -> Options Source #

tdsDebugLogging :: Options Source #

Connection object

data ResponseResult (ty :: ResponseType *) where Source #

Constructors

ResponseResultCancelled :: ResponseResult (ResponseType True a)
ResponseResultReceived :: Show a => a -> ResponseResult (ResponseType cancelable a)

Instances

Show (ResponseResult ty) Source #
Instance details Defined in Database.TDS.Types Methods showsPrec :: Int -> ResponseResult ty -> ShowS # show :: ResponseResult ty -> String # showList :: [ResponseResult ty] -> ShowS #

data CancelInfo (canCancel :: Bool) where Source #

Constructors

NonCancelable :: CancelInfo False
Cancelable :: TVar Bool -> TMVar () -> CancelInfo True

class MkCancelable (canCancel :: Bool) where Source #

Methods

mkCancelable :: STM (CancelInfo canCancel) Source #

Instances

MkCancelable False Source #
Instance details Defined in Database.TDS.Types Methods mkCancelable :: STM (CancelInfo False) Source #
MkCancelable True Source #
Instance details Defined in Database.TDS.Types Methods mkCancelable :: STM (CancelInfo True) Source #

data Connection Source #

Constructors

Connection

Fields

tdsSendPacket :: forall (sender :: Sender) (d :: *) (cancelable :: Bool) (res :: *). (Payload d, Response res, KnownBool cancelable, MkCancelable cancelable) => Packet Client (ExpectsResponse (ResponseType cancelable res)) d Identity -> IO (IO (ResponseResult (ResponseType cancelable res)))
tdsCancel :: IO ()
tdsQuit :: IO ()
tdsConnectionState :: !(TVar ClientState)
tdsConnectionOptions :: !Options

getReadyState :: Connection -> IO ClientState Source #

isConnected :: Connection -> IO Bool Source #

Returns True if the client is connected to the server. False otherwise

isReady :: Connection -> IO Bool Source #

Returns True if the client is ready to send commands to the server. False otherwise

isBusy :: Connection -> IO Bool Source #

Returns True if the server is busy processing a request. False otherwise

isCancelable :: Connection -> IO Bool Source #

Returns True if the server is processing a request that can be canceled. False otherwise