1. class
  2. RdKafka
  3. \
  4. KafkaConsumer

KafkaConsumer

class KafkaConsumer (View source)

Methods

__construct(Conf $conf)

No description

void
assign(TopicPartition[] $topic_partitions = null)

No description

incrementalAssign(array $topic_partitions)

No description

incrementalUnassign(array $topic_partitions)

No description

void
commit(null|Message|TopicPartition[] $message_or_offsets = null)

No description

void
commitAsync(null|Message|TopicPartition[] $message_or_offsets = null)

No description

Message
consume(int $timeout_ms)

No description

TopicPartition[]
getAssignment()

No description

Metadata
getMetadata(bool $all_topics, null|KafkaConsumerTopic $only_topic = null, int $timeout_ms)

No description

array
getSubscription()

No description

void
subscribe(array $topics)

No description

void
unsubscribe()

No description

array
getCommittedOffsets(array $topic_partitions, int $timeout_ms)

No description

TopicPartition[]
offsetsForTimes(TopicPartition[] $topic_partitions, int $timeout_ms)

No description

void
queryWatermarkOffsets(string $topic, int $partition = 0, int $low = 0, int $high = 0, int $timeout_ms = 0)

No description

getOffsetPositions(TopicPartition[] $topic_partitions)

No description

KafkaConsumerTopic
newTopic(string $topic_name, null|TopicConf $topic_conf = null)

No description

getControllerId(int $timeout_ms)

No description

pausePartitions(array $topic_partitions)

No description

resumePartitions(array $topic_partitions)

No description

poll(int $timeout_ms)

No description

oauthbearerSetToken(string $token_value, int $lifetime_ms, string $principal_name, array $extensions = [])

No description

oauthbearerSetTokenFailure(string $error)

No description

void
close()

No description

Details

at line 28
__construct(Conf $conf)

No description

Parameters

Conf $conf

at line 36
void assign(TopicPartition[] $topic_partitions = null)

No description

Parameters

TopicPartition[] $topic_partitions

Return Value

void

Exceptions

Exception

at line 38
incrementalAssign(array $topic_partitions)

No description

Parameters

array $topic_partitions

at line 42
incrementalUnassign(array $topic_partitions)

No description

Parameters

array $topic_partitions

at line 52
void commit(null|Message|TopicPartition[] $message_or_offsets = null)

No description

Parameters

null|Message|TopicPartition[] $message_or_offsets

Return Value

void

Exceptions

Exception

at line 60
void commitAsync(null|Message|TopicPartition[] $message_or_offsets = null)

No description

Parameters

null|Message|TopicPartition[] $message_or_offsets

Return Value

void

Exceptions

Exception

at line 69
Message consume(int $timeout_ms)

No description

Parameters

int $timeout_ms

Return Value

Message

Exceptions

Exception
InvalidArgumentException

at line 75
TopicPartition[] getAssignment()

No description

Return Value

TopicPartition[]

Exceptions

Exception

at line 85
Metadata getMetadata(bool $all_topics, null|KafkaConsumerTopic $only_topic = null, int $timeout_ms)

No description

Parameters

bool $all_topics
null|KafkaConsumerTopic $only_topic
int $timeout_ms

Return Value

Metadata

Exceptions

Exception

at line 90
array getSubscription()

No description

Return Value

array

at line 98
void subscribe(array $topics)

No description

Parameters

array $topics

Return Value

void

Exceptions

Exception

at line 104
void unsubscribe()

No description

Return Value

void

Exceptions

Exception

at line 112
array getCommittedOffsets(array $topic_partitions, int $timeout_ms)

No description

Parameters

array $topic_partitions
int $timeout_ms

Return Value

array

at line 120
TopicPartition[] offsetsForTimes(TopicPartition[] $topic_partitions, int $timeout_ms)

No description

Parameters

TopicPartition[] $topic_partitions
int $timeout_ms

Return Value

TopicPartition[]

at line 131
void queryWatermarkOffsets(string $topic, int $partition = 0, int $low = 0, int $high = 0, int $timeout_ms = 0)

No description

Parameters

string $topic
int $partition
int $low
int $high
int $timeout_ms

Return Value

void

at line 136
getOffsetPositions(TopicPartition[] $topic_partitions)

No description

Parameters

TopicPartition[] $topic_partitions

at line 144
KafkaConsumerTopic newTopic(string $topic_name, null|TopicConf $topic_conf = null)

No description

Parameters

string $topic_name
null|TopicConf $topic_conf

Return Value

KafkaConsumerTopic

at line 146
getControllerId(int $timeout_ms)

No description

Parameters

int $timeout_ms

at line 150
pausePartitions(array $topic_partitions)

No description

Parameters

array $topic_partitions

at line 154
resumePartitions(array $topic_partitions)

No description

Parameters

array $topic_partitions

at line 158
poll(int $timeout_ms)

No description

Parameters

int $timeout_ms

at line 162
oauthbearerSetToken(string $token_value, int $lifetime_ms, string $principal_name, array $extensions = [])

No description

Parameters

string $token_value
int $lifetime_ms
string $principal_name
array $extensions

at line 166
oauthbearerSetTokenFailure(string $error)

No description

Parameters

string $error

at line 173
void close()

No description

Return Value

void