anon.util

Class SocketGuard

java.lang.Object

anon.util.SocketGuard

public class SocketGuard
extends java.lang.Object

Wraps a Socket object and can close it after a given number of milliseconds.

Constructor Summary

Constructors

Constructor and Description
SocketGuard(java.net.Socket socket, long a_forceCloseAfterMS) Creates a SocketGuard for the given Socket, closing it after a_forceCloseAfterMS milliseconds, or not if 0.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Socket this object holds and its InputStream and OutputStream .
static void	close(java.net.Socket a_socket)
static void	close(SocketGuard a_socket) Closes the given SocketGuard object.
static java.net.Socket	createSocket(java.lang.String a_hostName, int a_port, long a_createTimeout) Creates a new Socket.
static java.net.ServerSocket	createVirtualBoxServerSocket(int a_port, java.net.InetAddress a_excludeAddress)
java.net.InetAddress	getInetAddress()
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream()
java.net.Socket	getSocket()
boolean	isClosed() Returns whether or not the internal Socket is closed or not.
static boolean	isClosed(java.net.Socket a_socket)
static boolean	isClosedSupported() Returns whether or not the Socket implementation used by this JVM supports the isClosed() method.
void	setSoTimeout(int ms)

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketGuard

public SocketGuard(java.net.Socket socket,
                   long a_forceCloseAfterMS)
            throws java.io.IOException

Creates a SocketGuard for the given Socket, closing it after a_forceCloseAfterMS milliseconds, or not if 0.

Parameters:

socket - The socket to guard.

a_forceCloseAfterMS - The amount of time in milliseconds after which the socket is forcefully closed. Might happen earlier due to close(). 0 to leave it open.

Throws:

java.io.IOException

Method Detail

getSocket

public java.net.Socket getSocket()

getInetAddress

public java.net.InetAddress getInetAddress()

getInputStream

public java.io.InputStream getInputStream()

getOutputStream

public java.io.OutputStream getOutputStream()

close

public void close()
           throws java.io.IOException

Closes the Socket this object holds and its InputStream and OutputStream . If an IOException occurred along the way, it gets thrown.

Throws:

java.io.IOException

close

public static void close(SocketGuard a_socket)

Closes the given SocketGuard object.

Parameters:

a_socket -

See Also:

close()

isClosed

public boolean isClosed()

Returns whether or not the internal Socket is closed or not.

Returns:

setSoTimeout

public void setSoTimeout(int ms)
                  throws java.net.SocketException

Throws:

java.net.SocketException

isClosedSupported

public static boolean isClosedSupported()

Returns whether or not the Socket implementation used by this JVM supports the isClosed() method.

Returns:

close

public static void close(java.net.Socket a_socket)
                  throws java.io.IOException

Throws:

java.io.IOException

isClosed

public static boolean isClosed(java.net.Socket a_socket)

Parameters:

a_socket -

Returns:

false if this method is not supported, or if the socket is closed; does only return true if the socket is really closed

createSocket

public static java.net.Socket createSocket(java.lang.String a_hostName,
                                           int a_port,
                                           long a_createTimeout)
                                    throws java.lang.Exception

Creates a new Socket. A timeout can be set for this operation and also it is interruptible. If there occurred an Exception while creating the Socket, this Exception is thrown. If the creation process was interrupted from outside, an InterrupedException is thrown (but the interrupted flag is not set on the thread). If a timeout was specified and reached, a normal Exception is thrown.

Parameters:

a_hostName - The hostname of the target or null for the loopback interface (see java.net.Socket).

a_port - The port of the target.

a_createTimeout - The timeout for creating the new Socket in milliseconds. A timeout of 0 means to wait forever (until Socket creation is ready).

Returns:

The created Socket.

Throws:

java.lang.Exception

createVirtualBoxServerSocket

public static java.net.ServerSocket createVirtualBoxServerSocket(int a_port,
                                                                 java.net.InetAddress a_excludeAddress)