Database.MongoDB.Connection

Contents

Description

A pool of TCP connections to a single server or a replica set of servers.

Synopsis

Pipe

type Pipe = Pipeline Message ResponseSource

Thread-safe TCP connection with pipelined requests

Host

data Host Source

Constructors

Host HostName PortID

Instances

Eq Host
Ord Host
Show Host
Service Host
Show (ConnPool Host)

data PortID

Constructors

Service String
PortNumber PortNumber
UnixSocket String

Instances

Eq PortID
Ord PortID
Show PortID

host :: HostName -> Host Source

Host on default MongoDB port

showHostPort :: Host -> String Source

Display host as "host:port" TODO: Distinguish Service and UnixSocket port

readHostPort :: String -> Host Source

Read string "hostname:port" as Host hostname port or "hostname" as host hostname (default port). Error if string does not match either syntax.

readHostPortM :: Monad m => String -> m Host Source

Read string "hostname:port" as Host hosthame port or "hostname" as host hostname (default port). Fail if string does not match either syntax. TODO: handle Service and UnixSocket port

ReplicaSet

data ReplicaSet Source

Replica set of hosts identified by set name. At least one of the seed hosts must be an active member of the set. However, this list is not used to identify the set, just the set name.

Constructors

ReplicaSet
Fields setName :: Name seedHosts :: [Host]

Instances

Eq ReplicaSet
Show ReplicaSet
Service ReplicaSet
Show (ConnPool ReplicaSet)

type Name = UString Source

MasterOrSlaveOk

data MasterOrSlaveOk Source

Constructors

Master	connect to master only
SlaveOk	connect to a slave, or master if no slave available

Instances

Eq MasterOrSlaveOk
Show MasterOrSlaveOk
Monad m => Context MasterOrSlaveOk (Action m)

Connection Pool

class Service t whereSource

A Service is a single server (Host) or a replica set of servers (ReplicaSet)

Associated Types

data ConnPool t Source

A pool of TCP connections (Pipes) to a host or a replica set of hosts

Methods

newConnPool :: NetworkIO m => Int -> t -> m (ConnPool t)Source

Create a ConnectionPool to a host or a replica set of hosts. Actual TCP connection is not attempted until getPipe request, so no IOError can be raised here. Up to N TCP connections will be established to each host.

getPipe :: MasterOrSlaveOk -> ConnPool t -> IOE Pipe Source

Return a TCP connection (Pipe) to the master or a slave in the server. Master must connect to the master, SlaveOk may connect to a slave or master. To spread the load, SlaveOk requests are distributed amongst all hosts in the server. Throw IOError if failed to connect to right type of host (Master/SlaveOk).

killPipes :: ConnPool t -> IO ()Source

Kill all open pipes (TCP Connections). Will cause any users of them to fail. Alternatively you can let them die on their own when they get garbage collected.

Instances

Service Host
Service ReplicaSet

connHost :: ConnPool Host -> Host Source

replicaSet :: MonadIO' m => ConnPool ReplicaSet -> m ReplicaSet Source

Return replicas set name with current members as seed list