<?php
/**
 * An interface for connection helper classes
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
interface ConnectionHelper extends Helper {
	/**
	 * Sends raw package data to the recipient
	 *
	 * @param	$packageData		Raw package data
	 * @return	$totalSentBytes		Total sent bytes to the peer
	 * @throws	InvalidSocketException	If we got a problem with this socket
	 */
	function sendRawPackageData (array $packageData);

	/**
	 * Checks wether the connect retry is exhausted
	 *
	 * @return	$isExhaused		Wether connect retry is exchausted
	 */
	function isConnectRetryExhausted ();

	/**
	 * Do the shutdown sequence for this connection helper
	 *
	 * @todo	We may want to implement a filter for ease notification of other objects like our pool
	 * @return	void
	 * @throws	SocketShutdownException		If the current socket could not be shut down
	 */
	function doShutdown ();
}

// [EOF]
?>