Package 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
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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected final int
-
Constructor Summary
ConstructorDescriptionAckCallback
(Class<T> resultClass) Create AckCallbackAckCallback
(Class<T> resultClass, int timeout) Creates AckCallback with timeout -
Method Summary
Modifier and TypeMethodDescriptionReturns class of argument inonSuccess(T)
methodint
abstract void
Executes only once when acknowledgement received from client.void
Invoked only once thentimeout
defined
-
Field Details
-
resultClass
-
timeout
protected final int timeout
-
-
Constructor Details
-
AckCallback
Create AckCallback- Parameters:
resultClass
- - result class
-
AckCallback
Creates AckCallback with timeout- Parameters:
resultClass
- - result classtimeout
- - callback timeout in seconds
-
-
Method Details
-
getTimeout
public int getTimeout() -
onSuccess
Executes only once when acknowledgement received from client.- Parameters:
result
- - object sended by client
-
onTimeout
public void onTimeout()Invoked only once thentimeout
defined -
getResultClass
Returns class of argument inonSuccess(T)
method- Returns:
- - result class
-