com.corundumstudio.socketio

Class AckCallback<T>

java.lang.Object

com.corundumstudio.socketio.AckCallback<T>

Type Parameters:

T - - any serializable type

Direct Known Subclasses:

MultiTypeAckCallback, VoidAckCallback

public abstract class AckCallback<T>
extends Object

Base ack callback class. Notifies about acknowledgement received from client via onSuccess(T) callback method. By default it may wait acknowledgement from client while SocketIOClient is alive. Timeout can be defined timeout as constructor argument. This object is NOT actual anymore if onSuccess(T) or onTimeout() was executed.

See Also:

VoidAckCallback, MultiTypeAckCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	resultClass
protected int	timeout

Constructor Summary

Constructors

Constructor and Description
AckCallback(Class<T> resultClass) Create AckCallback
AckCallback(Class<T> resultClass, int timeout) Creates AckCallback with timeout

Method Summary

Methods

Modifier and Type	Method and Description
Class<T>	getResultClass() Returns class of argument in onSuccess(T) method
int	getTimeout()
abstract void	onSuccess(T result) Executes only once when acknowledgement received from client.
void	onTimeout() Invoked only once then timeout defined

Methods inherited from class java.lang.Object

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

Field Detail

resultClass

protected final Class<T> resultClass

timeout

protected final int timeout

Constructor Detail

AckCallback

public AckCallback(Class<T> resultClass)

Create AckCallback

Parameters:

resultClass - - result class

AckCallback

public AckCallback(Class<T> resultClass,
           int timeout)

Creates AckCallback with timeout

Parameters:

resultClass - - result class

timeout - - callback timeout in seconds

Method Detail

getTimeout

public int getTimeout()

onSuccess

public abstract void onSuccess(T result)

Executes only once when acknowledgement received from client.

Parameters:

result - - object sended by client

onTimeout

public void onTimeout()

Invoked only once then timeout defined

getResultClass

public Class<T> getResultClass()

Returns class of argument in onSuccess(T) method

Returns:

- result class