SimpleKafkaClient\Consumer | PHP Jetbrains phpstorm-stubs

class Consumer extends SimpleKafkaClient (View source)

Methods

Metadata

getMetadata(bool $allTopics, int $timeoutMs, Topic $topic)

No description

from SimpleKafkaClient

int

getOutQLen()

No description

from SimpleKafkaClient

int

poll(int $timeoutMs)

No description

from SimpleKafkaClient

void

queryWatermarkOffsets(string $topic, int $partition, int $low, int $high, int $timeoutMs)

No description

from SimpleKafkaClient

array

offsetsForTimes(array $topicPartitions, int $timeoutMs)

No description

from SimpleKafkaClient

void

setOAuthBearerTokenFailure(string $errorString)

No description

from SimpleKafkaClient

void

setOAuthBearerToken(string $token, int $lifetimeMs, string $principalName, array|null $extensions = null)

No description

from SimpleKafkaClient

__construct(Configuration $configuration)

Consumer constructor.

void

assign(array|null $topicPartitions)

No description

array

getAssignment()

No description

void

subscribe(array $topics)

No description

array

getSubscription()

No description

void

unsubscribe()

No description

Message

consume(int $timeoutMs)

No description

void

commit(Message|TopicPartition[] $messageOrOffsets)

No description

void

commitAsync(Message|TopicPartition[] $messageOrOffsets)

No description

void

close()

No description

array

getCommittedOffsets(array $topicPartitions, int $timeoutMs)

No description

array

getOffsetPositions(array $topicPartitions)

No description

Details

in SimpleKafkaClient at line 18
`Metadata getMetadata(bool $allTopics, int $timeoutMs, Topic $topic)`

No description

Parameters

bool	$allTopics
int	$timeoutMs
Topic	$topic

Return Value

Metadata

Exceptions

Exception

in SimpleKafkaClient at line 23
`int getOutQLen()`

No description

Return Value

int

in SimpleKafkaClient at line 29
`int poll(int $timeoutMs)`

No description

Parameters

int

$timeoutMs

Return Value

int

in SimpleKafkaClient at line 39
`void queryWatermarkOffsets(string $topic, int $partition, int $low, int $high, int $timeoutMs)`

No description

Parameters

string	$topic
int	$partition
int	$low	is passed as reference, contains result after call
int	$high	is passed as reference, contains result after call
int	$timeoutMs

Return Value

void

Exceptions

Exception

in SimpleKafkaClient at line 47
`array offsetsForTimes(array $topicPartitions, int $timeoutMs)`

No description

Parameters

array	$topicPartitions
int	$timeoutMs

Return Value

array

Exceptions

Exception

in SimpleKafkaClient at line 52
`void setOAuthBearerTokenFailure(string $errorString)`

No description

Parameters

string

$errorString

Return Value

void

in SimpleKafkaClient at line 60
`void setOAuthBearerToken(string $token, int $lifetimeMs, string $principalName, array|null $extensions = null)`

No description

Parameters

string	$token
int	$lifetimeMs
string	$principalName
array\|null	$extensions

Return Value

void

at line 15
`__construct(Configuration $configuration)`

Consumer constructor.

Parameters

Configuration

$configuration

Exceptions

Exception

at line 21
`void assign(array|null $topicPartitions)`

No description

Parameters

array|null

$topicPartitions

Return Value

void

Exceptions

Exception

at line 27
`array getAssignment()`

No description

Return Value

array

Exceptions

Exception

at line 33
`void subscribe(array $topics)`

No description

Parameters

array

$topics

Return Value

void

Exceptions

Exception

at line 39
`array getSubscription()`

No description

Return Value

array

Exceptions

Exception

at line 45
`void unsubscribe()`

No description

Return Value

void

Exceptions

Exception

at line 51
`Message consume(int $timeoutMs)`

No description

Parameters

int

$timeoutMs

Return Value

Message

at line 57
`void commit(Message|TopicPartition[] $messageOrOffsets)`

No description

Parameters

Message|TopicPartition[]

$messageOrOffsets

Return Value

void

Exceptions

Exception

