| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ldap.Client.Extended
Description
Extended operation.
This operation comes in four flavours:
- synchronous, exception throwing (
extended) - synchronous, returning
EitherResponseError()(extendedEither) - asynchronous,
IObased (extendedAsync) - asynchronous,
STMbased (extendedAsyncSTM)
Of those, the first one (extended) is probably the most useful for the typical usecase.
- newtype Oid = Oid Text
- extended :: Ldap -> Oid -> Maybe ByteString -> IO ()
- extendedEither :: Ldap -> Oid -> Maybe ByteString -> IO (Either ResponseError ())
- extendedAsync :: Ldap -> Oid -> Maybe ByteString -> IO (Async ())
- extendedAsyncSTM :: Ldap -> Oid -> Maybe ByteString -> STM (Async ())
- startTls :: Ldap -> IO ()
- startTlsEither :: Ldap -> IO (Either ResponseError ())
- startTlsAsync :: Ldap -> IO (Async ())
- startTlsAsyncSTM :: Ldap -> STM (Async ())
- data Async a
- wait :: Async a -> IO (Either ResponseError a)
- waitSTM :: Async a -> STM (Either ResponseError a)
Extended Operation
Globally unique LDAP object identifier.
extended :: Ldap -> Oid -> Maybe ByteString -> IO () Source
Perform the Extended operation synchronously. Raises ResponseError on failures.
extendedEither :: Ldap -> Oid -> Maybe ByteString -> IO (Either ResponseError ()) Source
Perform the Extended operation synchronously. Returns Left e where
e is a ResponseError on failures.
extendedAsync :: Ldap -> Oid -> Maybe ByteString -> IO (Async ()) Source
Perform the Extended operation asynchronously. Call wait to wait
for its completion.
extendedAsyncSTM :: Ldap -> Oid -> Maybe ByteString -> STM (Async ()) Source
Perform the Extended operation asynchronously.
Don't wait for its completion (with waitSTM) in the
same transaction you've performed it in.
StartTLS Operation
startTlsEither :: Ldap -> IO (Either ResponseError ()) Source
An example of Extended Operation, cf. extendedEither.
startTlsAsync :: Ldap -> IO (Async ()) Source
An example of Extended Operation, cf. extendedAsync.
startTlsAsyncSTM :: Ldap -> STM (Async ()) Source
An example of Extended Operation, cf. extendedAsyncSTM.