activemq-artemis/examples/protocols/amqp/proton-cpp/readme.html

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

<html>
<head>
    <title>ActiveMQ Artemis QPID cpp example</title>
    <link rel="stylesheet" type="text/css" href="../../../common/common.css" />
    <link rel="stylesheet" type="text/css" href="../../../common/prettify.css" />
    <script type="text/javascript" src="../../../common/prettify.js"></script>
</head>
<body onload="prettyPrint()">
<h1>AMQP CPP example</h1>

<p>ActiveMQ Artemis is a multi protocol broker. It will inspect the initial handshake of clients to determine what protocol to use.</p>
<p>All you need to do is to connect a client into activemq's configured port and you should be able connect.</p>
<p>To run this example simply run the command <literal>mvn verify -Pexample</literal>, execute the compile.sh script and start the executable called ./hello</p>
<pre>
    # first make sure you have the dependencies you need to compile and run the client
    # You will have to adapt this step according to your platform. Consult the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/">qpid docs</a> for more information.
    # There is a list of <a href="http://qpid.apache.org/packages.html">packages</a> you can install as well.
    [proton-cpp]$ sudo yum install qpid-cpp-client-devel

    # on a first window
    [proton-cpp]$ mvn verify -Pexample

    # on a second window
    # That goes without saying but you will of course need g++ (the C++ compiler) installed
    [proton-cpp]$ ./compile.sh
    [proton-cpp]$ ./hello
</pre>


<p>You don't need to do anything special to configure the ActiveMQ Artemis server to accept AMQP clients. </p>
<p>Just for the sake of documentation though we are setting the port of ActiveMQ Artemis on this example as 5672 which is the port qpid have by default. </p>
<p>This is totally optional and you don't need to follow this convention. You can use any port you chose including ActiveMQ's 61616 default port</p>
     <pre class="prettyprint">
     <code>
         &lt;acceptor name="proton-acceptor"&gt;tcp://localhost:5672&lt;/acceptor&gt;
     </code>
     </pre>
<h2>Example step-by-step</h2>
<p> We are using qpid cpp client on this example. There are several libraries you may chose from for AMQP. We have ellect one that we consider simple enough for users.</p>

<p> This example is based on <a href='http://qpid.apache.org/releases/qpid-0.30/messaging-api/cpp/examples/hello_world.cpp.html'>qpid's hello world example</a>.</p>
<ol>
    <li>qpid-cpp-client-devel installed.</li>
    <p>Assuming you are on Linux Fedora, you will need to run this following command</p>
    <pre class="prettyprint">
        <code>yum install qpid-cpp-client-devel</code>
    </pre>
    <p>Consult the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/">qpid documentation</a>, and <a href="http://qpid.apache.org/packages.html">the required </a> packages for information on other platoforms.</p>
    <li>Make the proper C++ imports</li>

    <li> Create an amqp qpid 1.0 connection.</li>
        <pre class="prettyprint">
           <code>
        std::string broker = argc > 1 ? argv[1] : "localhost:61616";
        std::string address = argc > 2 ? argv[2] : "jms.queue.exampleQueue";
        std::string connectionOptions = argc > 3 ? argv[3] : "{protocol:amqp1.0}"; // Look at the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/connections.html#connection-options">docs</a> for more options

        Connection connection(broker, connectionOptions);
        connection.open();
           </code>
        </pre>

    <li>Create a session</li>
        <pre class="prettyprint">
       <code>Session session = connection.createSession();</code>
        </pre>

    <li>Create a sender</li>
        <pre class="prettyprint">
       <code>Sender sender = session.createSender(address);</code>
        </pre>

    <li>send a simple message</li>
        <pre class="prettyprint">
       <code>sender.send(Message("Hello world!"));</code>
        </pre>

    <li>create a receiver</li>
        <pre class="prettyprint">
       <code>Receiver receiver = session.createReceiver(address);</code>
        </pre>

    <li>receive the simple message</li>
        <pre class="prettyprint">
      <code>Message message = receiver.fetch(Duration::SECOND * 1);
      </code>
        </pre>

    <li>acknowledge the message</li>
        <pre class="prettyprint">
      <code>session.acknowledge();</code>
        </pre>

    <li>close the connection</li>
        <pre class="prettyprint">
      <code>connection.close();</code>
        </pre>
</ol>

</body>
</html>
ACTIVEMQ6-43(reopened) : Replace License Headers on codebase - added missing license headers found by maven rat plugin. most of them added automatically via apache-rat a few manually added - added apache-rat maven plugin to the build cycle 2015-01-05 07:45:36 -05:00			`<!--`
			`Licensed to the Apache Software Foundation (ASF) under one`
			`or more contributor license agreements. See the NOTICE file`
			`distributed with this work for additional information`
			`regarding copyright ownership. The ASF licenses this file`
			`to you under the Apache License, Version 2.0 (the`
			`"License"); you may not use this file except in compliance`
			`with the License. You may obtain a copy of the License at`

			`http://www.apache.org/licenses/LICENSE-2.0`

			`Unless required by applicable law or agreed to in writing,`
			`software distributed under the License is distributed on an`
			`"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY`
			`KIND, either express or implied. See the License for the`
			`specific language governing permissions and limitations`
			`under the License.`
			`-->`

ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`<html>`
			`<head>`
Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`<title>ActiveMQ Artemis QPID cpp example</title>`
This commit has improvements on the examples including: https://issues.apache.org/jira/browse/ARTEMIS-113 Better organize examples https://issues.apache.org/jira/browse/ARTEMIS-114 Some openwire examples 2015-08-10 10:41:52 -04:00			`<link rel="stylesheet" type="text/css" href="../../../common/common.css" />`
			`<link rel="stylesheet" type="text/css" href="../../../common/prettify.css" />`
			`<script type="text/javascript" src="../../../common/prettify.js"></script>`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`</head>`
			`<body onload="prettyPrint()">`
			`<h1>AMQP CPP example</h1>`

Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`<p>ActiveMQ Artemis is a multi protocol broker. It will inspect the initial handshake of clients to determine what protocol to use.</p>`
More name changes to activemq more hornetq changes 2014-11-19 14:58:44 -05:00			`<p>All you need to do is to connect a client into activemq's configured port and you should be able connect.</p>`
added examples to release profile Also gave them all a profile so they wouldn't actually run during the build. fixed some of the comilation errors in the Rest example module 2015-03-07 11:51:01 -05:00			`<p>To run this example simply run the command <literal>mvn verify -Pexample</literal>, execute the compile.sh script and start the executable called ./hello</p>`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`<pre>`
			`# first make sure you have the dependencies you need to compile and run the client`
			`# You will have to adapt this step according to your platform. Consult the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/">qpid docs</a> for more information.`
			`# There is a list of <a href="http://qpid.apache.org/packages.html">packages</a> you can install as well.`
			`[proton-cpp]$ sudo yum install qpid-cpp-client-devel`

			`# on a first window`
