org.nustaq.kontraktor

Interface Callback<T>

All Superinterfaces:

Serializable

All Known Subinterfaces:

IPromise<T>

All Known Implementing Classes:

CallbackWrapper, Promise

public interface Callback<T>
extends Serializable

Typically used to receive/stream results from outside the actor. The underlying mechanics scans method arguments and schedules calls on the call back into the calling actors thread. Note that the callback invocation is added as a message to the end of the calling actor. e.g. actor.method( arg, new Callbacl() { public void complete(T result, Object error ) { ..runs in caller thread.. } }

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONT use value as error to indicate more messages are to come (else remoting will close channel).
static String	FIN use this value to signal no more messages.
static String	FINSILENT use value to signal no more messages will be sent.

Method Summary

Modifier and Type	Method and Description
default void	complete() same as complete(null,null)
void	complete(T result, Object error) set result or error.
default void	finish() signal end of streamed objects (required for remoteref housekeeping if actors run remotely) same as complete( null, FIN );
default void	reject(Object error) signal an error to sender.
default void	resolve() same as complete(null,null) and resolve(null)
default void	resolve(T result) pass a result object to the sender.
default void	stream(T result) invalid for Promises!.

Field Detail

FINSILENT

static final String FINSILENT

use value to signal no more messages will be sent. THE RECEIVER CALLBACK WILL NOT SEE THIS MESSAGE.

See Also:

Constant Field Values

CONT

static final String CONT

use value as error to indicate more messages are to come (else remoting will close channel).

See Also:

Constant Field Values

FIN

static final String FIN

use this value to signal no more messages. The receiver callback will receive the message. Note that any value except CONT will also close the callback channel. So this is informal.

See Also:

Constant Field Values

Method Detail

complete

void complete(T result,
              Object error)

set result or error. error might also contain flow indicators to signal end/continue of stream when remoting. (Actor.FIN Actor.CONT)

Parameters:

result -

error -

complete

default void complete()

same as complete(null,null)

resolve

default void resolve()

same as complete(null,null) and resolve(null)

reject

default void reject(Object error)

signal an error to sender. Will automatically "close" the callback if remoted. same as complete( null, error );

Parameters:

error -

resolve

default void resolve(T result)

pass a result object to the sender. This can be called only once (connection to sender will be closed afterwards). same as complete( result, null );

Parameters:

result -

stream

default void stream(T result)

invalid for Promises!. can be called more than once on Callback's in order to stream objects to the sender. same as complete( result, CONT );

Parameters:

result -

finish

default void finish()

signal end of streamed objects (required for remoteref housekeeping if actors run remotely) same as complete( null, FIN );