repicea.net

Interface SocketWrapper

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

TCPSocketWrapper, UDPSocketWrapper

public interface SocketWrapper
extends java.io.Closeable

This interface ensures that the wrapper can read and write and knows whether it is closed or not.

Method Summary

Modifier and Type	Method and Description
java.net.InetAddress	getInetAddress() This method returns the address of the socket that is bound to this socket.
boolean	isClosed() This method returns true if the socket has been closed.
java.lang.Object	readObject() This method reads the object from the socket.
java.lang.Object	readObject(int timeout) This method reads an object from the socket.
void	writeObject(java.lang.Object obj) This method sends an object through the socket.

Methods inherited from interface java.io.Closeable

close

Method Detail

readObject

java.lang.Object readObject()
                     throws java.lang.Exception

This method reads the object from the socket. There is no timeout.

Returns:

the object that was read from the socket

Throws:

java.lang.Exception

readObject

java.lang.Object readObject(int timeout)
                     throws java.lang.Exception

This method reads an object from the socket. There is a timeout after a given number of seconds. If the number of seconds is equal to or smaller than 0, then there is no timeout.

Parameters:

timeout - number of seconds to wait before throwing a TimeoutException

Returns:

the object that was read from the socket

Throws:

java.lang.Exception

writeObject

void writeObject(java.lang.Object obj)
          throws java.io.IOException

This method sends an object through the socket.

Parameters:

obj - the object to be sent.

Throws:

java.io.IOException

isClosed

boolean isClosed()

This method returns true if the socket has been closed.

Returns:

a boolean

getInetAddress

java.net.InetAddress getInetAddress()

This method returns the address of the socket that is bound to this socket.

Returns:

an InetAddress instance