mirror of
https://github.com/ZeroTier/ZeroTierOne
synced 2025-08-20 21:33:57 -07:00
Beginning CMake configuration for ZT
Only tested on Windows so far
This commit is contained in:
parent
af5d3a7f0b
commit
0b3b5f6174
111 changed files with 19586 additions and 36 deletions
223
ext/librabbitmq/tools/doc/amqp-consume.xml
Normal file
223
ext/librabbitmq/tools/doc/amqp-consume.xml
Normal file
|
@ -0,0 +1,223 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>amqp-consume</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>amqp-consume</refname>
|
||||
<refpurpose>Consume messages from a queue on an AMQP server</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>amqp-consume</command>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>OPTION</replaceable>
|
||||
</arg>
|
||||
<arg choice="req">
|
||||
<replaceable>command</replaceable>
|
||||
</arg>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>args</replaceable>
|
||||
</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<command>amqp-consume</command> consumes messages from a
|
||||
queue on an AMQP server. For each message that arrives, a
|
||||
receiving command is run, with the message body supplied
|
||||
to it on standard input.
|
||||
</para>
|
||||
<para>
|
||||
<command>amqp-consume</command> can consume from an
|
||||
existing queue, or it can create a new queue. It can
|
||||
optionally bind the queue to an existing exchange.
|
||||
</para>
|
||||
<para>
|
||||
By default, messages will be consumed with explicit
|
||||
acknowledgements. A message will only be acknowledged if
|
||||
the receiving command exits successfully (i.e. with an
|
||||
exit code of zero). The AMQP <quote>no ack</quote> mode
|
||||
(a.k.a. auto-ack mode) can be enable with the
|
||||
<option>-A</option> option.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-q</option></term>
|
||||
<term><option>--queue</option>=<replaceable class="parameter">queue name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the queue to consume messages
|
||||
from.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If the <option>--queue</option> option is
|
||||
omitted, the AMQP server will assign a unique
|
||||
name to the queue, and that server-assigned
|
||||
name will be dixsplayed on stderr; this case
|
||||
implies that an exclusive queue should be
|
||||
declared.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-e</option></term>
|
||||
<term><option>--exchange</option>=<replaceable class="parameter">exchange name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies that an exclusive queue should
|
||||
be declared, and bound to the given exchange.
|
||||
The specified exchange should already exist
|
||||
unless the <option>--exchange-type</option>
|
||||
option is used to request the creation of an
|
||||
exchange.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-r</option></term>
|
||||
<term><option>--routing-key</option>=<replaceable class="parameter">routing key</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The routing key for binding. If omitted, an
|
||||
empty routing key is assumed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-d</option></term>
|
||||
<term><option>--declare</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Forces an exclusive queue to be declared,
|
||||
even when it otherwise would not be. That is,
|
||||
when a queue name is specified with the
|
||||
<option>--queue</option> option, but no
|
||||
binding to an exchange is requested with the
|
||||
<option>--exchange</option> option.
|
||||
Note: this option is deprecated and may be
|
||||
removed in a future version, use the
|
||||
<option>--exclusive</option> option to
|
||||
explicitly declare an exclusive queue.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-x</option></term>
|
||||
<term><option>--exclusive</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Declared queues are non-exclusive by default,
|
||||
this option forces declaration of exclusive
|
||||
queues.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-A</option></term>
|
||||
<term><option>--no-ack</option>=<replaceable class="parameter">routing key</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Enable <quote>no ack</quote> mode: The AMQP
|
||||
server will unconditionally acknowledge each
|
||||
message that is delivered, regardless of
|
||||
whether the target command exits successfully
|
||||
or not.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-c</option></term>
|
||||
<term><option>--count</option>=<replaceable class="parameter">limit</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Stop consuming after the given number of
|
||||
messages have been received.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-p</option></term>
|
||||
<term><option>--prefetch-count</option>=<replaceable class="parameter">limit</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Request the server to only send
|
||||
<replaceable class="parameter">limit</replaceable>
|
||||
messages at a time.
|
||||
</para>
|
||||
<para>
|
||||
If any value was passed to <option>--count</option>,
|
||||
the value passed to <option>--prefetch-count</option>
|
||||
should be smaller than that, or otherwise it will be
|
||||
ignored.
|
||||
</para>
|
||||
<para>
|
||||
If <option>-A</option>/<option>--no-ack</option> is
|
||||
passed, this option has no effect.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Consume messages from an existing queue
|
||||
<quote><systemitem
|
||||
class="resource">myqueue</systemitem></quote>, and
|
||||
output the message bodies on standard output via
|
||||
<command>cat</command>:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-publish -q myqueue cat</userinput></screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Bind a new exclusive queue to an
|
||||
exchange <quote><systemitem
|
||||
class="resource">myexch</systemitem></quote>, and send
|
||||
each message body to the script
|
||||
<filename>myscript</filename>, automatically
|
||||
acknowledging them on the server:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-consume -A -e myexch ./myscript</userinput></screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
describes connection-related options common to all the
|
||||
RabbitMQ C Client tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
122
ext/librabbitmq/tools/doc/amqp-declare-queue.xml
Normal file
122
ext/librabbitmq/tools/doc/amqp-declare-queue.xml
Normal file
|
@ -0,0 +1,122 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>amqp-declare-queue</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>amqp-declare-queue</refname>
|
||||
<refpurpose>Declare (create or assert the existence of) a queue on an AMQP server</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>amqp-declare-queue</command>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>OPTION</replaceable>
|
||||
</arg>
|
||||
<arg choice="opt">-d</arg>
|
||||
<arg choice="req">-q <replaceable>queue name</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<command>amqp-declare-queue</command> attempts to create a
|
||||
queue on an AMQP server, and exits. If the empty-string is
|
||||
supplied as the queue name, a fresh queue name is
|
||||
generated by the server and returned. In all cases, if a
|
||||
queue was successfully declared, the (raw binary) name of
|
||||
the queue is printed to standard output, followed by a
|
||||
newline.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-q</option></term>
|
||||
<term><option>--queue</option>=<replaceable class="parameter">queue name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the queue to declare. If the
|
||||
empty string is supplied, a fresh queue name
|
||||
is generated by the server.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-d</option></term>
|
||||
<term><option>--durable</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Causes the queue to be declared with the
|
||||
"durable" flag set. Durable queues survive
|
||||
server restarts. By default, queues are declared
|
||||
in "transient" mode.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Exit Status</title>
|
||||
<para>
|
||||
If the queue was successfully declared, the exit status is
|
||||
0. If an error occurs, the exit status is 1.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Declare the durable queue <quote><systemitem
|
||||
class="resource">myqueue</systemitem></quote>, and
|
||||
display the name of the queue on standard output:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-declare-queue -d -q myqueue</userinput>
|
||||
myqueue</screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Declare a fresh, server-named transient queue,
|
||||
and display the name of the queue on standard output
|
||||
(use <citerefentry><refentrytitle>amqp-delete-queue</refentrytitle>
|
||||
<manvolnum>1</manvolnum></citerefentry> to delete
|
||||
it from the server once you're done):</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-declare-queue -q ""</userinput>
|
||||
amq.gen-BW/wvociA8g6LFpb1PlqOA==</screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
describes connection-related options common to all the
|
||||
RabbitMQ C Client tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
94
ext/librabbitmq/tools/doc/amqp-delete-queue.xml
Normal file
94
ext/librabbitmq/tools/doc/amqp-delete-queue.xml
Normal file
|
@ -0,0 +1,94 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>amqp-delete-queue</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>amqp-delete-queue</refname>
|
||||
<refpurpose>Delete a queue from an AMQP server</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>amqp-delete-queue</command>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>OPTION</replaceable>
|
||||
</arg>
|
||||
<arg choice="req">-q <replaceable>queue name</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<command>amqp-delete-queue</command> deletes a queue from
|
||||
an AMQP server, and exits after printing to standard
|
||||
output the number of messages that were in the queue at
|
||||
the time of its deletion.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-q</option></term>
|
||||
<term><option>--queue</option>=<replaceable class="parameter">queue name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the queue to delete.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Exit Status</title>
|
||||
<para>
|
||||
If the queue was successfully deleted, the exit status is
|
||||
0. If an error occurs, the exit status is 1.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Delete the
|
||||
queue <quote><systemitem class="resource">myqueue</systemitem></quote>
|
||||
at a moment when it has 123 messages waiting on
|
||||
it:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-delete-queue -q myqueue</userinput>
|
||||
123</screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
describes connection-related options common to all the
|
||||
RabbitMQ C Client tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
95
ext/librabbitmq/tools/doc/amqp-get.xml
Normal file
95
ext/librabbitmq/tools/doc/amqp-get.xml
Normal file
|
@ -0,0 +1,95 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>amqp-get</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>amqp-get</refname>
|
||||
<refpurpose>Get a message from a queue on an AMQP server</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>amqp-get</command>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>OPTION</replaceable>
|
||||
</arg>
|
||||
<arg choice="req">-q <replaceable>queue name</replaceable></arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<command>amqp-get</command> attempts to consume a single
|
||||
message from a queue on an AMQP server, and exits. Unless
|
||||
the queue was empty, the body of the resulting message is
|
||||
sent to standard output.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-q</option></term>
|
||||
<term><option>--queue</option>=<replaceable class="parameter">queue name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the queue to consume messages
|
||||
from.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Exit Status</title>
|
||||
<para>
|
||||
If the queue is not empty, and a message is successfully
|
||||
retrieved, the exit status is 0. If an error occurs, the
|
||||
exit status is 1. If the queue is found to be empty, the
|
||||
exit status is 2.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Get a message from the queue <quote><systemitem
|
||||
class="resource">myqueue</systemitem></quote>, and
|
||||
display its body on standard output:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-get -q myqueue</userinput></screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
describes connection-related options common to all the
|
||||
RabbitMQ C Client tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
169
ext/librabbitmq/tools/doc/amqp-publish.xml
Normal file
169
ext/librabbitmq/tools/doc/amqp-publish.xml
Normal file
|
@ -0,0 +1,169 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>amqp-publish</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>amqp-publish</refname>
|
||||
<refpurpose>Publish a message on an AMQP server</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<cmdsynopsis>
|
||||
<command>amqp-publish</command>
|
||||
<arg choice="opt" rep="repeat">
|
||||
<replaceable>OPTION</replaceable>
|
||||
</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Publishes a message to an exchange on an AMQP server.
|
||||
Options allow the various properties of the message and
|
||||
parameters of the AMQP <function>basic.publish</function>
|
||||
method to be specified.
|
||||
</para>
|
||||
<para>
|
||||
By default, the message body is read from standard input.
|
||||
Alternatively, the <option>-b</option> option allows the message
|
||||
body to be provided as part of the command.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-e</option></term>
|
||||
<term><option>--exchange</option>=<replaceable class="parameter">exchange name</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the exchange to publish to. If
|
||||
omitted, the default exchange (also known as
|
||||
the nameless exchange) is used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-r</option></term>
|
||||
<term><option>--routing-key</option>=<replaceable class="parameter">routing key</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The routing key to publish with. If omitted,
|
||||
an empty routing key is assumed. A routing
|
||||
key must be specified when publishing to the
|
||||
default exchange; in that case, accoding to
|
||||
the AMQP specification, the routing key
|
||||
corresponds to a queue name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-p</option></term>
|
||||
<term><option>--persistent</option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use the persistent delivery mode. Without
|
||||
this option, non-persistent delivery is used.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-C</option></term>
|
||||
<term><option>--content-type</option>=<replaceable class="parameter">MIME type</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies the content-type property for the
|
||||
message. If omitted, the content-type
|
||||
property is not set on the message.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-E</option></term>
|
||||
<term><option>--content-encoding</option>=<replaceable class="parameter">content coding</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies the content-encoding property for
|
||||
the message. If omitted, the content-encoding
|
||||
property is not set on the message.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-b</option></term>
|
||||
<term><option>--body</option>=<replaceable class="parameter">message body</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies the message body. If omitted, the
|
||||
message body is read from standard input.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-H</option></term>
|
||||
<term><option>--header</option>=<replaceable class="parameter">header</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Specifies an optional header in the form "key: value".
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Examples</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Send a short message, consisting of the word
|
||||
<quote><literal>Hello</literal></quote> to the queue
|
||||
<quote><systemitem
|
||||
class="resource">myqueue</systemitem></quote> via the
|
||||
default exchange:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-publish -r myqueue -b Hello</userinput></screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Send some XML data from a file to the exchange
|
||||
<quote><systemitem
|
||||
class="resource">events</systemitem></quote>, with
|
||||
persistent delivery mode, setting the content-type
|
||||
property on the message to make the data format
|
||||
explicit:</term>
|
||||
<listitem>
|
||||
<screen><prompt>$ </prompt><userinput>amqp-publish -e events -p -C text/xml <event.xml</userinput></screen>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<citerefentry><refentrytitle>librabbitmq-tools</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
||||
describes connection-related options common to all the
|
||||
RabbitMQ C Client tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
90
ext/librabbitmq/tools/doc/librabbitmq-tools.xml
Normal file
90
ext/librabbitmq/tools/doc/librabbitmq-tools.xml
Normal file
|
@ -0,0 +1,90 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd"
|
||||
[
|
||||
<!ENTITY date SYSTEM "man-date.ent" >
|
||||
]
|
||||
>
|
||||
<refentry lang="en">
|
||||
<refentryinfo>
|
||||
<productname>RabbitMQ C Client</productname>
|
||||
<authorgroup>
|
||||
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
|
||||
</authorgroup>
|
||||
<date>&date;</date>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>librabbitmq-tools</refentrytitle>
|
||||
<manvolnum>7</manvolnum>
|
||||
<refmiscinfo class="manual">RabbitMQ C Client</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>librabbitmq-tools</refname>
|
||||
<refpurpose>Command line AMQP tools</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A set of command line AMQP tools based on <systemitem
|
||||
class="library">librabbitmq</systemitem>. This page
|
||||
describes common options and conventions used by all of
|
||||
the tools.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Common Options</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-s</option></term>
|
||||
<term><option>--server</option>=<replaceable class="parameter">hostname:port</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The host name (or address) to connect to.
|
||||
Defaults to localhost. The port number may
|
||||
also be specified; if omitted, it defaults to
|
||||
the standard AMQP port number (5672).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--vhost</option>=<replaceable class="parameter">vhost</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The AMQP vhost to specify when connecting.
|
||||
Defaults to <literal>/</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--username</option>=<replaceable class="parameter">username</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The username to authenticate to the AMQP server with. Defaults to <literal>guest</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--password</option>=<replaceable class="parameter">password</replaceable></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The password to authenticate to the AMQP server with. Defaults to <literal>guest</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See also</title>
|
||||
<para>
|
||||
<simplelist type='inline'>
|
||||
<member><citerefentry><refentrytitle>amqp-publish</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
|
||||
<member><citerefentry><refentrytitle>amqp-consume</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
|
||||
<member><citerefentry><refentrytitle>amqp-get</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
Loading…
Add table
Add a link
Reference in a new issue