librdkafka
The Apache Kafka C/C++ client library
Public Member Functions | Static Public Member Functions | Static Public Attributes
RdKafka::Topic Class Referenceabstract

Topic handle. More...

#include <rdkafkacpp.h>

Public Member Functions

virtual const std::string name () const =0
 
virtual bool partition_available (int32_t partition) const =0
 
virtual ErrorCode offset_store (int32_t partition, int64_t offset)=0
 Store offset offset + 1 for topic partition partition. The offset will be committed (written) to the broker (or file) according to auto.commit.interval.ms or next manual offset-less commit call. More...
 
virtual struct rd_kafka_topic_s * c_ptr ()=0
 Returns the underlying librdkafka C rd_kafka_topic_t handle. More...
 

Static Public Member Functions

static Topic * create (Handle *base, const std::string &topic_str, const Conf *conf, std::string &errstr)
 Creates a new topic handle for topic named topic_str. More...
 

Static Public Attributes

static const int32_t PARTITION_UA
 Unassigned partition. More...
 
static const int64_t OFFSET_BEGINNING
 Special offsets. More...
 
static const int64_t OFFSET_END
 
static const int64_t OFFSET_STORED
 
static const int64_t OFFSET_INVALID
 

Detailed Description

Topic handle.

Member Function Documentation

◆ create()

static Topic* RdKafka::Topic::create ( Handle *  base,
const std::string &  topic_str,
const Conf *  conf,
std::string &  errstr 
)
static

Creates a new topic handle for topic named topic_str.

conf is an optional configuration for the topic that will be used instead of the default topic configuration. The conf object is reusable after this call.

Returns
the new topic handle or NULL on error (see errstr).

◆ name()

virtual const std::string RdKafka::Topic::name ( ) const
pure virtual
Returns
the topic name

◆ partition_available()

virtual bool RdKafka::Topic::partition_available ( int32_t  partition) const
pure virtual
Returns
true if partition is available for the topic (has leader).
Warning
MUST ONLY be called from within a RdKafka::PartitionerCb callback.

◆ offset_store()

virtual ErrorCode RdKafka::Topic::offset_store ( int32_t  partition,
int64_t  offset 
)
pure virtual

Store offset offset + 1 for topic partition partition. The offset will be committed (written) to the broker (or file) according to auto.commit.interval.ms or next manual offset-less commit call.

Remarks
enable.auto.offset.store must be set to false when using this API.
Returns
RdKafka::ERR_NO_ERROR on success or an error code if none of the offsets could be stored.

◆ c_ptr()

virtual struct rd_kafka_topic_s* RdKafka::Topic::c_ptr ( )
pure virtual

Returns the underlying librdkafka C rd_kafka_topic_t handle.

Warning
Calling the C API on this handle is not recommended and there is no official support for it, but for cases where the C++ API does not provide the underlying functionality this C handle can be used to interact directly with the core librdkafka API.
Remarks
The lifetime of the returned pointer is the same as the Topic object this method is called on.
Include <rdkafka/rdkafka.h> prior to including <rdkafka/rdkafkacpp.h>
Returns
rd_kafka_topic_t*

Field Documentation

◆ PARTITION_UA

const int32_t RdKafka::Topic::PARTITION_UA
static

Unassigned partition.

The unassigned partition is used by the producer API for messages that should be partitioned using the configured or default partitioner.

◆ OFFSET_BEGINNING

const int64_t RdKafka::Topic::OFFSET_BEGINNING
static

Special offsets.

Consume from beginning

◆ OFFSET_END

const int64_t RdKafka::Topic::OFFSET_END
static

Consume from end

◆ OFFSET_STORED

const int64_t RdKafka::Topic::OFFSET_STORED
static

Use offset storage

◆ OFFSET_INVALID

const int64_t RdKafka::Topic::OFFSET_INVALID
static

Invalid offset

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