Options for creating a receiver. More...
#include <receiver_options.hpp>
Public Member Functions | |
receiver_options () | |
Create an empty set of options. | |
receiver_options (const receiver_options &) | |
Copy options. | |
receiver_options & | operator= (const receiver_options &) |
Copy options. | |
void | update (const receiver_options &other) |
Merge with another option set. | |
receiver_options & | handler (class messaging_handler &) |
Set a messaging_handler for receiver events only. | |
receiver_options & | delivery_mode (delivery_mode) |
Set the delivery mode on the receiver. | |
receiver_options & | auto_accept (bool) |
Enable or disable automatic acceptance of messages that aren't otherwise released, rejected, or modified. | |
receiver_options & | auto_settle (bool) |
Enable or disable automatic settlement of messages. | |
receiver_options & | source (source_options &) |
Options for the source node of the receiver. | |
receiver_options & | target (target_options &) |
Options for the target node of the receiver. | |
receiver_options & | credit_window (int count) |
Automatically replenish credit for flow control up to `count` messages. |
Options for creating a receiver.
Options can be "chained" like this:
l = container.create_receiver(url, receiver_options().handler(h).auto_settle(true));
You can also create an options object with common settings and use it as a base for different connections that have mostly the same settings:
receiver_options opts; opts.auto_settle(true); c2 = container.open_receiver(url2, opts.handler(h2));
Normal value semantics: copy or assign creates a separate copy of the options.
broker.cpp, client.cpp, multithreaded_client_flow_control.cpp, and service_bus.cpp.
receiver_options& handler | ( | class messaging_handler & | ) |
Set a messaging_handler for receiver events only.
The handler is no longer in use when messaging_handler::on_receiver_close() is called.
Set the delivery mode on the receiver.
The default is delivery_mode::AT_LEAST_ONCE.
receiver_options& auto_accept | ( | bool | ) |
Enable or disable automatic acceptance of messages that aren't otherwise released, rejected, or modified.
It is enabled by default.
receiver_options& auto_settle | ( | bool | ) |
Enable or disable automatic settlement of messages.
It is enabled by default.
receiver_options& credit_window | ( | int | count | ) |
Automatically replenish credit for flow control up to `count` messages.
The default is 10. Set to zero to disable automatic replenishment.