AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.0.0
|
Class for constructing the options string to pass to AMPS in a Message. More...
#include <Message.hpp>
Public Member Functions | |
Options (std::string options_="") | |
ctor - default to None | |
void | setNone (void) |
Set options to nothing. | |
void | setLive (void) |
Set the live option. | |
void | setOOF (void) |
Set the option to receive OOF messages. | |
void | setReplace (void) |
Set the option to replace a current subscription with this one. | |
void | setNoEmpties (void) |
Set the option to not send empty messages. | |
void | setSendKeys (void) |
Set the option to send keys. | |
void | setTimestamp (void) |
Set the option to not send empty messages. | |
void | setNoSowKey (void) |
Set the option to not send SOW keys. | |
void | setCancel (void) |
Set the cancel option. | |
void | setResume (void) |
Set the option to resume a subscription. More... | |
void | setPause (void) |
Set the option to pause a subscription. More... | |
void | setFullyDurable (void) |
Set the option to only provide messages that have been persisted to all replication destinations that use synchronous acknowledgements. More... | |
void | setMaxBacklog (int maxBacklog_) |
Set the option for max backlog. More... | |
void | setConflation (const char *conflation_) |
Set the options for conflation. More... | |
void | setConflationKey (const char *conflationKey_) |
Set the options for the conflation key. More... | |
void | setTopN (int topN_) |
Set the option for top N. More... | |
void | setRate (const char *rate_) |
Set the option for publish rate. More... | |
void | setRateMaxGap (const char *rateMaxGap_) |
Set the option for publish rate max gap between messages. More... | |
void | setSkipN (int skipN_) |
Set the option for skip N. More... | |
void | setProjection (std::string projection_) |
Set the option for projection. More... | |
template<class Iterator > | |
void | setProjection (Iterator begin_, Iterator end_) |
Set the option for projection. More... | |
void | setGrouping (std::string grouping_) |
Set the option for grouping messages in a projection. More... | |
template<class Iterator > | |
void | setGrouping (Iterator begin_, Iterator end_) |
Set the option for top N. More... | |
operator const std::string () | |
Convert the object to a std::string, allows you to pass an Options object as the options_ argument directly. | |
Class for constructing the options string to pass to AMPS in a Message.
|
inline |
Set the options for conflation.
conflation_ | The conflation interval, auto, or none. |
|
inline |
Set the options for the conflation key.
The field or fields specified in this option will be used to determine which messages are considered updates for conflation.
conflationKey_ | The message key to use for conflation. |
|
inline |
Set the option to only provide messages that have been persisted to all replication destinations that use synchronous acknowledgements.
This option is only valid for bookmark subscriptions that do not use the "live" option.
|
inline |
Set the option for grouping messages in a projection.
grouping_ | The comma-separated list of grouping field names. |
|
inline |
Set the option for top N.
begin_ | The starting forward iterator for field descriptions. |
end_ | The ending forward iterator for field descriptions. |
|
inline |
Set the option for max backlog.
This option only applies to subscriptions to queue topics.
maxBacklog_ | The max unacked queue messages in backlog. |
|
inline |
Set the option to pause a subscription.
This option is only valid for bookmark subscriptions that do not use the "live" option.
|
inline |
Set the option for projection.
projection_ | A string, possibly comma-separated of field descriptions. |
|
inline |
Set the option for projection.
begin_ | The starting forward iterator for field descriptions. |
end_ | The ending forward iterator for field descriptions. |
|
inline |
Set the option for publish rate.
This option is only valid for bookmark subscriptions.
rate_ | The rate for sending messages on the bookmark subscription. |
|
inline |
Set the option for publish rate max gap between messages.
This option is only valid for bookmark subscriptions when a "rate" is specified.
rateMaxGap_ | The max gap between messages on the subscription. |
|
inline |
Set the option to resume a subscription.
This option is only valid for bookmark subscriptions that do not use the "live" option.
|
inline |
Set the option for skip N.
skipN_ | The number of messages to skip before sending to client. |
|
inline |
Set the option for top N.
topN_ | The max number of messages to return. |