/*
 * Copyright (c) 2006 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2006-06-21 15:11:09
 * Original Filename: org.sfc.net.p2p.IPeerToPeer.java
 * Version          : 1.0.0
 * Last modification: 2006-06-21
 *                by: Thomas Weise
 * 
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *                    
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */
 
package org.sfc.net.p2p;

import java.net.InetAddress;
import java.net.InetSocketAddress;

/**
 * This interface is common to all software components that offer p2p
 * functionality.
 *
 * @author Thomas Weise
 */
public interface IPeerToPeer
  {

/**
 * Add a peer to the internal peer list.
 * @param p_port  The port where the peer listens, if this parameter is
 *                invalid, we will try to use the same port we're currently
 *                running on.
 * @param p_i     The internet address the peer is located at.
 * @return  <code>true</code> if and only if the peer was not yet known and
 *          has been added successfully.
 */
  public  abstract boolean add_peer  (final InetAddress p_i,
                                      final int         p_port);



/**
 * Add a peer to the internal peer list.
 * @param p_isa   The internet address and port the peer is located at.
 * @return  <code>true</code> if and only if the peer was not yet known and
 *          has been added successfully.
 */
  public  abstract boolean add_peer  (final InetSocketAddress p_isa);


/**
 * Remove a peer from the internal peer list.
 * @param p_isa   The internet address and port the peer is located at.
 * @return  <code>true</code> if and only if the peer was known and
 *          has been removed successfully.
 */
  public  abstract  boolean remove_peer  (final InetSocketAddress p_isa);
  }