Package org.apache.hadoop.net.unix

Class DomainSocketWatcher

java.lang.Object

org.apache.hadoop.net.unix.DomainSocketWatcher

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

@LimitedPrivate("HDFS")
public final class DomainSocketWatcher
extends java.lang.Object
implements java.io.Closeable

The DomainSocketWatcher watches a set of domain sockets to see when they become readable, or closed. When one of those events happens, it makes a callback. See DomainSocket for more information about UNIX domain sockets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainSocketWatcher.Handler

Constructor Summary

Constructors

Constructor	Description
DomainSocketWatcher(int interruptCheckPeriodMs, java.lang.String src)

Method Summary

Modifier and Type	Method	Description
void	add(DomainSocket sock, DomainSocketWatcher.Handler handler)	Add a socket.
void	close()	Close the DomainSocketWatcher and wait for its thread to terminate.
static java.lang.String	getLoadingFailureReason()
boolean	isClosed()
void	remove(DomainSocket sock)	Remove a socket.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainSocketWatcher

public DomainSocketWatcher(int interruptCheckPeriodMs,
                           java.lang.String src)
                    throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLoadingFailureReason

public static java.lang.String getLoadingFailureReason()

close

public void close()
           throws java.io.IOException

Close the DomainSocketWatcher and wait for its thread to terminate. If there is more than one close, all but the first will be ignored.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

isClosed

@VisibleForTesting
public boolean isClosed()

add

public void add(DomainSocket sock,
                DomainSocketWatcher.Handler handler)

Add a socket.

Parameters:

sock - The socket to add. It is an error to re-add a socket that we are already watching.

handler - The handler to associate with this socket. This may be called any time after this function is called.

remove

public void remove(DomainSocket sock)

Remove a socket. Its handler will be called.

Parameters:

sock - The socket to remove.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object