3 * A general ConnectionHelper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 BaseConnectionHelper extends BaseHubHelper implements Registerable, ProtocolHandler {
28 private $protocol = 'invalid';
43 private $sentData = 0;
51 * Connect retries for this connection
53 private $retryCount = 0;
56 * Wether this connection is shutted down
58 private $shuttedDown = false;
61 * Currently sent chunks
63 private $sentChunks = array();
68 private $currentFinalHash = '';
71 * Protected constructor
73 * @param $className Name of the class
76 protected function __construct ($className) {
77 // Call parent constructor
78 parent::__construct($className);
80 // Register this connection helper
81 Registry::getRegistry()->addInstance('connection', $this);
85 * Getter for port number to satify ProtocolHandler
87 * @return $port The port number
89 public final function getPort () {
94 * Setter for port number to satify ProtocolHandler
96 * @param $port The port number
99 protected final function setPort ($port) {
104 * Getter for protocol
106 * @return $protocol Used protocol
108 public final function getProtocol () {
109 return $this->protocol;
113 * Setter for protocol
115 * @param $protocol Used protocol
118 protected final function setProtocol ($protocol) {
119 $this->protocol = $protocol;
123 * Getter for IP address
125 * @return $address The IP address
127 public final function getAddress () {
128 return $this->address;
132 * Setter for IP address
134 * @param $address The IP address
137 protected final function setAddress ($address) {
138 $this->address = $address;
142 * "Getter" for raw data from a package array. A fragmenter is used which
143 * will returns us only so many raw data which fits into the back buffer.
144 * The rest is being held in a back-buffer and waits there for the next
145 * cycle and while be then sent.
147 * This method does 4 simple steps:
148 * 1) Aquire fragmenter object instance from the factory
149 * 2) Handle over the package data array to the fragmenter
151 * 4) Finally return the chunk (array) to the caller
153 * @param $packageData Raw package data array
154 * @return $rawDataChunk An array with the raw data as value and chunk hash as key
156 private function getRawDataFromPackageArray (array $packageData) {
157 // If there is no fragmenter?
158 if (!Registry::getRegistry()->instanceExists('package_fragmenter')) {
159 // Get the fragmenter instance
160 $fragmenterInstance = ObjectFactory::createObjectByConfiguredName('package_fragmenter_class');
162 // Add it to the registry
163 Registry::getRegistry()->addInstance('package_fragmenter', $fragmenterInstance);
165 // Get fragmenter from registry
166 $fragmenterInstance = Registry::getRegistry()->getInstance('package_fragmenter');
169 // Implode the package data array and fragement the resulting string, returns the final hash
170 $this->currentFinalHash = $fragmenterInstance->fragmentPackageArray($packageData, $this);
172 // Get the next raw data chunk from the fragmenter
173 $rawDataChunk = $fragmenterInstance->getNextRawDataChunk($this->currentFinalHash);
176 return $rawDataChunk;
180 * "Accept" a visitor by simply calling it back
182 * @param $visitorInstance A Visitor instance
185 protected final function accept (Visitor $visitorInstance) {
186 // Just call the visitor
187 $visitorInstance->visitConnectionHelper($this);
191 * Sends raw package data to the recipient
193 * @param $packageData Raw package data
194 * @return $sentBytes Actual sent bytes to the peer
195 * @throws InvalidSocketException If we got a problem with this socket
197 public function sendRawPackageData (array $packageData) {
198 // Convert the package data array to a raw data stream
199 $rawDataChunk = $this->getRawDataFromPackageArray($packageData);
201 // Get socket resource
202 $socketResource = $this->getSocketResource();
205 $sentBytes = @socket_write($socketResource, $rawData, $this->getConfigInstance()->getConfigEntry($this->getProtocol() . '_buffer_length') - $this->offset);
207 // If there was an error, we don't continue here
208 if ($sentBytes === false) {
209 // Get socket error code for verification
210 $socketError = socket_last_error($socketResource);
213 $errorMessage = socket_strerror($socketError);
215 // Shutdown this socket
216 $this->shutdownSocket($socketResource);
219 throw new InvalidSocketException(array($this, gettype($socketResource), $socketError, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
222 // The difference between sent bytes and length of raw data should not be below zero
223 assert((strlen($rawData) - $sentBytes) >= 0);
230 * Getter for real class name
232 * @return $class Name of this class
234 public function __toString () {
235 // Class name representation
236 $class = $this->getAddress() . ':' . $this->getPort() . ':' . parent::__toString();
243 * Checks wether the connect retry is exhausted
245 * @return $isExhaused Wether connect retry is exchausted
247 public final function isConnectRetryExhausted () {
248 // Construct config entry
249 $configEntry = $this->getProtocol() . '_connect_retry_max';
252 $isExhausted = ($this->retryCount >= $this->getConfigInstance()->getConfigEntry($configEntry));
259 * Increases the connect retry count
263 public final function increaseConnectRetry () {
268 * Marks this connection as shutted down
272 protected final function markConnectionShutdown () {
273 $this->shuttedDown = true;
277 * Getter for shuttedDown
279 * @return $shuttedDown Wether this connection is shutted down
281 public final function isShuttedDown () {
282 return $this->shuttedDown;