Data.ConnectionPool.Internal.Unix

Module defines type family of connection pools that is later specialised using type tags (phantom types) to specialize implementation of underlying ConnectionPool for various protocols.

Internal packages are here to provide access to internal definitions for library writers, but they should not be used in application code.

Preferably use qualified import, e.g.:

import qualified Data.ConnectionPool.Internal.Unix as Internal

This package is OS specific, because Windows doesn't support UNIX Sockets. Please, bear this in mind when doing modifications.

Module introduced in version 0.2.

Documentation

data family ConnectionPool :: k -> *

Family of connection pools parametrised by transport protocol.

Definition changed version 0.2 to be kind polymorphic (only on GHC >= 7.10) and became part of stable API by being moved in to Data.ConnectionPool.Family module.

Instances

HasConnectionPool HandlerParams Socket () (ConnectionPool * UnixClient)

Since version 0.2.

Methods

connectionPool :: Functor f => (ConnectionPool HandlerParams Socket () -> f (ConnectionPool HandlerParams Socket ())) -> ConnectionPool * UnixClient -> f (ConnectionPool * UnixClient)

HasConnectionPool HandlerParams Socket SockAddr (ConnectionPool * TcpClient)

Since version 0.2.

Methods

connectionPool :: Functor f => (ConnectionPool HandlerParams Socket SockAddr -> f (ConnectionPool HandlerParams Socket SockAddr)) -> ConnectionPool * TcpClient -> f (ConnectionPool * TcpClient)

Show (ConnectionPool * TcpClient)

Methods

showsPrec :: Int -> ConnectionPool * TcpClient -> ShowS

show :: ConnectionPool * TcpClient -> String

showList :: [ConnectionPool * TcpClient] -> ShowS

Show (ConnectionPool * UnixClient)

Methods

showsPrec :: Int -> ConnectionPool * UnixClient -> ShowS

show :: ConnectionPool * UnixClient -> String

showList :: [ConnectionPool * UnixClient] -> ShowS

Generic (ConnectionPool * TcpClient)

Associated Types

type Rep (ConnectionPool * TcpClient) :: * -> *

Methods

from :: ConnectionPool * TcpClient -> Rep (ConnectionPool * TcpClient) x

to :: Rep (ConnectionPool * TcpClient) x -> ConnectionPool * TcpClient

Generic (ConnectionPool * UnixClient)

Associated Types

type Rep (ConnectionPool * UnixClient) :: * -> *

Methods

from :: ConnectionPool * UnixClient -> Rep (ConnectionPool * UnixClient) x

to :: Rep (ConnectionPool * UnixClient) x -> ConnectionPool * UnixClient

data ConnectionPool * TcpClient

Connection pool for TCP clients.

Definition changed in version 0.1.3 and 0.2. Instances for Generic and Show introduced in version 0.2.

data ConnectionPool * TcpClient = TcpConnectionPool (ConnectionPool HandlerParams Socket SockAddr)

data ConnectionPool * UnixClient

Connection pool for UNIX Socket clients.

Definition changed in version 0.1.3 and 0.2. Instances for Generic and Show introduced in version 0.2.

data ConnectionPool * UnixClient = UnixConnectionPool (ConnectionPool HandlerParams Socket ())

type Rep (ConnectionPool * TcpClient)

