]> git.mxchange.org Git - hub.git/blobdiff - application/hub/main/package/class_NetworkPackage.php
Continued:
[hub.git] / application / hub / main / package / class_NetworkPackage.php
index d6ee7e20d0911648e3ce2ff1792f8011c07a6033..7d396a866993c2e7f3d9daf195ae6d0330f17d7a 100644 (file)
@@ -280,10 +280,10 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                 * which have no recipient address and stamp... ;-) This stacker will
                 * also be used for incoming raw data to handle it.
                 */
-               $stackerInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
+               $stackInstance = ObjectFactory::createObjectByConfiguredName('network_package_stacker_class');
 
                // At last, set it in this class
-               $packageInstance->setStackerInstance($stackerInstance);
+               $packageInstance->setStackInstance($stackInstance);
 
                // Init all stacker
                $packageInstance->initStacks();
@@ -312,7 +312,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        protected function initStacks ($forceReInit = FALSE) {
                // Initialize all
-               $this->getStackerInstance()->initStacks(array(
+               $this->getStackInstance()->initStacks(array(
                        self::STACKER_NAME_UNDECLARED,
                        self::STACKER_NAME_DECLARED,
                        self::STACKER_NAME_OUTGOING,
@@ -380,13 +380,13 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        private function changePackageStatus (array $packageData, $stackerName, $newStatus) {
                // Skip this for empty stacks
-               if ($this->getStackerInstance()->isStackEmpty($stackerName)) {
+               if ($this->getStackInstance()->isStackEmpty($stackerName)) {
                        // This avoids an exception after all packages has failed
                        return;
                } // END - if
 
                // Pop the entry (it should be it)
-               $nextData = $this->getStackerInstance()->popNamed($stackerName);
+               $nextData = $this->getStackInstance()->popNamed($stackerName);
 
                // Compare both signatures
                assert($nextData[self::PACKAGE_DATA_SIGNATURE] == $packageData[self::PACKAGE_DATA_SIGNATURE]);
@@ -395,7 +395,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                $packageData[self::PACKAGE_DATA_STATUS] = $newStatus;
 
                // And push it again
-               $this->getStackerInstance()->pushNamed($stackerName, $packageData);
+               $this->getStackInstance()->pushNamed($stackerName, $packageData);
        }
 
        /**
@@ -466,7 +466,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                        $packageData[self::PACKAGE_DATA_RECIPIENT] = $currentRecipient;
 
                        // Push the declared package to the next stack.
-                       $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
+                       $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECLARED, $packageData);
 
                        // Debug message
                        //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package declared for recipient ' . $currentRecipient);
@@ -551,7 +551,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after validatePeerStateConnected() has been called.');
 
                // Enqueue it again on the out-going queue, the connection is up and working at this point
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING, $packageData);
 
                // Debug message
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Reached line ' . __LINE__ . ' after pushNamed() has been called.');
@@ -655,7 +655,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                );
 
                // Now prepare the temporary array and push it on the 'undeclared' stack
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_UNDECLARED, array(
                        self::PACKAGE_DATA_SENDER    => $this->getSessionId(),
                        self::PACKAGE_DATA_RECIPIENT => $helperInstance->getRecipientType(),
                        self::PACKAGE_DATA_PROTOCOL  => $protocolName,
@@ -672,7 +672,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isPackageEnqueued () {
                // Check whether the stacker is not empty
-               $isEnqueued = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
+               $isEnqueued = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_UNDECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_UNDECLARED)));
 
                // Return the result
                return $isEnqueued;
@@ -685,7 +685,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isPackageDeclared () {
                // Check whether the stacker is not empty
-               $isDeclared = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
+               $isDeclared = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_DECLARED)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECLARED)));
 
                // Return the result
                return $isDeclared;
@@ -698,7 +698,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isPackageWaitingForDelivery () {
                // Check whether the stacker is not empty
-               $isWaitingDelivery = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
+               $isWaitingDelivery = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING)));
 
                // Return the result
                return $isWaitingDelivery;
@@ -711,7 +711,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isEncodedDataPending () {
                // Check whether the stacker is not empty
-               $isPending = (($this->getStackerInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
+               $isPending = (($this->getStackInstance()->isStackInitialized(self::STACKER_NAME_OUTGOING_STREAM)) && (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_OUTGOING_STREAM)));
 
                // Return the result
                return $isPending;
@@ -739,7 +739,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                 * Now there are for sure packages to deliver, so start with the first
                 * one.
                 */
-               $packageData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
+               $packageData = $this->getStackInstance()->popNamed(self::STACKER_NAME_UNDECLARED);
 
                // Declare the raw package data for delivery
                $this->declareRawPackageData($packageData);
@@ -761,7 +761,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                } // END - if
 
                // Get the package
-               $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
+               $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
 
                // Assert on it
                assert(isset($packageData[self::PACKAGE_DATA_RECIPIENT]));
@@ -772,7 +772,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                        $this->deliverRawPackageData($packageData);
 
                        // And remove it finally
-                       $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
+                       $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
                } catch (InvalidStateException $e) {
                        // The state is not excepected (shall be 'connected')
                        self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Caught ' . $e->__toString() . ',message=' . $e->getMessage());
@@ -796,14 +796,14 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                } // END - if
 
                // Get the package
-               $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_OUTGOING);
+               $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_OUTGOING);
 
                try {
                        // Now try to send it
                        $this->sendOutgoingRawPackageData($packageData);
 
                        // And remove it finally
-                       $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING);
+                       $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING);
                } catch (InvalidSocketException $e) {
                        // Output exception message
                        self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Package was not delivered: ' . $e->getMessage());
@@ -823,7 +823,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                assert($this->isEncodedDataPending());
 
                // Pop current data from stack
-               $encodedDataArray = $this->getStackerInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
+               $encodedDataArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_OUTGOING_STREAM);
 
                // Init in this round sent bytes
                $sentBytes = 0;