at line 63
`void commitAsync(Message|TopicPartition[] $messageOrOffsets)`

No description

Parameters

Message|TopicPartition[]

$messageOrOffsets

Return Value

void

Exceptions

Exception

at line 68
`void close()`

No description

Return Value

void

at line 76
`array getCommittedOffsets(array $topicPartitions, int $timeoutMs)`

No description

Parameters

array	$topicPartitions
int	$timeoutMs

Return Value

array

Exceptions

Exception

at line 83
`array getOffsetPositions(array $topicPartitions)`

No description

Parameters

array

$topicPartitions

Return Value

array

Exceptions

Exception

Consumer

Methods

Details

in SimpleKafkaClient at line 18 Metadata getMetadata(bool $allTopics, int $timeoutMs, Topic $topic)

Parameters

Return Value

Exceptions

in SimpleKafkaClient at line 23 int getOutQLen()

Return Value

in SimpleKafkaClient at line 29 int poll(int $timeoutMs)

Parameters

Return Value

in SimpleKafkaClient at line 39 void queryWatermarkOffsets(string $topic, int $partition, int $low, int $high, int $timeoutMs)

Parameters

Return Value

Exceptions

in SimpleKafkaClient at line 47 array offsetsForTimes(array $topicPartitions, int $timeoutMs)

Parameters

Return Value

Exceptions

in SimpleKafkaClient at line 52 void setOAuthBearerTokenFailure(string $errorString)

Parameters

Return Value

in SimpleKafkaClient at line 60 void setOAuthBearerToken(string $token, int $lifetimeMs, string $principalName, array|null $extensions = null)

Parameters

Return Value

at line 15 __construct(Configuration $configuration)

Parameters

Exceptions

at line 21 void assign(array|null $topicPartitions)

Parameters

Return Value

Exceptions

at line 27 array getAssignment()

Return Value

Exceptions

at line 33 void subscribe(array $topics)

Parameters

Return Value

Exceptions

at line 39 array getSubscription()

Return Value

Exceptions

at line 45 void unsubscribe()

Return Value

Exceptions

at line 51 Message consume(int $timeoutMs)

Parameters

Return Value

at line 57 void commit(Message|TopicPartition[] $messageOrOffsets)

Parameters

Return Value

Exceptions

at line 63 void commitAsync(Message|TopicPartition[] $messageOrOffsets)

Parameters

Return Value

Exceptions

at line 68 void close()

Return Value

at line 76 array getCommittedOffsets(array $topicPartitions, int $timeoutMs)

Parameters

Return Value

Exceptions

at line 83 array getOffsetPositions(array $topicPartitions)

Parameters

Return Value

Exceptions

in SimpleKafkaClient at line 18
`Metadata getMetadata(bool $allTopics, int $timeoutMs, Topic $topic)`

in SimpleKafkaClient at line 23
`int getOutQLen()`

in SimpleKafkaClient at line 29
`int poll(int $timeoutMs)`

in SimpleKafkaClient at line 39
`void queryWatermarkOffsets(string $topic, int $partition, int $low, int $high, int $timeoutMs)`

in SimpleKafkaClient at line 47
`array offsetsForTimes(array $topicPartitions, int $timeoutMs)`

in SimpleKafkaClient at line 52
`void setOAuthBearerTokenFailure(string $errorString)`

in SimpleKafkaClient at line 60
`void setOAuthBearerToken(string $token, int $lifetimeMs, string $principalName, array|null $extensions = null)`

at line 15
`__construct(Configuration $configuration)`

at line 21
`void assign(array|null $topicPartitions)`

at line 27
`array getAssignment()`

at line 33
`void subscribe(array $topics)`

at line 39
`array getSubscription()`

at line 45
`void unsubscribe()`

at line 51
`Message consume(int $timeoutMs)`

at line 57
`void commit(Message|TopicPartition[] $messageOrOffsets)`

at line 63
`void commitAsync(Message|TopicPartition[] $messageOrOffsets)`

at line 68
`void close()`

at line 76
`array getCommittedOffsets(array $topicPartitions, int $timeoutMs)`

at line 83
`array getOffsetPositions(array $topicPartitions)`