type Rep (ConnectionPool * TcpClient) = D1 (MetaData "ConnectionPool" "Data.ConnectionPool.Internal.TCP" "connection-pool-0.2.1-FnRFrUPenjkD5VjSuGxxKR" True) (C1 (MetaCons "TcpConnectionPool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConnectionPool HandlerParams Socket SockAddr))))

type Rep (ConnectionPool * UnixClient)

type Rep (ConnectionPool * UnixClient) = D1 (MetaData "ConnectionPool" "Data.ConnectionPool.Internal.Unix" "connection-pool-0.2.1-FnRFrUPenjkD5VjSuGxxKR" True) (C1 (MetaCons "UnixConnectionPool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConnectionPool HandlerParams Socket ()))))

data UnixClient

Type tag used to specialize connection pool for UNIX Socket clients.

Instance for Generic introduced in version 0.2.

Instances

Generic UnixClient

Associated Types

type Rep UnixClient :: * -> *

Methods

from :: UnixClient -> Rep UnixClient x

to :: Rep UnixClient x -> UnixClient

HasConnectionPool HandlerParams Socket () (ConnectionPool * UnixClient)

Since version 0.2.

Methods

connectionPool :: Functor f => (ConnectionPool HandlerParams Socket () -> f (ConnectionPool HandlerParams Socket ())) -> ConnectionPool * UnixClient -> f (ConnectionPool * UnixClient)

ConnectionPoolFor * UnixClient

Defined using:

withConnection = withUnixClientConnection
destroyAllConnections = destroyAllUnixClientConnections

Since version 0.2.

Associated Types

type HandlerData UnixClient (protocol :: UnixClient) :: *

Methods

withConnection :: MonadBaseControl IO m => ConnectionPool UnixClient protocol -> (HandlerData UnixClient protocol -> m r) -> m r

tryWithConnection :: MonadBaseControl IO m => ConnectionPool UnixClient protocol -> (HandlerData UnixClient protocol -> m r) -> m (Maybe r)

destroyAllConnections :: ConnectionPool UnixClient protocol -> IO ()

Show (ConnectionPool * UnixClient)

Methods

showsPrec :: Int -> ConnectionPool * UnixClient -> ShowS

show :: ConnectionPool * UnixClient -> String

showList :: [ConnectionPool * UnixClient] -> ShowS

Generic (ConnectionPool * UnixClient)

Associated Types

type Rep (ConnectionPool * UnixClient) :: * -> *

Methods

from :: ConnectionPool * UnixClient -> Rep (ConnectionPool * UnixClient) x

to :: Rep (ConnectionPool * UnixClient) x -> ConnectionPool * UnixClient

type Rep UnixClient

type Rep UnixClient = D1 (MetaData "UnixClient" "Data.ConnectionPool.Internal.Unix" "connection-pool-0.2.1-FnRFrUPenjkD5VjSuGxxKR" False) V1

data ConnectionPool * UnixClient

Connection pool for UNIX Socket clients.

Definition changed in version 0.1.3 and 0.2. Instances for Generic and Show introduced in version 0.2.

data ConnectionPool * UnixClient = UnixConnectionPool (ConnectionPool HandlerParams Socket ())

type HandlerData * UnixClient

type HandlerData * UnixClient = AppDataUnix

type Rep (ConnectionPool * UnixClient)

type Rep (ConnectionPool * UnixClient) = D1 (MetaData "ConnectionPool" "Data.ConnectionPool.Internal.Unix" "connection-pool-0.2.1-FnRFrUPenjkD5VjSuGxxKR" True) (C1 (MetaCons "UnixConnectionPool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConnectionPool HandlerParams Socket ()))))

createUnixClientPool :: ResourcePoolParams -> ClientSettingsUnix -> IO (ConnectionPool UnixClient)

Create connection pool for UNIX Sockets clients.

withUnixClientConnection :: (MonadBaseControl io m, io ~ IO) => ConnectionPool UnixClient -> (AppDataUnix -> m r) -> m r

Temporarily take a UNIX Sockets connection from a pool, run client with it, and return it to the pool afterwards. For details how connections are allocated see withResource.

tryWithUnixClientConnection :: (MonadBaseControl io m, io ~ IO) => ConnectionPool UnixClient -> (AppDataUnix -> m r) -> m (Maybe r)

Similar to withConnection, but only performs action if a UNIX Sockets connection could be taken from the pool without blocking. Otherwise, tryWithResource returns immediately with Nothing (ie. the action function is not called). Conversely, if a connection can be acquired from the pool without blocking, the action is performed and it's result is returned, wrapped in a Just.

Since version 0.2.

destroyAllUnixClientConnections :: ConnectionPool UnixClient -> IO ()

Destroy all UNIX Sockets connections that might be still open in a connection pool. This is useful when one needs to release all resources at once and not to wait for idle timeout to be reached.

For more details see destroyAllResources.

Since version 0.1.1.0.