repicea.net

Class TCPSocketWrapper

java.lang.Object

repicea.net.TCPSocketWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SocketWrapper

public class TCPSocketWrapper
extends java.lang.Object
implements SocketWrapper

The TCPSocketWrapper class handles the output and input of a TCP/IP socket.

Constructor Summary

Constructors

Constructor and Description
TCPSocketWrapper(java.net.Socket socket, boolean isJavaObjectExpected) General constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
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 numberOfSeconds) 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TCPSocketWrapper

public TCPSocketWrapper(java.net.Socket socket,
                        boolean isJavaObjectExpected)

General constructor. If the caller is calling from a Java application, then the isJavaObjectExpected boolean should be set to true. Otherwise, the incoming stream is converted to String by default.

Parameters:

socket - a Socket instance

isJavaObjectExpected - a boolean.

Method Detail

readObject

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

Description copied from interface: SocketWrapper

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

Specified by:

readObject in interface SocketWrapper

Returns:

the object that was read from the socket

Throws:

java.lang.Exception

readObject

public java.lang.Object readObject(int numberOfSeconds)
                            throws java.lang.Exception

Description copied from interface: SocketWrapper

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.

Specified by:

readObject in interface SocketWrapper

Parameters:

numberOfSeconds - number of seconds to wait before throwing a TimeoutException

Returns:

the object that was read from the socket

Throws:

java.lang.Exception

writeObject

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

Description copied from interface: SocketWrapper

This method sends an object through the socket.

Specified by:

writeObject in interface SocketWrapper

Parameters:

obj - the object to be sent.

Throws:

java.io.IOException

isClosed

public boolean isClosed()

Description copied from interface: SocketWrapper

This method returns true if the socket has been closed.

Specified by:

isClosed in interface SocketWrapper

Returns:

a boolean

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getInetAddress

public java.net.InetAddress getInetAddress()

Description copied from interface: SocketWrapper

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

Specified by:

getInetAddress in interface SocketWrapper

Returns:

an InetAddress instance