org.apache.reef.vortex.api

Interface VortexFunction<TInput,TOutput>

Type Parameters:

TInput - input type

TOutput - output type

All Superinterfaces:

Serializable

All Known Implementing Classes:

IdentityFunction

public interface VortexFunction<TInput,TOutput>
extends Serializable

Typed user function. Implement your functions using this interface. TODO[REEF-504]: Clean up Serializable in Vortex. TODO[REEF-1003]: Use reflection instead of serialization when launching VortexFunction.

Method Summary

Methods

Modifier and Type	Method and Description
TOutput	call(TInput input)
Codec<TInput>	getInputCodec() Users must define codec for the input.
Codec<TOutput>	getOutputCodec() Users must define codec for the output.

Method Detail

call

TOutput call(TInput input)
             throws Exception

Parameters:

input - of the function

Returns:

output of the function

Throws:

Exception - thrown here will bubble up in VortexFuture#get as ExecutionException Exception should be thrown only after all resources are released as they cannot be cleared by Vortex For example if threads are spawned here, shut them down before throwing an exception

getInputCodec

Codec<TInput> getInputCodec()

Users must define codec for the input. VoidCodec can be used if the input is empty, and SerializableCodec can be used for (Serializable input. MatMulInputCodec is an example of codec for the custom input.

Returns:

Codec used to serialize/deserialize the input.

getOutputCodec

Codec<TOutput> getOutputCodec()

Users must define codec for the output. VoidCodec can be used if the output is empty, and SerializableCodec can be used for (Serializable output. MatMulOutputCodec is an example of codec for the custom output.

Returns:

Codec used to serialize/deserialize the output.