diff options
Diffstat (limited to 'deps/amqp_client/src/overview.edoc.in')
| -rw-r--r-- | deps/amqp_client/src/overview.edoc.in | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/deps/amqp_client/src/overview.edoc.in b/deps/amqp_client/src/overview.edoc.in new file mode 100644 index 0000000000..799b293239 --- /dev/null +++ b/deps/amqp_client/src/overview.edoc.in @@ -0,0 +1,27 @@ +@title AMQP Client for Erlang +@author GoPivotal Inc. <support@rabbitmq.com> +@copyright 2007-2020 VMware, Inc. or its affiliates. + +@version %%VERSION%% + +@reference <a href="https://www.rabbitmq.com/protocol.html" target="_top">AMQP documentation</a> on the RabbitMQ website. + +@doc + +== Overview == + +This application provides an Erlang library to interact with an AMQP 0-9-1 compliant message broker. The module documentation assumes that the programmer has some basic familiarity with the execution model defined in the AMQP specification. + +The main components are {@link amqp_connection} and {@link amqp_channel}. The {@link amqp_connection} module is used to open and close connections to an AMQP broker as well as creating channels. The {@link amqp_channel} module is used to send and receive commands and messages to and from a broker within the context of a channel. + +== AMQP Record Definitions == + +Many of the API functions take structured records as arguments. These records represent the commands defined in the AMQP execution model. The definitions for these records are automatically generated by the rabbitmq-codegen project. rabbitmq-codegen parses a machine readable view of the specification and generates a header file that includes the entire command set of AMQP. Each command in AMQP has an identically named record. The protocol documentation serves as a reference for the attributes of each command. + +== Programming Model == + +For more information, refer to the Erlang AMQP client <a href="https://www.rabbitmq.com/erlang-client-user-guide.html">developer's guide</a> on the RabbitMQ website. + +== RPC Components == + +The {@link amqp_rpc_server} module provides a generic building block to expose Erlang functions via an RPC over AMQP mechanism. The {@link amqp_rpc_client} provides a simple client utility to submit RPC requests to a server via AMQP. |