3 * An interface for recipient discovery
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 interface DiscoverableNodeRecipient extends FrameworkInterface, IteratorAggregate {
26 * Tries to discover all recipients for given package data
28 * @param $packageData Raw package data array
31 function discoverRecipients (array $packageData);
34 * Tries to discover all recipients by given decoded package data.
36 * @param $decodedData Raw raw package data array
39 function discoverRawRecipients (array $decodedData);
42 * "Getter" for recipient iterator
44 * @return $iteratorInstance An instance of a Iterateable object
46 function getIterator ();
49 * Clears all recipients for e.g. another package to deliver
53 function clearRecipients ();