RMISocketConfiguration

package saker.build.thirdparty.saker.rmi.connection

public final class RMISocketConfiguration

saker.build.thirdparty.saker.rmi.connection.RMISocketConfiguration

java.lang.Object

Configuration object specifying how sockets should be handled for RMI connections.

Objects if this class are mutable, and reusable.

saker.rmi 0.8.2

Constructors

public	RMISocketConfiguration() Creates a new instance with default values.
public	RMISocketConfiguration(RMISocketConfiguration copy) Creates a new instance with values copied from the parameter.

Methods

public int	getConnectionTimeout() Gets the timeout for initiating connections in milliseconds.
public SocketFactory	getSocketFactory() Gets the socket factory.
public boolean	isConnectionInterruptible() Gets if the connection initiation should be interruptible.
public void	setConnectionInterruptible(boolean connectionInterruptible) Sets the interruptability of connection initiations.
public void	setConnectionTimeout(int connectionTimeout) Sets the timeout for initiating connections in milliseconds.
public void	setSocketFactory(SocketFactory socketFactory) Sets the socket factory.

Inherited methods
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

public RMISocketConfiguration()

Creates a new instance with default values.

public RMISocketConfiguration(RMISocketConfiguration copy) throws NullPointerException

Creates a new instance with values copied from the parameter.

copyThe configuration to copy from.

NullPointerExceptionIf the argument is null.

public int getConnectionTimeout()

Gets the timeout for initiating connections in milliseconds.

Negative value represents an implementation dependent default value, 0 means infinite timeout, and positive values represent the timeout value in milliseconds.

The timeout.

setConnectionTimeout(int)

public SocketFactory getSocketFactory()

Gets the socket factory.

The socket factory. May be null.

setSocketFactory(SocketFactory)

public boolean isConnectionInterruptible()

Gets if the connection initiation should be interruptible.

true if connection initiation may respond to interrupts.

setConnectionInterruptible(boolean)

public void setConnectionInterruptible(boolean connectionInterruptible)

Sets the interruptability of connection initiations.

When set to true, the attempt to initiate connections will be interruptible. This means that if the thread on which the sockets are being connected is interrupted, the sockets will be closed, and ClosedByInterruptException will be thrown.

The property only applies to the duration during which the RMI connection is being initiated.

The default value of this property is false.

connectionInterruptibletrue to enable interruption of connecting.

public void setConnectionTimeout(int connectionTimeout)

Sets the timeout for initiating connections in milliseconds.

Negative value represents an implementation dependent default value, 0 means infinite timeout, and positive values represent the timeout value in milliseconds.

connectionTimeoutThe timeout in millseconds.

public void setSocketFactory(SocketFactory socketFactory)

Sets the socket factory.

The specified socket factory will be used to create new sockets. May be set to null to use the default mechanism.

socketFactoryThe socket factory.