added examples to release profile Also gave them all a profile so they wouldn't actually run during the build. fixed some of the comilation errors in the Rest example module 2015-03-07 11:51:01 -05:00			`[proton-cpp]$ mvn verify -Pexample`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00
			`# on a second window`
			`# That goes without saying but you will of course need g++ (the C++ compiler) installed`
			`[proton-cpp]$ ./compile.sh`
			`[proton-cpp]$ ./hello`
			`</pre>`


Ensure all references to the project use ActiveMQ Artemis 2015-05-13 06:12:07 -04:00			`<p>You don't need to do anything special to configure the ActiveMQ Artemis server to accept AMQP clients. </p>`
			`<p>Just for the sake of documentation though we are setting the port of ActiveMQ Artemis on this example as 5672 which is the port qpid have by default. </p>`
Replace all references of port 5445 with 61616 2015-02-24 10:50:54 -05:00			`<p>This is totally optional and you don't need to follow this convention. You can use any port you chose including ActiveMQ's 61616 default port</p>`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`<pre class="prettyprint">`
			`<code>`
documentation updates 2015-02-23 04:50:08 -05:00			`<acceptor name="proton-acceptor">tcp://localhost:5672</acceptor>`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`</code>`
			`</pre>`
			`<h2>Example step-by-step</h2>`
			`<p> We are using qpid cpp client on this example. There are several libraries you may chose from for AMQP. We have ellect one that we consider simple enough for users.</p>`

			`<p> This example is based on <a href='http://qpid.apache.org/releases/qpid-0.30/messaging-api/cpp/examples/hello_world.cpp.html'>qpid's hello world example</a>.</p>`
			`<ol>`
			`<li>qpid-cpp-client-devel installed.</li>`
			`<p>Assuming you are on Linux Fedora, you will need to run this following command</p>`
			`<pre class="prettyprint">`
			`<code>yum install qpid-cpp-client-devel</code>`
			`</pre>`
			`<p>Consult the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/">qpid documentation</a>, and <a href="http://qpid.apache.org/packages.html">the required </a> packages for information on other platoforms.</p>`
			`<li>Make the proper C++ imports</li>`

			`<li> Create an amqp qpid 1.0 connection.</li>`
			`<pre class="prettyprint">`
			`<code>`
Replace all references of port 5445 with 61616 2015-02-24 10:50:54 -05:00			`std::string broker = argc > 1 ? argv[1] : "localhost:61616";`
ACTIVEMQ6-2 Update to HQ master 2014-11-10 11:14:12 -05:00			`std::string address = argc > 2 ? argv[2] : "jms.queue.exampleQueue";`
			`std::string connectionOptions = argc > 3 ? argv[3] : "{protocol:amqp1.0}"; // Look at the <a href="http://qpid.apache.org/releases/qpid-0.30/programming/book/connections.html#connection-options">docs</a> for more options`

			`Connection connection(broker, connectionOptions);`
			`connection.open();`
			`</code>`
			`</pre>`

			`<li>Create a session</li>`
			`<pre class="prettyprint">`
			`<code>Session session = connection.createSession();</code>`
			`</pre>`

			`<li>Create a sender</li>`
			`<pre class="prettyprint">`
			`<code>Sender sender = session.createSender(address);</code>`
			`</pre>`

			`<li>send a simple message</li>`
			`<pre class="prettyprint">`
			`<code>sender.send(Message("Hello world!"));</code>`
			`</pre>`

			`<li>create a receiver</li>`
			`<pre class="prettyprint">`
			`<code>Receiver receiver = session.createReceiver(address);</code>`
			`</pre>`

			`<li>receive the simple message</li>`
			`<pre class="prettyprint">`
			`<code>Message message = receiver.fetch(Duration::SECOND * 1);`
			`</code>`
			`</pre>`

			`<li>acknowledge the message</li>`
			`<pre class="prettyprint">`
			`<code>session.acknowledge();</code>`
			`</pre>`

			`<li>close the connection</li>`
			`<pre class="prettyprint">`
			`<code>connection.close();</code>`
			`</pre>`
			`</ol>`

			`</body>`
ACTIVEMQ6-43(reopened) : Replace License Headers on codebase - added missing license headers found by maven rat plugin. most of them added automatically via apache-rat a few manually added - added apache-rat maven plugin to the build cycle 2015-01-05 07:45:36 -05:00			`</html>`