net.yacy.cora.protocol

Class TimeoutRequest<E>

java.lang.Object

net.yacy.cora.protocol.TimeoutRequest<E>

public class TimeoutRequest<E>
extends java.lang.Object

TimeoutRequest is a class that can apply a timeout on method calls that may block for undefined time. Some network operations can only be accessed without a given time-out value. Using this class all network operations may be timed out. This class provides also some static methods that give already solutions for typical network operations that should be timed-out, like dns resolving and reverse domain name resolving.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.Callable<E>	call
static boolean	enable

Constructor Summary

Constructors

Constructor and Description
TimeoutRequest(java.util.concurrent.Callable<E> call) initialize the TimeoutRequest with a callable method

Method Summary

Methods

Modifier and Type	Method and Description
E	call(long timeout) call the method using a time-out
static boolean	canRead(SmbFile file, long timeout) check if a smb file can be read
static boolean	canWrite(SmbFile file, long timeout) check if a smb file ran be written
static boolean	exists(SmbFile file, long timeout) check if a smb file exists
static java.lang.String	getHostName(java.net.InetAddress i, long timeout) perform a reverse domain name lookup for a given InetAddress within a given timeout
static boolean	isDirectory(SmbFile file, long timeout) check if a smb file is a directory
static boolean	isHidden(SmbFile file, long timeout) check if a smb file is hidden
static long	lastModified(SmbFile file, long timeout) get last-modified time of a smb file
static long	length(SmbFile file, long timeout) get the size of a smb file
static java.lang.String[]	list(SmbFile file, long timeout) get list of a smb directory
static boolean	ping(java.lang.String host, int port, int timeout) ping a remote server using a given uri and a time-out

Methods inherited from class java.lang.Object

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

Field Detail

enable

public static boolean enable

call

private final java.util.concurrent.Callable<E> call

Constructor Detail

TimeoutRequest

public TimeoutRequest(java.util.concurrent.Callable<E> call)

initialize the TimeoutRequest with a callable method

Method Detail

call

public E call(long timeout)
       throws java.util.concurrent.ExecutionException

call the method using a time-out

Parameters:

timeout -

Returns:

Throws:

java.util.concurrent.ExecutionException

ping

public static boolean ping(java.lang.String host,
           int port,
           int timeout)

ping a remote server using a given uri and a time-out

Parameters:

uri -

timeout -

Returns:

true if the server exists and replies within the given time-out

getHostName

public static java.lang.String getHostName(java.net.InetAddress i,
                           long timeout)
                                    throws java.util.concurrent.ExecutionException

perform a reverse domain name lookup for a given InetAddress within a given timeout

Parameters:

i -

timeout -

Returns:

the host name of a given InetAddress

Throws:

java.util.concurrent.ExecutionException

exists

public static boolean exists(SmbFile file,
             long timeout)
                      throws java.io.IOException

check if a smb file exists

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

canRead

public static boolean canRead(SmbFile file,
              long timeout)
                       throws java.io.IOException

check if a smb file can be read

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

canWrite

public static boolean canWrite(SmbFile file,
               long timeout)
                        throws java.io.IOException

check if a smb file ran be written

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

isHidden

public static boolean isHidden(SmbFile file,
               long timeout)
                        throws java.io.IOException

check if a smb file is hidden

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

isDirectory

public static boolean isDirectory(SmbFile file,
                  long timeout)
                           throws java.io.IOException

check if a smb file is a directory

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

length

public static long length(SmbFile file,
          long timeout)
                   throws java.io.IOException

get the size of a smb file

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

lastModified

public static long lastModified(SmbFile file,
                long timeout)
                         throws java.io.IOException

get last-modified time of a smb file

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException

list

public static java.lang.String[] list(SmbFile file,
                      long timeout)
                               throws java.io.IOException

get list of a smb directory

Parameters:

file -

timeout -

Returns:

Throws:

java.io.IOException