vendor/nmred/kafka-php/src/Kafka/Protocol/Fetch/Helper/HelperAbstract.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\Protocol\Fetch\Helper;
  16
  17 /**
  18 +------------------------------------------------------------------------------
  19 * Kafka protocol since Kafka v0.8
  20 +------------------------------------------------------------------------------
  21 *
  22 * @package
  23 * @version $_SWANBR_VERSION_$
  24 * @copyright Copyleft
  25 * @author $_SWANBR_AUTHOR_$
  26 +------------------------------------------------------------------------------
  27 */
  28
  29 abstract class HelperAbstract
  30 {
  31     // {{{ members
  32     // }}}
  33     // {{{ functions
  34     // {{{ abstract public function onStreamEof()
  35
  36     /**
  37      * on stream eof
  38      *
  39      * @param string $streamKey
  40      * @access public
  41      * @return void
  42      */
  43     abstract public function onStreamEof($streamKey);
  44
  45     // }}}
  46     // {{{ abstract public function onTopicEof()
  47
  48     /**
  49      * on topic eof
  50      *
  51      * @param string $topicName
  52      * @access public
  53      * @return void
  54      */
  55     abstract public function onTopicEof($topicName);
  56
  57     // }}}
  58     // {{{ abstract public function onPartitionEof()
  59
  60     /**
  61      * on partition eof
  62      *
  63      * @param \Kafka\Protocol\Fetch\Partition $partition
  64      * @access public
  65      * @return void
  66      */
  67     abstract public function onPartitionEof($partition);
  68
  69     // }}}
  70     // }}}
  71 }