Package org.glassfish.grizzly.websockets

Class FrameCompletionHandler

java.lang.Object

org.glassfish.grizzly.websockets.FrameCompletionHandler

All Implemented Interfaces:

CompletionHandler<DataFrame>

public class FrameCompletionHandler
extends Object
implements CompletionHandler<DataFrame>

Constructor Summary

Constructors

Constructor	Description
FrameCompletionHandler()

Method Summary

Modifier and Type	Method	Description
void	cancelled()	The operation was cancelled.
void	completed(DataFrame result)	The operation was completed.
void	failed(Throwable throwable)	The operation was failed.
DataFrame	getResult()
void	updated(DataFrame result)	The callback method may be called, when there is some progress in operation execution, but it is still not completed

Methods inherited from class java.lang.Object

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

Constructor Details

FrameCompletionHandler

public FrameCompletionHandler()

Method Details

cancelled

public void cancelled()

Description copied from interface: CompletionHandler

The operation was cancelled.

Specified by:

cancelled in interface CompletionHandler<DataFrame>

failed

public void failed(Throwable throwable)

Description copied from interface: CompletionHandler

The operation was failed.

Specified by:

failed in interface CompletionHandler<DataFrame>

Parameters:

throwable - error, which occurred during operation execution

completed

public void completed(DataFrame result)

Description copied from interface: CompletionHandler

The operation was completed.

Specified by:

completed in interface CompletionHandler<DataFrame>

Parameters:

result - the operation result Please note, for performance reasons the result object might be recycled after returning from the completed method. So it's not guaranteed that using of the result object is safe outside this method's scope.

updated

public void updated(DataFrame result)

Description copied from interface: CompletionHandler

The callback method may be called, when there is some progress in operation execution, but it is still not completed

Specified by:

updated in interface CompletionHandler<DataFrame>

Parameters:

result - the current result Please note, for performance reasons the result object might be recycled after returning from the updated method. So it's not guaranteed that using of the result object is safe outside this method's scope.

getResult

public DataFrame getResult()