Network.Riak.Cluster

Documentation

data Cluster

Datatype holding connection-pool with all known cluster nodes

Constructors

Cluster

Fields

clusterPools :: Vector Pool

Vector of connection pools to riak cluster nodes

clusterGen :: PureMT

Instances

Show Cluster

data InClusterError

Error that gets thrown whenever operation couldn't succeed with any node.

Constructors

InClusterError [SomeException]

Instances

Show InClusterError

Exception InClusterError

Typeable * InClusterError

connectToCluster :: [Client] -> IO Cluster

Function to connect to riak cluster with sane pool defaults

inCluster :: (MonadThrow m, MonadBaseControl IO m) => Cluster -> (Connection -> m a) -> m a

Tries to run some operation for a random riak node. If it fails, tries all other nodes. If all other nodes fail - throws InClusterError exception.

create

Arguments

:: Client

Client configuration. The client ID is ignored, and always regenerated automatically for each new connection.

-> Int

Stripe count. The number of distinct sub-pools to maintain. The smallest acceptable value is 1.

-> NominalDiffTime

Amount of time for which an unused connection is kept open. The smallest acceptable value is 0.5 seconds.

The elapsed time before closing may be a little longer than requested, as the reaper thread wakes at 2-second intervals.

-> Int

Maximum number of connections to keep open per stripe. The smallest acceptable value is 1.

Requests for connections will block if this limit is reached on a single stripe, even if other stripes have idle connections available.

-> IO Pool

Create a new connection pool.

defaultClient :: Client

Default client configuration. Talks to localhost, port 8087, with a randomly chosen client ID.