/*
** This file is part of Filius, a network construction and simulation software.
** 
** Originally created at the University of Siegen, Institute "Didactics of
** Informatics and E-Learning" by a students' project group:
**     members (2006-2007): 
**         André Asschoff, Johannes Bade, Carsten Dittich, Thomas Gerding,
**         Nadja Haßler, Ernst Johannes Klebert, Michell Weyer
**     supervisors:
**         Stefan Freischlad (maintainer until 2009), Peer Stechert
** Project is maintained since 2010 by Christian Eibl <filius@c.fameibl.de>
 **         and Stefan Freischlad
** Filius 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 2 of the License, or
** (at your option) version 3.
** 
** Filius 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 Filius.  If not, see <http://www.gnu.org/licenses/>.
*/
package filius.software.transportschicht;

/** Die SocketSchnittstelle beschreibt die Methoden, die von UDP- und
 * TCP-Socket (auch Server-Socket) bereitgestellt werden. Das
 * Transportprotokoll verwendet die Methode hinzufuegen() zur
 * Weitergabe von eintreffenden Segmenten, die dort dem Ziel-Socket
 * zugeordnet werden.
 */
public interface SocketSchnittstelle {

	/** Methode zur Weitergabe von Segmenten an den Socket, der die
	 * Schnittstelle zur Anwendung darstellt.
	 *
	 * @param startIp IP-Adresse von der das Segment eingetroffen ist
	 * @param startPort Port von der das Segment verschickt wurde
	 * @param segment das eingetroffene Segment
	 */
	public void hinzufuegen(String startIp, int startPort, Object segment);

	/** Methode zum schliessen eines Sockets. */
	public void schliessen();

	/** Methode zum Beenden eines Sockets beim Wechsel vom Aktions- in
	 * den Entwurfsmodus. Der Zustand des Sockets danach ist nicht
	 * bestimmt. Er sollte daher nicht weiter verwendet werden!
	 */
	public void beenden();
}