at.borkowski.scovillej.services.comm

Interface SimulationSocket<T>

Type Parameters:

T - the type of data transferred

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

SimulationSocketImpl, SimulationSocketImplA, SimulationSocketImplB

public interface SimulationSocket<T>
extends Closeable

Represents a socket providing communication with a socket on the side of another member.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the amount of objects ready for receiving.
void	close() Closes this socket.
boolean	established() Returns true if a connection is established with the other socket (ie.
T	read() Receives an object from this socket.
void	write(T object) Writes an object to this socket.

Method Detail

established

boolean established()

Returns true if a connection is established with the other socket (ie. if the server socket has accepted the connection).

Returns:

available

int available()
       throws IOException

Returns the amount of objects ready for receiving. This method returns zero if no objects can be received without blocking, and at most the number of object which can be received without blocking (but at least one).

Returns:

an estimate of objects ready for receiving

Throws:

IOException - if any I/O operation fails

read

T read()
throws IOException

Receives an object from this socket. This method blocks if no objects are available.

Returns:

the received object

Throws:

IOException - if receiving fails

write

void write(T object)
    throws IOException

Writes an object to this socket.

Parameters:

object - the object to be written

Throws:

IOException - if sending fails

close

void close()

Closes this socket.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable