Ldap.Client.Bind

Bind operation.

This operation comes in four flavours:

• synchronous, exception throwing (bind)
• synchronous, returning Either ResponseError () (bindEither)
• asynchronous, IO based (bindAsync)
• asynchronous, STM based (bindAsyncSTM)

Of those, the first one (bind) is probably the most useful for the typical usecase.

Documentation

newtype Password

User's password.

Constructors

Password ByteString

Instances

Eq Password

Defined in Ldap.Client.Bind

Methods

(==) :: Password -> Password -> Bool

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

Show Password

Defined in Ldap.Client.Bind

Methods

showsPrec :: Int -> Password -> ShowS

show :: Password -> String

showList :: [Password] -> ShowS

bind :: Ldap -> Dn -> Password -> IO ()

Perform the Bind operation synchronously. Raises ResponseError on failures.

bindEither :: Ldap -> Dn -> Password -> IO (Either ResponseError ())

Perform the Bind operation synchronously. Returns Left e where e is a ResponseError on failures.

bindAsync :: Ldap -> Dn -> Password -> IO (Async ())

Perform the Bind operation asynchronously. Call wait to wait for its completion.

bindAsyncSTM :: Ldap -> Dn -> Password -> STM (Async ())

Perform the Bind operation asynchronously.

Don't wait for its completion (with waitSTM) in the same transaction you've performed it in.

externalBind :: Ldap -> Dn -> Maybe Text -> IO ()

Perform a SASL EXTERNAL Bind operation synchronously. Raises ResponseError on failures.

externalBindEither :: Ldap -> Dn -> Maybe Text -> IO (Either ResponseError ())

Perform a SASL EXTERNAL Bind operation synchronously. Returns Left e where e is a ResponseError on failures.

externalBindAsync :: Ldap -> Dn -> Maybe Text -> IO (Async ())

Perform the SASL EXTERNAL Bind operation asynchronously. Call wait to wait for its completion.

externalBindAsyncSTM :: Ldap -> Dn -> Maybe Text -> STM (Async ())

Perform the SASL EXTERNAL Bind operation asynchronously.

Don't wait for its completion (with waitSTM) in the same transaction you've performed it in.

data Async a

Asynchronous LDAP operation. Use wait or waitSTM to wait for its completion.

Instances

Functor Async

Defined in Ldap.Client.Internal

Methods

fmap :: (a -> b) -> Async a -> Async b

(<$) :: a -> Async b -> Async a

wait :: Async a -> IO (Either ResponseError a)

Wait for operation completion.

waitSTM :: Async a -> STM (Either ResponseError a)

Wait for operation completion inside STM.

Do not use this inside the same STM transaction the operation was requested in! To give LDAP the chance to respond to it that transaction should commit. After that, applying waitSTM to the corresponding Async starts to make sense.