vendor/nmred/kafka-php/src/Kafka/ClusterMetaData.php

   1 <?php
   2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */
   3 // +---------------------------------------------------------------------------
   4 // | SWAN [ $_SWANBR_SLOGAN_$ ]
   5 // +---------------------------------------------------------------------------
   6 // | Copyright $_SWANBR_COPYRIGHT_$
   7 // +---------------------------------------------------------------------------
   8 // | Version  $_SWANBR_VERSION_$
   9 // +---------------------------------------------------------------------------
  10 // | Licensed ( $_SWANBR_LICENSED_URL_$ )
  11 // +---------------------------------------------------------------------------
  12 // | $_SWANBR_WEB_DOMAIN_$
  13 // +---------------------------------------------------------------------------
  14
  15 namespace Kafka;
  16
  17 /**
  18 +------------------------------------------------------------------------------
  19 * Metadata about the kafka cluster
  20 +------------------------------------------------------------------------------
  21 *
  22 * @package
  23 * @version $_SWANBR_VERSION_$
  24 * @copyright Copyleft
  25 * @author ebernhardson@wikimedia.org
  26 +------------------------------------------------------------------------------
  27 */
  28
  29 interface ClusterMetaData
  30 {
  31     /**
  32      * get broker list from kafka metadata
  33      *
  34      * @access public
  35      * @return array
  36      */
  37     public function listBrokers();
  38
  39     /**
  40      * @param string $topicName
  41      * @param integer $partitionId
  42      * @access public
  43      * @return array
  44      */
  45     public function getPartitionState($topicName, $partitionId = 0);
  46
  47     /**
  48      * @param string $topicName
  49      * @access public
  50      * @return array
  51      */
  52     public function getTopicDetail($topicName);
  53 }