SessionFuturesController (SNF4J/Core 1.7.0 API)

java.lang.Object
- org.snf4j.core.future.SessionFuturesController

```
public class SessionFuturesController
extends Object
```
A class that holds all session's futures and controls their states based on the session's events.

Author:

SNF4J.ORG

Constructor Summary

Constructors
Constructor and Description

SessionFuturesController(ISession session)
Constructs a future controller associated with the specified session

Constructors
Constructor and Description
`SessionFuturesController(ISession session)` Constructs a future controller associated with the specified session

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort(Throwable cause)` Notifies this controller about aborting registration.
`void`	`event(DataEvent event, long length)` Notifies this controller about events related with I/O operations.
`void`	`event(SessionEvent event)` Notifies this controller about events related with changes of the session state.
`void`	`exception(Throwable cause)` Notifies this controller about an failure.
`IAbortableFuture<Void>`	`getAbortableWriteFuture(long expectedSize)` Returns an abortable future that can be used to wait for the completion of a write operation.
`IFuture<Void>`	`getCancelledFuture()` Returns a cancelled future.
`IFuture<Void>`	`getCloseFuture()` Returns the future that can be use to wait for the completion of the session's closing phase.
`IFuture<Void>`	`getCreateFuture()` Returns the future that can be use to wait for the completion of the session's creation phase.
`IDelegatingFuture<Void>`	`getDelegatingFuture()` Returns a future which can be represented by other delegate future.
`IFuture<Void>`	`getEndFuture()` Returns the future that can be use to wait for the completion of the session's ending phase.
`ITwoThresholdFuture<Void>`	`getEngineWriteFuture(long expectedUnwrappedSize)` Returns a future that can be used to wait for the completion of write operations from engine driven sessions.
`IFuture<Void>`	`getFailedFuture(Throwable cause)` Returns a failed future with the specified cause.
`IFuture<Void>`	`getOpenFuture()` Returns the future that can be use to wait for the completion of the session's opening phase.
`IFuture<Void>`	`getReadyFuture()` Returns the future that can be use to wait for the completion of the session's ready phase.
`IFuture<Void>`	`getSuccessfulFuture()` Returns a successful future.
`IFuture<Void>`	`getWriteFuture(long expectedSize)` Returns a future that can be used to wait for the completion of a write operation.
`void`	`setExecutor(IFutureExecutor executor)` Sets the future executor that will be responsible for completion of the operations related with the futures holden by this controller.

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

- Constructor Detail
  - SessionFuturesController
```
public SessionFuturesController(ISession session)
```
    Constructs a future controller associated with the specified session
    
    Parameters:
    
    session - the associated session
- Method Detail
  - setExecutor
```
public void setExecutor(IFutureExecutor executor)
```
    Sets the future executor that will be responsible for completion of the operations related with the futures holden by this controller.
    
    Parameters:
    
    executor - the future executor
  - event
```
public void event(SessionEvent event)
```
    Notifies this controller about events related with changes of the session state.
    
    Parameters:
    
    event - an event related with a change of the session state.
  - event
```
public void event(DataEvent event,
                  long length)
```
    Notifies this controller about events related with I/O operations.
    
    Parameters:
    
    event - an event related with I/O operations.
    
    length - the length of data
  - exception
```
public void exception(Throwable cause)
```
    Notifies this controller about an failure.
    
    Parameters:
    
    cause - the cause of the failure
  - abort
```
public void abort(Throwable cause)
```
    Notifies this controller about aborting registration.
    
    Parameters:
    
    cause - the cause of the failure, or null if controlled futures should be cancelled
  - getCreateFuture
```
public final IFuture<Void> getCreateFuture()
```
    Returns the future that can be use to wait for the completion of the session's creation phase.
    
    Returns:
    
    the future associated with the session's creation phase
  - getOpenFuture
```
public final IFuture<Void> getOpenFuture()
```
    Returns the future that can be use to wait for the completion of the session's opening phase.
    
    Returns:
    
    the future associated with the session's opening phase
  - getReadyFuture
```
public final IFuture<Void> getReadyFuture()
```
    Returns the future that can be use to wait for the completion of the session's ready phase.
    
    Returns:
    
    the future associated with the session's ready phase
  - getCloseFuture
```
public final IFuture<Void> getCloseFuture()
```
    Returns the future that can be use to wait for the completion of the session's closing phase.
    
    Returns:
    
    the future associated with the session's closing phase
  - getEndFuture
```
public final IFuture<Void> getEndFuture()
```
    Returns the future that can be use to wait for the completion of the session's ending phase.
    
    Returns:
    
    the future associated with the session's ending phase
  - getWriteFuture
```
public IFuture<Void> getWriteFuture(long expectedSize)
```
    Returns a future that can be used to wait for the completion of a write operation.
    
    Parameters:
    
    expectedSize - the expected size of total bytes sent by the future executor that completes this future
    
    Returns:
    
    a future associated with a write operation
  - getAbortableWriteFuture
```
public IAbortableFuture<Void> getAbortableWriteFuture(long expectedSize)
```
    Returns an abortable future that can be used to wait for the completion of a write operation.
    
    Parameters:
    
    expectedSize - the expected size of total bytes sent by the future executor that completes this future
    
    Returns:
    
    an abortable future associated with a write operation
  - getEngineWriteFuture
```
public ITwoThresholdFuture<Void> getEngineWriteFuture(long expectedUnwrappedSize)
```
    Returns a future that can be used to wait for the completion of write operations from engine driven sessions.
    
    Parameters:
    
    expectedUnwrappedSize - the expected unwrapped size of total bytes sent by the future's executor that completes this future
    
    Returns:
    
    a future associated with a write operation
  - getCancelledFuture
```
public IFuture<Void> getCancelledFuture()
```
    Returns a cancelled future.
    
    Returns:
    
    a cancelled future
  - getSuccessfulFuture
```
public IFuture<Void> getSuccessfulFuture()
```
    Returns a successful future.
    
    Returns:
    
    a successful future
  - getFailedFuture
```
public IFuture<Void> getFailedFuture(Throwable cause)
```
    Returns a failed future with the specified cause.
    
    Parameters:
    
    cause - the cause of the failure
    
    Returns:
    
    a failed future
  - getDelegatingFuture
```
public IDelegatingFuture<Void> getDelegatingFuture()
```
    Returns a future which can be represented by other delegate future.
    
    Returns:
    
    a delegating future

Class SessionFuturesController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionFuturesController

Method Detail

setExecutor

event

event

exception

abort

getCreateFuture

getOpenFuture

getReadyFuture

getCloseFuture

getEndFuture

getWriteFuture

getAbortableWriteFuture

getEngineWriteFuture

getCancelledFuture

getSuccessfulFuture

getFailedFuture

getDelegatingFuture