Safe Haskell	None
Language	Haskell2010

Ldap.Client.Bind

Description

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.

Synopsis

Documentation

newtype Password Source

User's password.

Constructors

Password ByteString

Instances

Eq Password
Show Password

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

Perform the Bind operation synchronously. Raises ResponseError on failures.

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

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

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

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

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

Perform the Bind operation asynchronously.

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

data Async a Source

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

Instances

Functor Async

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

Wait for operation completion.

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

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.