Added exception from 'hub' project

[core.git] / inc / classes / interfaces / block / class_Block.php

diff --git a/inc/classes/interfaces/block/class_Block.php b/inc/classes/interfaces/block/class_Block.php
index 449454c54055aa8ed18900e21663648684dd7291..12c99f0ffd108ed97d0d3df5fb54ee27fce92810 100644 (file)
--- a/inc/classes/interfaces/block/class_Block.php
+++ b/inc/classes/interfaces/block/class_Block.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -36,16 +36,6 @@ interface Block extends FrameworkInterface {
         */
        function flushFileHeader ();
 
-       /**
-        * Close a file source and set it's instance to null and the file name
-        * to empty.
-        *
-        * @return      void
-        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
-        */
-       function closeFile ();
-
        /**
         * Determines whether the EOF has been reached
         *
@@ -120,6 +110,44 @@ interface Block extends FrameworkInterface {
         * @return      $fileSize       Size of currently loaded file
         */
        function getFileSize ();
+
+       /**
+        * Writes given value to the file and returns a hash and gap position for it
+        *
+        * @param       $groupId        Group identifier
+        * @param       $value          Value to be added to the stack
+        * @return      $data           Hash and gap position
+        */
+       function writeValueToFile ($groupId, $rawData);
+
+       /**
+        * Writes given raw data to the file and returns a gap position and length
+        *
+        * @param       $groupId        Group identifier
+        * @param       $hash           Hash from encoded value
+        * @param       $encoded        Encoded value to be written to the file
+        * @return      $data           Gap position and length of the raw data
+        */
+       function writeDataToFreeGap ($groupId, $hash, $encoded);
+
+       /**
+        * Writes data at given position
+        *
+        * @param       $seekPosition   Seek position
+        * @param       $data                   Data to be written
+        * @param       $flushHeader    Whether to flush the header (default: flush)
+        * @return      void
+        */
+       function writeData ($seekPosition, $data, $flushHeader = TRUE);
+
+       /**
+        * Searches for next suitable gap the given length of data can fit in
+        * including padding bytes.
+        *
+        * @param       $length                 Length of raw data
+        * @return      $seekPosition   Found next gap's seek position
+        */
+       function searchNextGap ($length);
 }
 
 // [EOF]