Skip to content

Class Client

Class \RdKafka\Admin\Client

Methods

alterConfigs()

public alterConfigs ( 
    \RdKafka\Admin\ConfigResource[] $resources, 
    ?\RdKafka\Admin\AlterConfigsOptions $options = null
 ): \RdKafka\Admin\ConfigResourceResult[]
Parameters
resources \RdKafka\Admin\ConfigResource[]
options ?\RdKafka\Admin\AlterConfigsOptions
Returns
\RdKafka\Admin\ConfigResourceResult[]

createPartitions()

public createPartitions ( 
    \RdKafka\Admin\NewPartitions[] $partitions, 
    ?\RdKafka\Admin\CreatePartitionsOptions $options = null
 ): \RdKafka\Admin\TopicResult[]
Parameters
partitions \RdKafka\Admin\NewPartitions[]
options ?\RdKafka\Admin\CreatePartitionsOptions
Returns
\RdKafka\Admin\TopicResult[]

createTopics()

public createTopics ( 
    \RdKafka\Admin\NewTopic[] $topics, 
    ?\RdKafka\Admin\CreateTopicsOptions $options = null
 ): \RdKafka\Admin\TopicResult[]
Parameters
topics \RdKafka\Admin\NewTopic[]
options ?\RdKafka\Admin\CreateTopicsOptions
Returns
\RdKafka\Admin\TopicResult[]

deleteConsumerGroupOffsets()

public deleteConsumerGroupOffsets ( 
    \RdKafka\Admin\DeleteConsumerGroupOffsets $offsets, 
    ?\RdKafka\Admin\DeleteConsumerGroupOffsetsOptions $options = null
 ): \RdKafka\Admin\GroupResult[]
Parameters
offsets \RdKafka\Admin\DeleteConsumerGroupOffsets
options ?\RdKafka\Admin\DeleteConsumerGroupOffsetsOptions
Returns
\RdKafka\Admin\GroupResult[]

deleteGroups()

public deleteGroups ( 
    \RdKafka\Admin\DeleteGroup[] $groups, 
    ?\RdKafka\Admin\DeleteGroupsOptions $options = null
 ): \RdKafka\Admin\GroupResult[]
Parameters
groups \RdKafka\Admin\DeleteGroup[]
options ?\RdKafka\Admin\DeleteGroupsOptions
Returns
\RdKafka\Admin\GroupResult[]

deleteRecords()

public deleteRecords ( 
    \RdKafka\Admin\DeleteRecords[] $records, 
    ?\RdKafka\Admin\DeleteRecordsOptions $options = null
 ): \RdKafka\TopicPartition[]
Parameters
records \RdKafka\Admin\DeleteRecords[]
options ?\RdKafka\Admin\DeleteRecordsOptions
Returns
\RdKafka\TopicPartition[]

deleteTopics()

public deleteTopics ( 
    \RdKafka\Admin\DeleteTopic[] $topics, 
    ?\RdKafka\Admin\DeleteTopicsOptions $options = null
 ): \RdKafka\Admin\TopicResult[]
Parameters
topics \RdKafka\Admin\DeleteTopic[]
options ?\RdKafka\Admin\DeleteTopicsOptions
Returns
\RdKafka\Admin\TopicResult[]

describeConfigs()

public describeConfigs ( 
    \RdKafka\Admin\ConfigResource[] $resources, 
    ?\RdKafka\Admin\DescribeConfigsOptions $options = null
 ): \RdKafka\Admin\ConfigResourceResult[]
Parameters
resources \RdKafka\Admin\ConfigResource[]
options ?\RdKafka\Admin\DescribeConfigsOptions
Returns
\RdKafka\Admin\ConfigResourceResult[]

fromConf()

public static fromConf ( 
    \RdKafka\Conf $conf
 ): self
Parameters
conf \RdKafka\Conf
Returns
self

fromConsumer()

public static fromConsumer ( 
    \RdKafka\Consumer $consumer
 ): self
Parameters
consumer \RdKafka\Consumer
Returns
self

fromProducer()

public static fromProducer ( 
    \RdKafka\Producer $producer
 ): self
Parameters
producer \RdKafka\Producer
Returns
self

getMetadata()

public getMetadata ( 
    bool $all_topics, 
    ?\RdKafka\Topic $only_topic, 
    int $timeout_ms
 ): \RdKafka\Metadata
Parameters
all_topics bool
only_topic ?\RdKafka\Topic
timeout_ms int
Returns
\RdKafka\Metadata

newAlterConfigsOptions()

public newAlterConfigsOptions (  ): \RdKafka\Admin\AlterConfigsOptions
Returns
\RdKafka\Admin\AlterConfigsOptions

newCreatePartitionsOptions()

public newCreatePartitionsOptions (  ): \RdKafka\Admin\CreatePartitionsOptions
Returns
\RdKafka\Admin\CreatePartitionsOptions

newCreateTopicsOptions()

public newCreateTopicsOptions (  ): \RdKafka\Admin\CreateTopicsOptions
Returns
\RdKafka\Admin\CreateTopicsOptions

newDeleteConsumerGroupOffsetsOptions()

public newDeleteConsumerGroupOffsetsOptions (  ): \RdKafka\Admin\DeleteConsumerGroupOffsetsOptions
Returns
\RdKafka\Admin\DeleteConsumerGroupOffsetsOptions

newDeleteGroupsOptions()

public newDeleteGroupsOptions (  ): \RdKafka\Admin\DeleteGroupsOptions
Returns
\RdKafka\Admin\DeleteGroupsOptions

newDeleteRecordsOptions()

public newDeleteRecordsOptions (  ): \RdKafka\Admin\DeleteRecordsOptions
Returns
\RdKafka\Admin\DeleteRecordsOptions

newDeleteTopicsOptions()

public newDeleteTopicsOptions (  ): \RdKafka\Admin\DeleteTopicsOptions
Returns
\RdKafka\Admin\DeleteTopicsOptions

newDescribeConfigsOptions()

public newDescribeConfigsOptions (  ): \RdKafka\Admin\DescribeConfigsOptions
Returns
\RdKafka\Admin\DescribeConfigsOptions

setWaitForResultEventTimeout()

public setWaitForResultEventTimeout ( 
    int $timeoutMs
 ): void
Parameters
timeoutMs int

Test Coverage 💛

  • 💛 Lines: 83.51% (162 / 194)
  • 💛 Methods: 79.17% (19 / 24)