Class InterruptibleRMIClientSocket

java.lang.Object

java.net.Socket

ecmwf.common.rmi.interruptible.InterruptibleRMIClientSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public final class InterruptibleRMIClientSocket
extends Socket

The Class InterruptibleRMIClientSocket.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Socket	currentDecoratee	The current decoratee.
protected static final byte	SHUTDOWN_SOCKET	The Constant SHUTDOWN_SOCKET.

Constructor Summary

Constructors

Constructor	Description
InterruptibleRMIClientSocket(Socket decoratee)	Create a decorator for the given socket.

Method Summary

Modifier and Type	Method	Description
void	bind(SocketAddress bindpoint)	Bind.
void	close()	Close.
void	connect(SocketAddress endpoint)	Connect.
void	connect(SocketAddress endpoint, int timeout)	Connect.
boolean	equals(Object object)	Return true if the object is an instance of InterruptibleRMIClientSocket and decoratee.equals(object) returns true.
SocketChannel	getChannel()	This decorator does not implement a decorated SocketChannel.
InetAddress	getInetAddress()	Gets the inet address.
InputStream	getInputStream()	Return an instance of InterruptibleRMISocket.InterruptibleRMISocketInputStream that decorates the InputStream returned by decoratee#getInputStream.
boolean	getKeepAlive()	Gets the keep alive.
InetAddress	getLocalAddress()	Gets the local address.
int	getLocalPort()	Gets the local port.
SocketAddress	getLocalSocketAddress()	Gets the local socket address.
boolean	getOOBInline()	Gets the OOB inline.
OutputStream	getOutputStream()	Return an instance of InterruptibleRMISocket.InterruptibleRMISocketOutputStream that decorates the OutputStream returned by decoratee#getOutputStream.
int	getPort()	Gets the port.
int	getReceiveBufferSize()	Gets the receive buffer size.
SocketAddress	getRemoteSocketAddress()	Gets the remote socket address.
boolean	getReuseAddress()	Gets the reuse address.
int	getSendBufferSize()	Gets the send buffer size.
int	getSoLinger()	Gets the so linger.
int	getSoTimeout()	Gets the so timeout.
boolean	getTcpNoDelay()	Gets the tcp no delay.
int	getTrafficClass()	Gets the traffic class.
int	hashCode()	Return decoratee#hashCode().
boolean	isBound()	Checks if is bound.
boolean	isClosed()	Checks if is closed.
boolean	isConnected()	Checks if is connected.
boolean	isInputShutdown()	Checks if is input shutdown.
boolean	isOutputShutdown()	Checks if is output shutdown.
void	sendUrgentData(int data)	Send urgent data.
void	setKeepAlive(boolean on)	Sets the keep alive.
void	setOOBInline(boolean on)	Sets the OOB inline.
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth)	Sets the performance preferences.
void	setReceiveBufferSize(int size)	Sets the receive buffer size.
void	setReuseAddress(boolean on)	Sets the reuse address.
void	setSendBufferSize(int size)	Sets the send buffer size.
void	setSoLinger(boolean on, int linger)	Sets the so linger.
void	setSoTimeout(int timeout)	Sets the so timeout.
void	setTcpNoDelay(boolean on)	Sets the tcp no delay.
void	setTrafficClass(int tc)	Sets the traffic class.
void	shutdownInput()	Shutdown input.
void	shutdownOutput()	Shutdown output.
String	toString()	Return decoratee#toString().

Methods inherited from class java.net.Socket

getOption, setOption, setSocketImplFactory, supportedOptions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SHUTDOWN_SOCKET

protected static final byte SHUTDOWN_SOCKET

The Constant SHUTDOWN_SOCKET. Special value to indicate that the server side socket should shutdown.

See Also:

• Constant Field Values

currentDecoratee

protected final Socket currentDecoratee

The current decoratee.

Constructor Details

InterruptibleRMIClientSocket

public InterruptibleRMIClientSocket(Socket decoratee)

Create a decorator for the given socket.

Parameters:

decoratee - the decoratee

Method Details

bind