@@ -877,7 +877,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                }
 
                // Push array back in stack
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_OUTGOING_STREAM, $encodedDataArray);
        }
 
        ///////////////////////////////////////////////////////////////////////////
@@ -891,7 +891,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        private function isRawDataPending () {
                // Just return whether the stack is not empty
-               $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
+               $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_INCOMING));
 
                // Return the status
                return $isPending;
@@ -933,10 +933,10 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                } // END - if
 
                // Very noisy debug message:
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackerInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Stacker size is ' . $this->getStackInstance()->getStackCount(self::STACKER_NAME_DECODED_INCOMING) . ' entries.');
 
                // "Pop" the next entry (the same array again) from the stack
-               $decodedData = $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
+               $decodedData = $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_INCOMING);
 
                // Make sure both array elements are there
                assert(
@@ -952,7 +952,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: errorCode=' . $decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] . '(' . BaseRawDataHandler::SOCKET_ERROR_UNHANDLED . ')');
                assert($decodedData[BaseRawDataHandler::PACKAGE_ERROR_CODE] == BaseRawDataHandler::SOCKET_ERROR_UNHANDLED);
 
-               // Remove the last chunk SEPARATOR (because it is being added and we don't need it)
+               // Remove the last chunk SEPARATOR (because there is no need for it)
                if (substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], -1, 1) == PackageFragmenter::CHUNK_SEPARATOR) {
                        // It is there and should be removed
                        $decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA] = substr($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA], 0, -1);
