Copyright	(c) 2014-2016 Peter Trško
License	BSD3
Maintainer	peter.trsko@gmail.com
Stability	unstable (internal module)
Portability	GHC specific language extensions.
Safe Haskell	None
Language	Haskell2010

Data.ConnectionPool.Internal.TCP

Description

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.TCP as Internal

Module introduced in version 0.2.

Synopsis

Documentation

data family ConnectionPool :: k -> * Source #

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) Source #	Since version 0.2.
Methods connectionPool :: Functor f => (ConnectionPool HandlerParams Socket () -> f (ConnectionPool HandlerParams Socket ())) -> ConnectionPool * UnixClient -> f (ConnectionPool * UnixClient) Source #
HasConnectionPool HandlerParams Socket SockAddr (ConnectionPool * TcpClient) Source #	Since version 0.2.
Methods connectionPool :: Functor f => (ConnectionPool HandlerParams Socket SockAddr -> f (ConnectionPool HandlerParams Socket SockAddr)) -> ConnectionPool * TcpClient -> f (ConnectionPool * TcpClient) Source #
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 Source #	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 Source #	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-CBLA23bwktW3txVQVHUtSC" 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-CBLA23bwktW3txVQVHUtSC" True) (C1 (MetaCons "UnixConnectionPool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConnectionPool HandlerParams Socket ()))))

data TcpClient Source #

Type tag used to specialize connection pool for TCP clients.

Instance for Generic introduced in version 0.2.

Instances

Generic TcpClient Source #
Associated Types type Rep TcpClient :: * -> * # Methods from :: TcpClient -> Rep TcpClient x # to :: Rep TcpClient x -> TcpClient #
HasConnectionPool HandlerParams Socket SockAddr (ConnectionPool * TcpClient) Source #	Since version 0.2.
Methods connectionPool :: Functor f => (ConnectionPool HandlerParams Socket SockAddr -> f (ConnectionPool HandlerParams Socket SockAddr)) -> ConnectionPool * TcpClient -> f (ConnectionPool * TcpClient) Source #
ConnectionPoolFor * TcpClient Source #	Defined using: `withConnection` = `withTcpClientConnection` `destroyAllConnections` = `destroyAllTcpClientConnections` Since version 0.2.
Associated Types type HandlerData TcpClient (protocol :: TcpClient) :: * Source # Methods withConnection :: MonadBaseControl IO m => ConnectionPool TcpClient protocol -> (HandlerData TcpClient protocol -> m r) -> m r Source # tryWithConnection :: MonadBaseControl IO m => ConnectionPool TcpClient protocol -> (HandlerData TcpClient protocol -> m r) -> m (Maybe r) Source # destroyAllConnections :: ConnectionPool TcpClient protocol -> IO () Source #
Show (ConnectionPool * TcpClient) Source #
Methods showsPrec :: Int -> ConnectionPool * TcpClient -> ShowS # show :: ConnectionPool * TcpClient -> String # showList :: [ConnectionPool * TcpClient] -> ShowS #
Generic (ConnectionPool * TcpClient) Source #
Associated Types type Rep (ConnectionPool * TcpClient) :: * -> * # Methods from :: ConnectionPool * TcpClient -> Rep (ConnectionPool * TcpClient) x # to :: Rep (ConnectionPool * TcpClient) x -> ConnectionPool * TcpClient #
type Rep TcpClient Source #
type Rep TcpClient = D1 (MetaData "TcpClient" "Data.ConnectionPool.Internal.TCP" "connection-pool-0.2.1-CBLA23bwktW3txVQVHUtSC" False) V1
data ConnectionPool * TcpClient Source #	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)
type HandlerData * TcpClient Source #
type HandlerData * TcpClient = AppData
type Rep (ConnectionPool * TcpClient) Source #
type Rep (ConnectionPool * TcpClient) = D1 (MetaData "ConnectionPool" "Data.ConnectionPool.Internal.TCP" "connection-pool-0.2.1-CBLA23bwktW3txVQVHUtSC" True) (C1 (MetaCons "TcpConnectionPool" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ConnectionPool HandlerParams Socket SockAddr))))

createTcpClientPool :: ResourcePoolParams -> ClientSettings -> IO (ConnectionPool TcpClient) Source #

Create connection pool for TCP clients.

withTcpClientConnection :: (MonadBaseControl io m, io ~ IO) => ConnectionPool TcpClient -> (AppData -> m r) -> m r Source #

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

tryWithTcpClientConnection :: (MonadBaseControl io m, io ~ IO) => ConnectionPool TcpClient -> (AppData -> m r) -> m (Maybe r) Source #

Similar to withConnection, but only performs action if a TCP 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.

destroyAllTcpClientConnections :: ConnectionPool TcpClient -> IO () Source #

Destroy all TCP 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.