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.

Detailed Description

Class for constructing the options string to pass to AMPS in a Message.

Member Function Documentation

void AMPS::Message::Options::setConflation ( const char * conflation_ )

inline

Set the options for conflation.

Parameters

conflation_ The conflation interval, auto, or none.

void AMPS::Message::Options::setConflationKey ( const char * conflationKey_ )

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.

Parameters

conflationKey_ The message key to use for conflation.

void AMPS::Message::Options::setFullyDurable ( void )

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.

void AMPS::Message::Options::setGrouping ( std::string grouping_ )

inline

Set the option for grouping messages in a projection.

Parameters

grouping_ The comma-separated list of grouping field names.

template<class Iterator >

void AMPS::Message::Options::setGrouping	(	Iterator	begin_,
		Iterator	end_
	)

inline

Set the option for top N.

Parameters

begin_	The starting forward iterator for field descriptions.
end_	The ending forward iterator for field descriptions.

void AMPS::Message::Options::setMaxBacklog ( int maxBacklog_ )

inline

Set the option for max backlog.

This option only applies to subscriptions to queue topics.

Parameters

maxBacklog_ The max unacked queue messages in backlog.

void AMPS::Message::Options::setPause ( void )

inline

Set the option to pause a subscription.

This option is only valid for bookmark subscriptions that do not use the "live" option.

void AMPS::Message::Options::setProjection ( std::string projection_ )

inline

Set the option for projection.

Parameters

projection_ A string, possibly comma-separated of field descriptions.

template<class Iterator >

void AMPS::Message::Options::setProjection	(	Iterator	begin_,
		Iterator	end_
	)

inline

Set the option for projection.

Parameters

begin_	The starting forward iterator for field descriptions.
end_	The ending forward iterator for field descriptions.

void AMPS::Message::Options::setRate ( const char * rate_ )

inline

Set the option for publish rate.

This option is only valid for bookmark subscriptions.

Parameters

rate_ The rate for sending messages on the bookmark subscription.

void AMPS::Message::Options::setRateMaxGap ( const char * rateMaxGap_ )

inline

Set the option for publish rate max gap between messages.

This option is only valid for bookmark subscriptions when a "rate" is specified.

Parameters

rateMaxGap_ The max gap between messages on the subscription.

void AMPS::Message::Options::setResume ( void )

inline

Set the option to resume a subscription.

This option is only valid for bookmark subscriptions that do not use the "live" option.

void AMPS::Message::Options::setSkipN ( int skipN_ )

inline

Set the option for skip N.

Parameters

skipN_ The number of messages to skip before sending to client.

void AMPS::Message::Options::setTopN ( int topN_ )

inline

Set the option for top N.

Parameters

topN_ The max number of messages to return.

The documentation for this class was generated from the following file:

include/Message.hpp

Public Member Functions

Detailed Description

Member Function Documentation