Query.Timeout (Carbonado 1.2.3 API)

java.lang.Object
- com.amazon.carbonado.Query.Timeout

All Implemented Interfaces:

Query.Controller, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable

Enclosing interface:

Query<S extends Storable>
```
public static final class Query.Timeout
extends java.lang.Object
implements Query.Controller
```
Timeout controller, for aborting long running queries. One instance is good for one timeout. The instance can be shared by multiple queries, if they are part of a single logical operation.
The timeout applies to the entire duration of fetching results, not just the time spent between individual fetches. A caller which is slowly processing results can timeout. More sophisticated timeouts can be implemented using custom Controller implementations.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Query.Timeout(long timeout, java.util.concurrent.TimeUnit unit)

Constructors
Constructor and Description
`Query.Timeout(long timeout, java.util.concurrent.TimeUnit unit)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`begin()` Called by query when it begins, possibly multiple times.
`void`	`close()` Always called by query when finished, even when it fails.
`void`	`continueCheck()` Periodically called by query to determine if it should continue.
`long`	`getTimeout()` Returns a non-negative value if controller imposes an absolute upper bound on query execution time.
`java.util.concurrent.TimeUnit`	`getTimeoutUnit()` Returns the unit for the timeout, if applicable.
`static Query.Timeout`	`hours(long timeout)` Return a new Timeout in hours.
`static Query.Timeout`	`micros(long timeout)` Return a new Timeout in microseconds.
`static Query.Timeout`	`millis(long timeout)` Return a new Timeout in milliseconds.
`static Query.Timeout`	`minutes(long timeout)` Return a new Timeout in minutes.
`static Query.Timeout`	`nanos(long timeout)` Return a new Timeout in nanoseconds.
`static Query.Timeout`	`seconds(long timeout)` Return a new Timeout in seconds.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Query.Timeout
```
public Query.Timeout(long timeout,
             java.util.concurrent.TimeUnit unit)
```
- Method Detail
  - nanos
```
public static Query.Timeout nanos(long timeout)
```
    Return a new Timeout in nanoseconds.
  - micros
```
public static Query.Timeout micros(long timeout)
```
    Return a new Timeout in microseconds.
  - millis
```
public static Query.Timeout millis(long timeout)
```
    Return a new Timeout in milliseconds.
  - seconds
```
public static Query.Timeout seconds(long timeout)
```
    Return a new Timeout in seconds.
  - minutes
```
public static Query.Timeout minutes(long timeout)
```
    Return a new Timeout in minutes.
  - hours
```
public static Query.Timeout hours(long timeout)
```
    Return a new Timeout in hours.
  - getTimeout
```
public long getTimeout()
```
    Description copied from interface: Query.Controller
    
    Returns a non-negative value if controller imposes an absolute upper bound on query execution time.
    
    Specified by:
    
    getTimeout in interface Query.Controller
  - getTimeoutUnit
```
public java.util.concurrent.TimeUnit getTimeoutUnit()
```
    Description copied from interface: Query.Controller
    
    Returns the unit for the timeout, if applicable.
    
    Specified by:
    
    getTimeoutUnit in interface Query.Controller
  - begin
```
public void begin()
```
    Description copied from interface: Query.Controller
    
    Called by query when it begins, possibly multiple times. Implementation is required to be idempotent and ignore multiple invocations.
    
    Specified by:
    
    begin in interface Query.Controller
  - continueCheck
```
public void continueCheck()
                   throws FetchTimeoutException
```
    Description copied from interface: Query.Controller
    
    Periodically called by query to determine if it should continue.
    
    Specified by:
    
    continueCheck in interface Query.Controller
    
    Throws:
    
    FetchTimeoutException
  - close
```
public void close()
```
    Description copied from interface: Query.Controller
    
    Always called by query when finished, even when it fails. Implementation is required to be idempotent and ignore multiple invocations.
    
    Specified by:
    
    close in interface Query.Controller
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Query.Timeout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Query.Timeout

Method Detail

nanos

micros

millis

seconds

minutes

hours

getTimeout

getTimeoutUnit

begin

continueCheck

close

toString