8be635101a78c2e7bf488c95a12a2b0ec60ea96d
[core.git] / inc / classes / interfaces / io / pointer / io / class_InputOutputPointer.php
1 <?php
2 /**
3  * An interface for (mostly) file input/output pointers.
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface InputOutputPointer extends InputPointer, OutputPointer {
25         /**
26          * Rewinds to the beginning of the file
27          *
28          * @return      void
29          */
30         function rewind ();
31
32         /**
33          * Seeks to given position
34          *
35          * @param       $seekPosition   Seek position in file
36          * @param       $whence                 "Seek mode" (see http://de.php.net/fseek)
37          * @return      void
38          */
39         function seek ($seekPosition, $whence = SEEK_SET);
40
41         /**
42          * "Getter" for seek position
43          *
44          * @return      $seekPosition   Seek position
45          */
46         function getSeekPosition ();
47 }
48
49 // [EOF]
50 ?>