3 namespace CoreFramework\Resolver\State;
6 * An instance for state resolver classes
8 * @author Roland Haeder <webmaster@shipsimu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.shipsimu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 interface StateResolver extends Resolver {
29 * Returns an state instance for a given package raw data and socket resource
31 * @param $helperInstance An instance of a ConnectionHelper class
32 * @param $packageData Raw package data
33 * @param $socketResource A valid socket resource
34 * @return $stateInstance An instance of the resolved state
36 static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource);
39 * Checks whether the given state is valid
41 * @param $stateName The default state we shall execute
42 * @return $isValid Whether the given state is valid
43 * @throws EmptyVariableException Thrown if given state is not set
45 function isStateValid ($stateName);