public void bind(SocketAddress bindpoint)
          throws IOException

Bind.

Overrides:

bind in class Socket

Throws:

IOException

See Also:

• Socket.bind(java.net.SocketAddress)

close

public void close()
           throws IOException

Close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Socket

Throws:

IOException

See Also:

• Socket.close()

connect

public void connect(SocketAddress endpoint)
             throws IOException

Connect.

Overrides:

connect in class Socket

Throws:

IOException

See Also:

• Socket.connect(java.net.SocketAddress)

connect

public void connect(SocketAddress endpoint,
 int timeout)
             throws IOException

Connect.

Overrides:

connect in class Socket

Throws:

IOException

See Also:

• Socket.connect(java.net.SocketAddress, int)

equals

public boolean equals(Object object)

Return true if the object is an instance of InterruptibleRMIClientSocket and decoratee.equals(object) returns true.

Overrides:

equals in class Object

getChannel

public SocketChannel getChannel()

This decorator does not implement a decorated SocketChannel. This method will always return null.

Overrides:

getChannel in class Socket

getInetAddress

public InetAddress getInetAddress()

Gets the inet address.

Overrides:

getInetAddress in class Socket

See Also:

• Socket.getInetAddress()

getInputStream

public InputStream getInputStream()
                           throws IOException

Return an instance of InterruptibleRMISocket.InterruptibleRMISocketInputStream that decorates the InputStream returned by decoratee#getInputStream.

Overrides:

getInputStream in class Socket

Throws:

IOException

See Also:

• Socket.getInputStream()

getKeepAlive

public boolean getKeepAlive()
                     throws SocketException

Gets the keep alive.

Overrides:

getKeepAlive in class Socket

Throws:

SocketException

See Also:

• Socket.getKeepAlive()

getLocalAddress

public InetAddress getLocalAddress()

Gets the local address.

Overrides:

getLocalAddress in class Socket

See Also:

• Socket.getLocalAddress()

getLocalPort

public int getLocalPort()

Gets the local port.

Overrides:

getLocalPort in class Socket

See Also:

• Socket.getLocalPort()

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Gets the local socket address.

Overrides:

getLocalSocketAddress in class Socket

See Also:

• Socket.getLocalSocketAddress()

getOOBInline

public boolean getOOBInline()
                     throws SocketException

Gets the OOB inline.

Overrides:

getOOBInline in class Socket

Throws:

SocketException

See Also:

• Socket.getOOBInline()

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Return an instance of InterruptibleRMISocket.InterruptibleRMISocketOutputStream that decorates the OutputStream returned by decoratee#getOutputStream.

Overrides:

getOutputStream in class Socket

Throws:

IOException

See Also:

• Socket.getInputStream()

getPort

public int getPort()

Gets the port.

Overrides:

getPort in class Socket

See Also:

• Socket.getPort()

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws SocketException

Gets the receive buffer size.

Overrides:

getReceiveBufferSize in class Socket

Throws:

SocketException

See Also:

• Socket.getReceiveBufferSize()

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Gets the remote socket address.

Overrides:

getRemoteSocketAddress in class Socket

See Also:

• Socket.getRemoteSocketAddress()

getReuseAddress

public boolean getReuseAddress()
                        throws SocketException

Gets the reuse address.

Overrides:

getReuseAddress in class Socket

Throws:

SocketException

See Also:

• Socket.getReuseAddress()

getSendBufferSize

public int getSendBufferSize()
                      throws SocketException

Gets the send buffer size.

Overrides:

getSendBufferSize in class Socket

Throws:

SocketException

See Also:

• Socket.getSendBufferSize()

getSoLinger

public int getSoLinger()
                throws SocketException

Gets the so linger.

Overrides:

getSoLinger in class Socket

Throws:

SocketException

See Also:

• Socket.getSoLinger()

getSoTimeout

public int getSoTimeout()
                 throws SocketException

Gets the so timeout.

Overrides:

getSoTimeout in class Socket

Throws:

SocketException

See Also:

• Socket.getSoTimeout()

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws SocketException

Gets the tcp no delay.

Overrides:

getTcpNoDelay in class Socket

Throws:

SocketException

See Also:

• Socket.getTcpNoDelay()

getTrafficClass

public int getTrafficClass()
                    throws SocketException

Gets the traffic class.

Overrides:

getTrafficClass in class Socket

Throws:

SocketException

See Also:

• Socket.getTrafficClass()

hashCode

public int hashCode()

Return decoratee#hashCode().

Overrides:

hashCode in class Object

isBound

public boolean isBound()

Checks if is bound.

Overrides:

isBound in class Socket

See Also:

• Socket.isBound()

isClosed

public boolean isClosed()

Checks if is closed.

Overrides:

isClosed in class Socket

See Also:

• Socket.isClosed()

isConnected

public boolean isConnected()

Checks if is connected.

Overrides:

isConnected in class Socket

See Also:

• Socket.isConnected()

isInputShutdown

public boolean isInputShutdown()

Checks if is input shutdown.

Overrides:

isInputShutdown in class Socket

See Also:

• Socket.isInputShutdown()

isOutputShutdown

public boolean isOutputShutdown()

Checks if is output shutdown.

Overrides:

isOutputShutdown in class Socket

See Also:

• Socket.isOutputShutdown()

sendUrgentData

public void sendUrgentData(int data)
                    throws IOException

Send urgent data.

Overrides:

sendUrgentData in class Socket

Throws:

IOException

See Also:

• Socket.sendUrgentData(int)

setKeepAlive

public void setKeepAlive(boolean on)
                  throws SocketException

Sets the keep alive.

Overrides:

setKeepAlive in class Socket

Throws:

SocketException

See Also:

• Socket.setKeepAlive(boolean)

setOOBInline

public void setOOBInline(boolean on)
                  throws SocketException

Sets the OOB inline.

Overrides:

setOOBInline in class Socket

Throws:

SocketException

See Also:

• Socket.setOOBInline(boolean)

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
 int latency,
 int bandwidth)

Sets the performance preferences.

Overrides:

setPerformancePreferences in class Socket

See Also:

• Socket.setPerformancePreferences(int, int, int)

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws SocketException

Sets the receive buffer size.

Overrides:

setReceiveBufferSize in class Socket

Throws:

SocketException

See Also:

• Socket.setReceiveBufferSize(int)

setReuseAddress

public void setReuseAddress(boolean on)
                     throws SocketException

Sets the reuse address.

Overrides:

setReuseAddress in class Socket

Throws:

SocketException

See Also:

• Socket.setReuseAddress(boolean)

setSendBufferSize

public void setSendBufferSize(int size)
                       throws SocketException

Sets the send buffer size.

Overrides:

setSendBufferSize in class Socket

Throws:

SocketException

See Also:

• Socket.setSendBufferSize(int)

setSoLinger

public void setSoLinger(boolean on,
 int linger)
                 throws SocketException

Sets the so linger.

Overrides:

setSoLinger in class Socket

Throws:

SocketException

See Also:

• Socket.setSoLinger(boolean, int)

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Sets the so timeout.

Overrides:

setSoTimeout in class Socket

Throws:

SocketException

See Also:

• Socket.setSoTimeout(int)

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws SocketException

Sets the tcp no delay.

Overrides:

setTcpNoDelay in class Socket

Throws:

SocketException

See Also:

• Socket.setTcpNoDelay(boolean)

setTrafficClass

public void setTrafficClass(int tc)
                     throws SocketException

Sets the traffic class.

Overrides:

setTrafficClass in class Socket

Throws:

SocketException

See Also:

• Socket.setTrafficClass(int)

shutdownInput

public void shutdownInput()
                   throws IOException

Shutdown input.

Overrides:

shutdownInput in class Socket

Throws:

IOException

See Also:

• Socket.shutdownInput()

shutdownOutput

public void shutdownOutput()
                    throws IOException

Shutdown output.

Overrides:

shutdownOutput in class Socket

Throws:

IOException

See Also:

• Socket.shutdownOutput()

toString

public String toString()

Return decoratee#toString().

Overrides:

toString in class Socket