inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php

   1 <?php
   2 /**
   3  * An interface for seekable iterators which also allow to write to the file
   4  * in different ways.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 interface SeekableWritableFileIterator extends SeekableIterator {
  26         /**
  27          * Seeks to given position
  28          *
  29          * @param       $seekPosition   Seek position in file
  30          * @return      $status                 Status of this operation
  31          */
  32         function seek ($seekPosition);
  33
  34         /**
  35          * Size of file stack
  36          *
  37          * @return      $size   Size (in bytes) of file
  38          */
  39         function size ();
  40
  41         /**
  42          * Writes at given position by seeking to it.
  43          *
  44          * @param       $seekPosition   Seek position in file
  45          * @param       $data                   Data to be written
  46          * @return      void
  47          */
  48         function writeAtPosition ($seedPosition, $data);
  49
  50         /**
  51          * Reads given amount of bytes from file.
  52          *
  53          * @param       $bytes  Amount of bytes to read
  54          * @return      $data   Data read from file
  55          */
  56         function read ($bytes);
  57
  58         /**
  59          * Analyzes entries in index file. This will count all found (and valid)
  60          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
  61          * only gaps are found, the file is considered as "virgin" (no entries).
  62          *
  63          * @return      void
  64          */
  65         function analyzeFile ();
  66
  67         /**
  68          * Checks whether the file header is initialized
  69          *
  70          * @return      $isInitialized  Whether the file header is initialized
  71          */
  72         function isFileHeaderInitialized ();
  73
  74         /**
  75          * Creates the assigned file
  76          *
  77          * @return      void
  78          */
  79         function createFileHeader ();
  80
  81         /**
  82          * Pre-allocates file (if enabled) with some space for later faster write access.
  83          *
  84          * @param       $type   Type of the file
  85          * @return      void
  86          */
  87         function preAllocateFile ($type);
  88
  89         /**
  90          * Initializes counter for valid entries, arrays for damaged entries and
  91          * an array for gap seek positions. If you call this method on your own,
  92          * please re-analyze the file structure. So you are better to call
  93          * analyzeFile() instead of this method.
  94          *
  95          * @return      void
  96          */
  97         function initCountersGapsArray ();
  98
  99         /**
 100          * Getter for header size
 101          *
 102          * @return      $totalEntries   Size of file header
 103          */
 104         function getHeaderSize ();
 105
 106         /**
 107          * Setter for header size
 108          *
 109          * @param       $headerSize             Size of file header
 110          * @return      void
 111          */
 112         function setHeaderSize ($headerSize);
 113 }
 114
 115 // [EOF]
 116 ?>