Table of Contents
The root directory for the C++ distribution is named qpidc-0.4. The README file in that directory gives instructions for building the broker and client libraries. In most cases you will do the following:
[qpidc-0.4]$ ./configure [qpidc-0.4]$ make
Once you have built the broker and client libraries, you can start the broker from the command line:
Use the --daemon option to run the broker as a daemon process:
[qpidc-0.4]$ src/qpidd --daemon
You can stop a running daemon with the --quit option:
[qpidc-0.4]$ src/qpidd --quit
You can see all available options with the --help option
[qpidc-0.4]$ src/qpidd --help
The qpidd broker requires you to set a data directory or specify --no-data-dir (see help for more details). The data directory is used for the journal, so it is important when reliability counts. Make sure your process has write permission to the data directory.
The default location is
An alternate location can be set with --data-dir
Note that when qpidd starts it creates a lock file is data directory are being used. If you have a un-controlled exit, please mail the trace from the core to the email@example.com mailing list. To clear the lock run
It should also be noted that multiple brokers can be run on the same host. To do so set alternate data directories for each qpidd instance.
Each option that can be specified on the command line can also be specified in a configuration file. To see available options, use --help on the command line:
A configuration file uses name/value pairs, one on each line. To convert a command line option to a configuration file entry:
a.) remove the '--' from the beginning of the option. b.) place a '=' between the option and the value (use yes or true to enable options that take no value when specified on the command line). c.) place one option per line.
For instance, the --daemon option takes no value, the --log-to-syslog option takes the values yes or no. The following configuration file sets these two options:
Yes, all the clients work with the C++ broker; it is written in C+, but uses the AMQP wire protocol. Any broker can be used with any client that uses the same AMQP version. When running the C+ broker, it is highly recommended to run AMQP 0-10.
Note that JMS also works with the C++ broker.
The PLAIN authentication is done on a username+password, which is stored in the sasldb_path file. Usernames and passwords can be added to the file using the command:
saslpasswd2 -f /var/lib/qpidd/qpidd.sasldb -u <REALM> <USER>
The REALM is important and should be the same as the --auth-realm option to the broker. This lets the broker properly find the user in the sasldb file.
Existing user accounts may be listed with:
sasldblistusers2 -f /var/lib/qpidd/qpidd.sasldb
NOTE: The sasldb file must be readable by the user running the qpidd daemon, and should be readable only by that user.
On Windows, the users are authenticated against the local machine. You should add the appropriate users using the standard Windows tools (Control Panel->User Accounts). To run many of the examples, you will need to create a user "guest" with password "guest".
If you cannot or do not want to create new users, you can run without authentication by specifying the no-auth option to the broker.
The easiest way to get a full listing of the broker's options are to use the --help command, run it locally for the latest set of options. These options can then be set in the conf file for convenience (see above)
./qpidd --help Usage: qpidd OPTIONS Options: -h [ --help ] Displays the help message -v [ --version ] Displays version information --config FILE (/etc/qpidd.conf) Reads configuration from FILE Module options: --module-dir DIR (/usr/lib/qpidd) Load all .so modules in this directory --load-module FILE Specifies additional module(s) to be loaded --no-module-dir Don't load modules from module directory Broker Options: --data-dir DIR (/var/lib/qpidd) Directory to contain persistent data generated by the broker --no-data-dir Don't use a data directory. No persistent configuration will be loaded or stored -p [ --port ] PORT (5672) Tells the broker to listen on PORT --worker-threads N (3) Sets the broker thread pool size --max-connections N (500) Sets the maximum allowed connections --connection-backlog N (10) Sets the connection backlog limit for the server socket --staging-threshold N (5000000) Stages messages over N bytes to disk -m [ --mgmt-enable ] yes|no (1) Enable Management --mgmt-pub-interval SECONDS (10) Management Publish Interval --ack N (0) Send session.ack/solicit-ack at least every N frames. 0 disables voluntary ack/solitict -ack Daemon options: -d [ --daemon ] Run as a daemon. -w [ --wait ] SECONDS (10) Sets the maximum wait time to initialize the daemon. If the daemon fails to initialize, prints an error and returns 1 -c [ --check ] Prints the daemon's process ID to stdout and returns 0 if the daemon is running, otherwise returns 1 -q [ --quit ] Tells the daemon to shut down Logging options: --log-output FILE (stderr) Send log output to FILE. FILE can be a file name or one of the special values: stderr, stdout, syslog -t [ --trace ] Enables all logging --log-enable RULE (error+) Enables logging for selected levels and component s. RULE is in the form 'LEVEL+:PATTERN' Levels are one of: trace debug info notice warning error critical For example: '--log-enable warning+' logs all warning, error and critical messages. '--log-enable debug:framing' logs debug messages from the framing namespace. This option can be used multiple times --log-time yes|no (1) Include time in log messages --log-level yes|no (1) Include severity level in log messages --log-source yes|no (0) Include source file:line in log messages --log-thread yes|no (0) Include thread ID in log messages --log-function yes|no (0) Include function signature in log messages
By default the broker will load all the modules in the module directory, however it will NOT display options for modules that are not loaded. So to see the options for extra modules loaded you need to load the module and then add the help command like this:
./qpidd --load-module libbdbstore.so --help Usage: qpidd OPTIONS Options: -h [ --help ] Displays the help message -v [ --version ] Displays version information --config FILE (/etc/qpidd.conf) Reads configuration from FILE / .... non module options would be here ... / Store Options: --store-directory DIR Store directory location for persistence (overrides --data-dir) --store-async yes|no (1) Use async persistence storage - if store supports it, enables AIO O_DIRECT. --store-force yes|no (0) Force changing modes of store, will delete all existing data if mode is changed. Be SURE you want to do this! --num-jfiles N (8) Number of files in persistence journal --jfile-size-pgs N (24) Size of each journal file in multiples of read pages (1 read page = 64kiB)
The AMQP 0-10 specification defines a timestamp message delivery property. The timestamp delivery property is a datetime value that is written to each message that arrives at the broker. See the description of "message.delivery-properties" in the "Command Classes" section of the AMQP 0-10 specification for more detail.
See the Programming in Apache Qpid documentation for information regarding how clients may access the timestamp value in received messages.
By default, this timestamping feature is disabled. To enable timestamping, use the enable-timestamp broker configuration option. Setting the enable-timestamp option to 'yes' will enable message timestamping:
./qpidd --enable-timestamp yes
Message timestamping can also be enabled (and disabled) without restarting the broker. The QMF Broker management object defines two methods for accessing the timestamp configuration:
Table 1.1. QMF Management - Broker Methods for Managing the Timestamp Configuration
|getTimestampConfig||Get the message timestamping configuration. Returns True if received messages are timestamped.|
|setTimestampConfig||Set the message timestamping configuration. Set True to enable timestamping received messages, False to disable timestamping.|
Example 1.1. Enabling Message Timestamping via QMF - Python
The following code fragment uses these QMF method calls to enable message timestamping.
# get the state of the timestamp configuration broker = self.qmf.getObjects(_class="broker") rc = broker.getTimestampConfig() self.assertEqual(rc.status, 0) self.assertEqual(rc.text, "OK") print("The timestamp setting is %s" % str(rc.receive)) # try to enable it rc = broker.setTimestampConfig(True) self.assertEqual(rc.status, 0) self.assertEqual(rc.text, "OK")
Apache Qpid, Messaging built on AMQP; Copyright © 2013 The Apache Software Foundation; Licensed under the Apache License, Version 2.0; Apache Qpid, Qpid, Qpid Proton, Proton, Apache, the Apache feather logo, and the Apache Qpid project logo are trademarks of The Apache Software Foundation; All other marks mentioned may be trademarks or registered trademarks of their respective owners