@@ -960,7 +960,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
 
                // This package is "handled" and can be pushed on the next stack
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Pushing ' . strlen($decodedData[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes to stack ' . self::STACKER_NAME_DECODED_HANDLED . ' ...');
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_HANDLED, $decodedData);
        }
 
        /**
@@ -980,7 +980,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: decodedData[' . gettype($decodedData) . ']=' . print_r($decodedData, TRUE));
 
                // And push it on our stack
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_INCOMING, $decodedData);
        }
 
        /**
@@ -990,7 +990,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isIncomingRawDataHandled () {
                // Determine if the stack is not empty
-               $isHandled = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
+               $isHandled = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_DECODED_HANDLED));
 
                // Return it
                return $isHandled;
@@ -1016,7 +1016,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function ifMultipleMessagesPending () {
                // Determine if the stack is not empty
-               $isPending = (!$this->getAssemblerInstance()->ifMultipleMessagesPending());
+               $isPending = ($this->getAssemblerInstance()->ifMultipleMessagesPending());
 
                // Return it
                return $isPending;
@@ -1055,7 +1055,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                assert($this->isIncomingRawDataHandled());
 
                // Get current package content (an array with two elements; see handleIncomingDecodedData() for details)
-               $packageContent = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
+               $packageContent = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECODED_HANDLED);
 
                // Assert on some elements
                assert(
@@ -1068,11 +1068,11 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                $this->getAssemblerInstance()->chunkPackageContent($packageContent);
 
                // Remove the package from 'handled_decoded' stack ...
-               $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
+               $this->getStackInstance()->popNamed(self::STACKER_NAME_DECODED_HANDLED);
 
                // ... and push it on the 'chunked' stacker
                //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NETWORK-PACKAGE[' . __METHOD__ . ':' . __LINE__ . ']: Pushing ' . strlen($packageContent[BaseRawDataHandler::PACKAGE_RAW_DATA]) . ' bytes on stack ' . self::STACKER_NAME_DECODED_CHUNKED . ',packageContent=' . print_r($packageContent, TRUE));
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_DECODED_CHUNKED, $packageContent);
        }
 
        /**
@@ -1118,7 +1118,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function removeFirstFailedPackage () {
                // Get the package again
-               $packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_DECLARED);
+               $packageData = $this->getStackInstance()->getNamed(self::STACKER_NAME_DECLARED);
 
                // Is the package status 'failed'?
                if ($packageData[self::PACKAGE_DATA_STATUS] != self::PACKAGE_STATUS_FAILED) {
@@ -1127,7 +1127,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                } // END - if
 
                // Remove this entry
-               $this->getStackerInstance()->popNamed(self::STACKER_NAME_DECLARED);
+               $this->getStackInstance()->popNamed(self::STACKER_NAME_DECLARED);
        }
 
        /**
@@ -1214,7 +1214,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
                $decodedContent[self::PACKAGE_CONTENT_MESSAGE] = $this->getCompressorInstance()->decompressStream($decodedContent[self::PACKAGE_CONTENT_MESSAGE]);
 
                // And push it on the next stack
-               $this->getStackerInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
+               $this->getStackInstance()->pushNamed(self::STACKER_NAME_NEW_MESSAGE, $decodedContent);
        }
 
        /**
@@ -1224,7 +1224,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isNewMessageArrived () {
                // Determine if the stack is not empty
-               $hasArrived = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
+               $hasArrived = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_NEW_MESSAGE));
 
                // Return it
                return $hasArrived;
@@ -1238,7 +1238,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function handleNewlyArrivedMessage () {
                // Get it from the stacker, it is the full array with the decoded message
-               $decodedContent = $this->getStackerInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
+               $decodedContent = $this->getStackInstance()->popNamed(self::STACKER_NAME_NEW_MESSAGE);
 
                // Now get a filter chain back from factory with given tags array
                $chainInstance = PackageFilterChainFactory::createChainByTagsArray($decodedContent[self::PACKAGE_CONTENT_TAGS]);
@@ -1257,7 +1257,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function isProcessedMessagePending () {
                // Check it
-               $isPending = (!$this->getStackerInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
+               $isPending = (!$this->getStackInstance()->isStackEmpty(self::STACKER_NAME_PROCESSED_MESSAGE));
 
                // Return it
                return $isPending;
@@ -1270,7 +1270,7 @@ class NetworkPackage extends BaseHubSystem implements Deliverable, Receivable, R
         */
        public function handleProcessedMessage () {
                // Get it from the stacker, it is the full array with the processed message
-               $messageArray = $this->getStackerInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
+               $messageArray = $this->getStackInstance()->popNamed(self::STACKER_NAME_PROCESSED_MESSAGE);
 
                // Add type for later easier handling
                $messageArray[self::MESSAGE_ARRAY_DATA][self::MESSAGE_ARRAY_TYPE] = $messageArray[self::MESSAGE_ARRAY_TYPE];