Overview

Module amqp_channel

• Description
• Data Types
• Function Index
• Function Details

Behaviours: gen_server.

Description

  normal

  close_reason(app_initiated_close)

  close_reason(server_initiated_close)

  close_reason(server_misbehaved)

  {shutdown, {connection_closing, amqp_reason(atom())}}

Data Types

amqp_method()

abstract datatype: amqp_method()

This abstract datatype represents the set of methods that comprise the AMQP execution model. As indicated in the overview, the attributes of each method in the execution model are described in the protocol documentation. The Erlang record definitions are autogenerated from a parseable version of the specification. Most fields in the generated records have sensible default values that you need not worry in the case of a simple usage of the client library.

amqp_msg()

amqp_msg() = #amqp_msg{}

This is the content encapsulated in content-bearing AMQP methods. It contains the following fields:

• props :: class_property() - A class property record, defaults to #'P_basic'{}
• payload :: binary() - The arbitrary data payload

amqp_reason()

amqp_reason(Type) = {Type, Code, Text}

• Code = non_neg_integer()
• Text = binary()

close_reason()

close_reason(Type) = {shutdown, amqp_reason(Type)}

Function Index

Function Details

call/2

This is equivalent to amqp_channel:call(Channel, Method, none).

call/3

This sends an AMQP method on the channel. For content bearing methods, Content has to be an amqp_msg(), whereas for non-content bearing methods, it needs to be the atom 'none'.
In the case of synchronous methods, this function blocks until the corresponding reply comes back from the server and returns it. In the case of asynchronous methods, the function blocks until the method gets sent on the wire and returns the atom 'ok' on success.
This will return the atom 'blocked' if the server has throttled the client for flow control reasons. This will return the atom 'closing' if the channel is in the process of shutting down.
Note that for asynchronous methods, the synchronicity implied by 'call' only means that the client has transmitted the method to the broker. It does not necessarily imply that the broker has accepted responsibility for the message.

call_consumer/2

This causes the channel to invoke Consumer:handle_call/2, where Consumer is the amqp_gen_consumer implementation registered with the channel.

cast/2

This is equivalent to amqp_channel:cast(Channel, Method, none).

cast/3

This function is the same as call/3, except that it returns immediately with the atom 'ok', without blocking the caller process. This function is not recommended with synchronous methods, since there is no way to verify that the server has received the method.

cast_flow/3

Like cast/3, with flow control.

close/1

Closes the channel, invokes close(Channel, 200, <<"Goodbye">>).

close/3

Closes the channel, allowing the caller to supply a reply code and text. If the channel is already closing, the atom 'closing' is returned.

enable_delivery_flow_control/1

next_publish_seqno/1

When in confirm mode, returns the sequence number of the next message to be published.

notify_received/1

register_confirm_handler/2

This registers a handler to deal with confirm-related messages. The registered process will receive #basic.ack{} and #basic.nack{} commands.

register_flow_handler/2

This registers a handler to deal with channel flow notifications. The registered process will receive #channel.flow{} records.

register_return_handler/2

This registers a handler to deal with returned messages. The registered process will receive #basic.return{} records.

set_writer/2

subscribe/3

Subscribe the given pid to a queue using the specified basic.consume method.

unregister_confirm_handler/1

Removes the confirm handler, if it exists. Does nothing if there is no such handler.

unregister_flow_handler/1

Removes the flow handler, if it exists. Does nothing if there is no such handler.

unregister_return_handler/1

Removes the return handler, if it exists. Does nothing if there is no such handler.

wait_for_confirms/1

Wait until all messages published since the last call have been either ack'd or nack'd by the broker. Note, when called on a non-Confirm channel, waitForConfirms returns an error.

wait_for_confirms/2

Wait until all messages published since the last call have been either ack'd or nack'd by the broker or the timeout expires. Note, when called on a non-Confirm channel, waitForConfirms throws an exception.

wait_for_confirms_or_die/1

Behaves the same as wait_for_confirms/1, but if a nack is received, the calling process is immediately sent an exit(nack_received).

wait_for_confirms_or_die/2

Behaves the same as wait_for_confirms/1, but if a nack is received, the calling process is immediately sent an exit(nack_received). If the timeout expires, the calling process is sent an exit(timeout).

Overview

Generated by EDoc