3 * A ShutdownSocket visitor
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class ShutdownSocketVisitor extends BaseVisitor implements Visitor {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setVisitorMode('socket');
39 * Creates an instance of this class
41 * @return $visitorInstance An instance a Visitorable class
43 public static final function createShutdownSocketVisitor () {
45 $visitorInstance = new ShutdownSocketVisitor();
47 // Return the prepared instance
48 return $visitorInstance;
52 * "Visit" method to do the actual request. Here we want to shutdown the
55 * @param $helperInstance An instance of a ConnectionHelper class
58 public function visitConnectionHelper (ConnectionHelper $helperInstance) {
59 // Do we have reached the retry count?
60 if (ConnectionStatisticsHelper::isConnectRetryExhausted($helperInstance)) {
61 // Also visit the network package to clear any out-going packages
62 NetworkPackageFactory::createNetworkPackageInstance()->accept($this);
64 // Shutdown the connection
65 $helperInstance->doShutdown();
67 // We can still move on and retry the connection attempt
68 ConnectionStatisticsHelper::increaseConnectRetry($helperInstance);
73 * "Visit" method to do the actual request. Here we want to "partly shutdown"
74 * the network package instance to clear all stacks.
76 * @param $packageInstance An instance of a Deliverable class
79 public function visitNetworkPackage (Deliverable $packageInstance) {
81 $packageInstance->clearAllStacks();
85 * "Visit" the assembler instance. This shall clear any pending data
87 * @param $assemblerInstance An instance of a Assembler class
90 public function visitAssembler (Assembler $assemblerInstance) {
92 $assemblerInstance->clearPendingData();