3 namespace Org\Mxchange\CoreFramework\Index\File;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Index\Indexable;
9 * An interface for indexable file classes
11 * @author Roland Haeder <webmaster@ship-simu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.ship-simu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface FileIndexer extends Indexable {
32 * Adds given data's hash to the index file
34 * @param $stackName Name of stack to add hash
35 * @param $data Hash and gap position to be added to the index
37 * @throws InvalidArgumentException If a parameter is not valid
39 function addHashedDataToIndex (string $stackName, array $data);
42 * Searches for next suitable gap the given length of data can fit in
43 * including padding bytes.
45 * @param $length Length of raw data
46 * @return $seekPosition Found next gap's seek position
47 * @throws InvalidArgumentException If the parameter is not valid
49 function searchNextGap (int $length);
52 * Writes at given position by seeking to it.
54 * @param $seekPosition Seek position in file
55 * @param $dataStream Data to be written
56 * @return mixed Number of writes bytes or false on error
57 * @throws InvalidArgumentException If a parameter is not valid
59 function writeAtPosition (int $seekPosition, string $dataStream);