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
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:

  • Field Details

    • resultClass

      protected final Class<T> resultClass

    • timeout

      protected final int timeout

  • Constructor Details

    • 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 Details

    • 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