hazelcast::client::config::reliable_topic_config Class Reference

Public Member Functions
	reliable_topic_config (std::string topic_name)
const std::string &	get_name () const
	Gets the name of the reliable topic.
int	get_read_batch_size () const
	Gets the maximum number of items to read in a batch.
reliable_topic_config &	set_read_batch_size (int batch_size)
	Sets the read batch size.

Static Public Attributes
static constexpr int	DEFAULT_READ_BATCH_SIZE = 10

Detailed Description

Definition at line 29 of file reliable_topic_config.h.

Constructor & Destructor Documentation

reliable_topic_config()

hazelcast::client::config::reliable_topic_config::reliable_topic_config ( std::string topic_name )

explicit

Definition at line 481 of file config.cpp.

  : read_batch_size_(DEFAULT_READ_BATCH_SIZE)
  ,
 
  name_(std::move(topic_name))
{}

Member Function Documentation

get_name()

const std::string & hazelcast::client::config::reliable_topic_config::get_name

(

)

const

Gets the name of the reliable topic.

Returns

the name of the reliable topic.

Definition at line 489 of file config.cpp.

{
    return name_;
}

get_read_batch_size()

int hazelcast::client::config::reliable_topic_config::get_read_batch_size

(

)

const

Gets the maximum number of items to read in a batch.

Returned value will always be equal or larger than 1.

Returns

the read batch size.

Definition at line 495 of file config.cpp.

{
    return read_batch_size_;
}

set_read_batch_size()

reliable_topic_config & hazelcast::client::config::reliable_topic_config::set_read_batch_size

(

int

batch_size

)

Sets the read batch size.

The ReliableTopic tries to read a batch of messages from the ringbuffer. It will get at least one, but if there are more available, then it will try to get more to increase throughput. The minimal read batch size can be influenced using the read batch size.

If the readBatchSize is 10 and there are 50 messages available, 10 items are retrieved and processed consecutively.

If the readBatchSize is 10 and there are 2 items available, 2 items are retrieved and processed consecutively.

Parameters

readBatchSize

the maximum number of items to read in a batch.

Returns

the updated reliable topic config.

Exceptions

illegal_argument

if readBatchSize is smaller than 1.

Definition at line 501 of file config.cpp.

{
    if (batch_size <= 0) {
        BOOST_THROW_EXCEPTION(
          exception::illegal_argument("ReliableTopicConfig::setReadBatchSize",
                                      "readBatchSize should be positive"));
    }
 
    this->read_batch_size_ = batch_size;
 
    return *this;
}

Member Data Documentation

DEFAULT_READ_BATCH_SIZE

int hazelcast::client::config::reliable_topic_config::DEFAULT_READ_BATCH_SIZE = 10

staticconstexpr

Definition at line 32 of file reliable_topic_config.h.

---

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

• hazelcast/include/hazelcast/client/config/reliable_topic_config.h
• hazelcast/src/hazelcast/client/config.cpp