org.openqa.selenium.internal

Class SocketLock

java.lang.Object

org.openqa.selenium.internal.SocketLock

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Lock

public class SocketLock
extends java.lang.Object
implements java.io.Closeable, Lock

Implements Lock via an implementation that uses a well-known server socket.

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.InetSocketAddress	address
static int	DEFAULT_PORT
private static long	DELAY_BETWEEN_SOCKET_CHECKS
private static java.net.InetSocketAddress	localhost
private java.net.Socket	lockSocket
private static java.lang.Object	syncObject

Constructor Summary

Constructors

Constructor and Description
SocketLock() Constructs a new SocketLock using the default port.
SocketLock(java.net.InetSocketAddress address) Constructs a new SocketLock.
SocketLock(int lockPort) Constructs a new SocketLock.

Method Summary

Modifier and Type	Method and Description
void	close()
int	getLockPort() Gets the port number that is being-locked.
private boolean	isLockFree(java.net.InetSocketAddress address) Test to see if the lock is free.
void	lock(long timeoutInMillis)
void	unlock()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DELAY_BETWEEN_SOCKET_CHECKS

private static final long DELAY_BETWEEN_SOCKET_CHECKS

See Also:

Constant Field Values

syncObject

private static java.lang.Object syncObject

localhost

private static final java.net.InetSocketAddress localhost

lockSocket

private final java.net.Socket lockSocket

address

private final java.net.InetSocketAddress address

Constructor Detail

SocketLock

public SocketLock()

Constructs a new SocketLock using the default port. Attempts to lock the lock will block until the default port becomes free.

SocketLock

public SocketLock(int lockPort)

Constructs a new SocketLock. Attempts to lock the lock will attempt to acquire the specified port number, and wait for it to become free.

Parameters:

lockPort - the port number to lock

SocketLock

public SocketLock(java.net.InetSocketAddress address)

Constructs a new SocketLock. Attempts to lock the lock will attempt to acquire the specified port number, and wait for it to become free.

Parameters:

address - The port to lock.

Method Detail

lock

public void lock(long timeoutInMillis)
          throws WebDriverException

Specified by:

lock in interface Lock

Throws:

WebDriverException

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

unlock

public void unlock()

Specified by:

unlock in interface Lock

isLockFree

private boolean isLockFree(java.net.InetSocketAddress address)
                    throws java.io.IOException

Test to see if the lock is free. Returns instantaneously.

Parameters:

address - the address to attempt to bind to

Returns:

true if the lock is locked; false if it is not

Throws:

java.io.IOException - if something goes catastrophically wrong with the socket

getLockPort

public int getLockPort()

Gets the port number that is being-locked.

Returns:

port locked