framework/main/interfaces/io/class_Streamable.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Stream;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for streams
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/io/class_Streamable.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/io/class_Streamable.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface Streamable extends FrameworkInterface {
  35         /**
  36          * Determines seek position
  37          *
  38          * @return      $seekPosition   Current seek position
  39          */
  40         function determineSeekPosition ();
  41
  42         /**
  43          * Seek to given offset (default) or other possibilities as fseek() gives.
  44          *
  45          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
  46          * @param       $whence         Added to offset (default: only use offset to seek to)
  47          * @return      $status         Status of file seek: 0 = success, -1 = failed
  48          */
  49         function seek ($offset, $whence = SEEK_SET);
  50
  51         /**
  52          * Size of file stack
  53          *
  54          * @return      $size   Size (in bytes) of file
  55          */
  56         function size ();
  57
  58 }