You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jo...@apache.org on 2008/11/18 22:33:38 UTC
svn commit: r718718 -
/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h
Author: jonathan
Date: Tue Nov 18 13:33:37 2008
New Revision: 718718
URL: http://svn.apache.org/viewvc?rev=718718&view=rev
Log:
Added doxygen documentation for Connection::open(ConnectionSettings)
Modified:
incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h
Modified: incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h
URL: http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h?rev=718718&r1=718717&r2=718718&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h (original)
+++ incubator/qpid/trunk/qpid/cpp/src/qpid/client/Connection.h Tue Nov 18 13:33:37 2008
@@ -37,9 +37,10 @@
/**
* Represents a connection to an AMQP broker. All communication is
* initiated by establishing a connection, then creating one or more
- * Session objecst using the connection. @see newSession()
+ * Session objects using the connection. @see newSession()
*
* \ingroup clientapi
+ *
*/
class Connection
{
@@ -108,7 +109,31 @@
/**
* Opens a connection to a broker.
*
- * @param the settings to use (host, port etc) @see ConnectionSettings
+ * @param the settings to use (host, port etc)
+ *
+ * Specifying connection parameters with ConnectionSettings
+ *
+ * @code
+ * #include <qpid/client/ConnectionSettings.h>
+ * #include <qpid/client/Connection.h>
+ * #include <qpid/client/Session.h>
+ *
+ * using namespace qpid::client;
+ *
+ * int main(int , char** ) {
+ *
+ * ConnectionSettings connectionSettings;
+ * connectionSettings.host = "localhost";
+ * connectionSettings.port = 5672;
+ * connectionSettings.tcpNoDelay = true;
+ * connectionSettings.maxFrameSize = 65535;
+ * connectionSettings.bounds = 4;
+ *
+ * Connection connection;
+ * try {
+ * connection.open(connectionSettings);
+ * Session session = connection.newSession();
+ * @endcode
*/
void open(const ConnectionSettings& settings);