GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  ANYEVENT::RABBITMQ::CHANNEL (3)

.ds Aq ’

NAME

AnyEvent::RabbitMQ::Channel - Abstraction of an AMQP channel.

CONTENTS

SYNOPSIS



    my $ch = $rf->open_channel();
    $ch->declare_exchange(exchange => test_exchange);



DESCRIPTION

ARGUMENTS FOR open_channel

on_close Callback invoked when the channel closes. Callback will be passed the incoming message that caused the close, if any.
on_return Callback invoked when a mandatory or immediate message publish fails. Callback will be passed the incoming message, with accessors method_frame, header_frame, and body_frame.

METHODS

    declare_exchange (%args)

Declare an exchange (to publish messages to) on the server.

Arguments:
on_success
on_failure
type Default ’direct’
passive Default 0
durable Default 0
auto_delete Default 0
internal Default 0
exchange The name of the exchange

    bind_exchange

Binds an exchange to another exchange, with a routing key.

Arguments:
source The name of the source exchange to bind
destination The name of the destination exchange to bind
routing_key The routing key to bind with

    unbind_exchange

    delete_exchange

    declare_queue

    bind_queue

Binds a queue to an exchange, with a routing key.

Arguments:
queue The name of the queue to bind
exchange The name of the exchange to bind
routing_key The routing key to bind with

    unbind_queue

    purge_queue

Flushes the contents of a queue.

    delete_queue

Deletes a queue. The queue may not have any active consumers.

    publish

Publish a message to an exchange

Arguments:
body The text body of the message to send.
header Customer headers for the message (if any).
exchange The name of the exchange to send the message to.
routing_key The routing key with which to publish the message.
on_ack Callback (if any) for confirming acknowledgment when in confirm mode.

    consume

Subscribe to consume messages from a queue.

Arguments:
on_consume Callback called with an argument of the message which has been consumed.
on_cancel Callback called if consumption is canceled. This may be at client request or as a side effect of queue deletion. (Notification of queue deletion is a RabbitMQ extension.)
consumer_tag Identifies this consumer, will be auto-generated if you do not provide it, but you must supply a value if you want to be able to later cancel the subscription.
on_success Callback called if the subscription was successful (before the first message is consumed).
on_failure Callback called if the subscription fails for any reason.

    publish

Publish a message to an exchange.

Arguments:
header Hash of AMQP message header info, including the confusingly similar element headers, which may contain arbitrary string key/value pairs.
body Message body.
mandatory Boolean; if true, then if the message doesn’t land in a queue (e.g. the exchange has no bindings), it will be returned. (see on_return)
immediate Boolean; if true, then if the message cannot be delivered directly to a consumer, it will be returned. (see on_return)
on_ack Callback called with the frame that acknowledges receipt (if channel is in confirm mode), typically Net::AMQP::Protocol::Basic::Ack.
on_nack Callback called with the frame that declines receipt (if the channel is in confirm mode), typically Net::AMQP::Protocol::Basic::Nack or Net::AMQP::Protocol::Channel::Close.
on_return In AMQP, a returned message is one that cannot be delivered in compliance with the immediate or mandatory flags.

If in confirm mode, this callback will be called with the frame that reports message return, typically Net::AMQP::Protocol::Basic::Return. If confirm mode is off or this callback is not provided, then the channel or connection objects’ on_return callbacks (if any), will be called instead.

NOTE: If confirm mode is on, the on_ack or on_nack callback will be called whether or not on_return is called first.

    cancel

Cancel a queue subscription.

Note that the cancellation <B>will notB> take place at once, and further messages may be consumed before the subscription is cancelled. No further messages will be consumed after the on_success callback has been called.

Arguments:
consumer_tag Identifies this consumer, needs to be the value supplied when the queue is initially consumed from.
on_success Callback called if the subscription was successfully cancelled.
on_failure Callback called if the subscription could not be cancelled for any reason.

    get

Try to get a single message from a queue.

Arguments:
queue Mandatory. Name of the queue to try to receive a message from.
on_success Will be called either with either a message, or, if the queue is empty, a notification that there was nothing to collect from the queue.
on_failure This callback will be called if an error is signalled on this channel.

    ack

    qos

    confirm

Put channel into confirm mode. In confirm mode, publishes are confirmed by the server, so the on_ack callback of publish works.

    recover

    select_tx

    commit_tx

    rollback_tx

AUTHOR, COPYRIGHT AND LICENSE

See AnyEvent::RabbitMQ for author(s), copyright and license.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 ANYEVENT::RABBITMQ::CHANNEL (3) 2014-09-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.