librdkafka
The Apache Kafka C/C++ client library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 for topic partition partition. The offset will be committed (written) to the offset store according to auto.commit.interval.ms. More...
 

Static Public Member Functions

static Topiccreate (Handle *base, const std::string &topic_str, 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

static Topic* RdKafka::Topic::create ( Handle base,
const std::string &  topic_str,
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).
virtual const std::string RdKafka::Topic::name ( ) const
pure virtual
Returns
the topic name
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.
virtual ErrorCode RdKafka::Topic::offset_store ( int32_t  partition,
int64_t  offset 
)
pure virtual

Store offset offset for topic partition partition. The offset will be committed (written) to the offset store according to auto.commit.interval.ms.

Remarks
This API should only be used with the simple RdKafka::Consumer, not the high-level RdKafka::KafkaConsumer.
auto.commit.enable must be set to false when using this API.
Returns
RdKafka::ERR_NO_ERROR on success or an error code on error.

Field Documentation

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.

const int64_t RdKafka::Topic::OFFSET_BEGINNING
static

Special offsets.

Consume from beginning

const int64_t RdKafka::Topic::OFFSET_END
static

Consume from end

const int64_t RdKafka::Topic::OFFSET_STORED
static

Use offset storage

const int64_t RdKafka::Topic::OFFSET_INVALID
static

Invalid offset


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