mousio.client.promises

Class ResponsePromise<T>

java.lang.Object

mousio.client.promises.ResponsePromise<T>

Type Parameters:

T - Type of object returned by promise

Direct Known Subclasses:

EtcdResponsePromise

public class ResponsePromise<T>
extends java.lang.Object

A Response promise

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResponsePromise.IsSimplePromiseResponseHandler<T> Response listener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Throwable	exception
protected io.netty.util.concurrent.Promise<T>	promise
protected T	response

Constructor Summary

Constructors

Constructor and Description
ResponsePromise(RetryPolicy retryPolicy, ConnectionState connectionState, RetryHandler retryHandler) Constructor

Method Summary

Modifier and Type	Method and Description
void	addListener(ResponsePromise.IsSimplePromiseResponseHandler<T> listener) Add a promise to do when Response comes in
void	attachNettyPromise(io.netty.util.concurrent.Promise<T> promise) Attach Netty Promise
void	cancel() Cancel the request
void	cancel(java.lang.Throwable throwable) Cancel the request
T	get() Get the response.
ConnectionState	getConnectionState() Get the current connection state
java.lang.Throwable	getException() Get exception
io.netty.util.concurrent.Promise<T>	getNettyPromise() Get internal Netty Promise
T	getNow() Get the result now even if it is not loaded yet by the promise.
protected void	handlePromise(io.netty.util.concurrent.Promise<T> promise) Handle the promise
void	handleRetry(java.lang.Throwable cause) Handles a retry
void	removeListener(ResponsePromise.IsSimplePromiseResponseHandler<T> listener) Remove a listener
void	setException(java.lang.Throwable exception) Sets exception
protected boolean	waitForPromiseSuccess() Wait for promise to be done

Methods inherited from class java.lang.Object

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

Field Detail

promise

protected io.netty.util.concurrent.Promise<T> promise

response

protected T response

exception

protected java.lang.Throwable exception

Constructor Detail

ResponsePromise

public ResponsePromise(RetryPolicy retryPolicy,
                       ConnectionState connectionState,
                       RetryHandler retryHandler)

Constructor

Parameters:

retryPolicy - the policy for retries

connectionState - which contains current connection details

retryHandler - handler for retries

Method Detail

attachNettyPromise

public void attachNettyPromise(io.netty.util.concurrent.Promise<T> promise)

Attach Netty Promise

Parameters:

promise - netty promise to set up response promise with

addListener

public void addListener(ResponsePromise.IsSimplePromiseResponseHandler<T> listener)

Add a promise to do when Response comes in

Parameters:

listener - to add

removeListener

public void removeListener(ResponsePromise.IsSimplePromiseResponseHandler<T> listener)

Remove a listener

Parameters:

listener - to remove

handlePromise

protected void handlePromise(io.netty.util.concurrent.Promise<T> promise)

Handle the promise

Parameters:

promise - to handle

setException

public void setException(java.lang.Throwable exception)

Sets exception

Parameters:

exception - to set.

get

public T get()
      throws java.lang.Exception

Get the response. (Blocking) Use addListener to fetch the value in a non blocking way.

Returns:

the response

Throws:

java.lang.Exception - on fail

waitForPromiseSuccess

protected boolean waitForPromiseSuccess()
                                 throws java.io.IOException,
                                        java.util.concurrent.TimeoutException

Wait for promise to be done

Returns:

true if success, false if fail

Throws:

java.io.IOException - on IOException

java.util.concurrent.TimeoutException - on timeout

getNow

public T getNow()

Get the result now even if it is not loaded yet by the promise. Use get() to ensure in a blocking way that the value is loaded.

Returns:

the result

getNettyPromise

public io.netty.util.concurrent.Promise<T> getNettyPromise()

Get internal Netty Promise

Returns:

Netty Promise

handleRetry

public void handleRetry(java.lang.Throwable cause)

Handles a retry

Parameters:

cause - of last connect fail

getConnectionState

public ConnectionState getConnectionState()

Get the current connection state

Returns:

connection state

cancel

public void cancel()

Cancel the request

cancel

public void cancel(java.lang.Throwable throwable)

Cancel the request

Parameters:

throwable - the exception to be associated to this promise

getException

public java.lang.Throwable getException()

Get exception

Returns:

the exception if set. Or null if no exception present