application/hub/interfaces/recipient/class_Recipient.php

   1 <?php
   2 /**
   3  * An interface for recipients
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 interface Recipient extends FrameworkInterface {
  25         /**
  26          * Tries to resolve given recipient into session ids or ip:port combination
  27          * depending on implementation (hint: Template Method Pattern)
  28          *
  29          * @param       $recipient              Recipient to resolve (e.g. could be a virtual recipient or direct session id)
  30          * @param       $listInstance   An instance of a Listable class
  31          * @return      $resolved               Resolved recipient or VOID if only the set list has been filled
  32          * @throws      FrameworkException      Could throw different exceptions back depending on implementation
  33          */
  34         function resolveRecipient ($recipient, Listable $listInstance);
  35 }
  36
  37 // [EOF]
  38 ?>