danger.net
Class IPCServerSocket

java.lang.Object
  |
  +--danger.net.IPCServerSocket

public final class IPCServerSocket

extends java.lang.Object

The server side of an IPC socket. The public methods mimic the methods from java.io.ServerSocket.

Inner Class Summary

static interface	IPCServerSocket.CloseListener Interface for object to be notified when an (outer) instance is closed.
class	IPCServerSocket.Connector Class that is used to cause connections to be made.

Constructor Summary

IPCServerSocket(java.lang.String name, IPCServerSocket.CloseListener closeListener)
Construct an instance.

Method Summary

IPCSocket	accept() Accept a connection.
void	close() Close this instance.
IPCServerSocket.Connector	getConnector() Get the associated Connector.
java.lang.String	getName() Get the name associated with this instance.
int	getSoTimeout() Get the timeout of this instance.
boolean	isClosed() Return whether or not this instance is closed.
void	setSoTimeout(int timeout) Set the timeout of this instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IPCServerSocket

public IPCServerSocket(java.lang.String name,
                       IPCServerSocket.CloseListener closeListener)

Construct an instance.

Parameters:

name - non-null; the name the instance is bound to

closeListener - null-ok; object to notify when this instance is closed

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Get the name associated with this instance.

Returns:

non-null; the name

getConnector

public IPCServerSocket.Connector getConnector()

Get the associated Connector. For security reasons, this method works exactly once: the entity that creates this instance should call this method to retrieve the connector, and then only that entity has the power to cause a connection to happen. Once that happens, then this instance may be handed out freely, knowing that it can only be used to accept--not instigate--connections.

Returns:

non-null; the associated connector

Throws:

java.lang.RuntimeException - thrown if this method has already been called

accept

public IPCSocket accept()
                 throws java.io.IOException

Accept a connection. This will block until a connection is established or until the timeout occurs. If the timeout occurs, then this method throws InterruptedIOException.

Returns:

non-null; a socket representing the newly-established connection

Throws:

java.io.IOException - thrown if there's trouble

close

public void close()
           throws java.io.IOException

Close this instance.

Throws:

java.io.IOException - thrown if there's trouble

isClosed

public boolean isClosed()

Return whether or not this instance is closed.

Returns:

true iff this instance is closed

setSoTimeout

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

Set the timeout of this instance. The timeout must be non-negative, and it is a number of milliseconds to wait at most in a call to accept(). If it is passed as 0, then it indicates that accept calls should block indefinitely.

Parameters:

timeout - >= 0; the new timeout value, in milliseconds

Throws:

java.net.SocketException - thrown if there's trouble

See Also:

getSoTimeout()

getSoTimeout

public int getSoTimeout()
                 throws java.io.IOException

Get the timeout of this instance.

Returns:

>= 0; the timeout value, in milliseconds

Throws:

java.io.IOException - thrown if there's trouble

See Also:

setSoTimeout(int)