Network.AMQP.Worker.Connection

Documentation

connect :: MonadIO m => ConnectionOpts -> m Connection

Connect to the AMQP server using simple defaults

conn <- connect (fromURI "amqp://guest:guest@localhost:5672")

connect' :: MonadIO m => ConnectionOpts -> WorkerOpts -> m Connection

disconnect :: MonadIO m => Connection -> m ()

withChannel :: Connection -> (Channel -> IO b) -> IO b

Perform an action with a channel resource, and give it back at the end

data Connection

Constructors

Connection

Fields

• amqpConn :: MVar Connection
• pool :: Pool Channel
• exchange :: ExchangeName

data WorkerOpts

Constructors

WorkerOpts

Fields

• exchange :: ExchangeName

  Everything goes on one exchange

• openTime :: Double

  Number of seconds connections in the pool remain open for re-use

• maxChannels :: Int

  Number of concurrent connectinos available in the pool

• numStripes :: Maybe Int

Instances

Show WorkerOpts

Defined in Network.AMQP.Worker.Connection

Methods

showsPrec :: Int -> WorkerOpts -> ShowS

show :: WorkerOpts -> String

showList :: [WorkerOpts] -> ShowS

Eq WorkerOpts

Defined in Network.AMQP.Worker.Connection

Methods

(==) :: WorkerOpts -> WorkerOpts -> Bool

(/=) :: WorkerOpts -> WorkerOpts -> Bool

type ExchangeName = Text

data ConnectionOpts

Represents the parameters to connect to a broker or a cluster of brokers. See defaultConnectionOpts.

Constructors

ConnectionOpts

Fields

• coServers :: ![(String, PortNumber)]

  A list of host-port pairs. Useful in a clustered setup to connect to the first available host.

• coVHost :: !Text

  The VHost to connect to.

• coAuth :: ![SASLMechanism]

  The SASLMechanisms to use for authenticating with the broker.

• coMaxFrameSize :: !(Maybe Word32)

  The maximum frame size to be used. If not specified, no limit is assumed.

• coHeartbeatDelay :: !(Maybe Word16)

  The delay in seconds, after which the client expects a heartbeat frame from the broker. If Nothing, the value suggested by the broker is used. Use Just 0 to disable the heartbeat mechnism.

• coMaxChannel :: !(Maybe Word16)

  The maximum number of channels the client will use.

• coTLSSettings :: Maybe TLSSettings

  Whether or not to connect to servers using TLS. See http://www.rabbitmq.com/ssl.html for details.

• coName :: !(Maybe Text)

  optional connection name (will be displayed in the RabbitMQ web interface)

defaultConnectionOpts :: ConnectionOpts

Constructs default connection options with the following settings :

• Broker: amqp://guest:guest@localhost:5672/%2F using the PLAIN SASL mechanism
• max frame size: 131072
• use the heartbeat delay suggested by the broker
• no limit on the number of used channels

fromURI :: String -> ConnectionOpts

Parses amqp standard URI of the form amqp://user:passwordhost:port/vhost and returns a ConnectionOpts for use with openConnection'' | Any of these fields may be empty and will be replaced with defaults from amqp:/guest:guest@localhost:5672@