Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.vortex.api;
020
021import org.apache.reef.annotations.Unstable;
022import org.apache.reef.io.serialization.Codec;
023
024import java.io.Serializable;
025
026/**
027 * Typed user function. Implement your functions using this interface.
028 * TODO[REEF-504]: Clean up Serializable in Vortex.
029 * TODO[REEF-1003]: Use reflection instead of serialization when launching VortexFunction.
030 *
031 * @param <TInput> input type
032 * @param <TOutput> output type
033 */
034@Unstable
035public interface VortexFunction<TInput, TOutput> extends Serializable {
036  /**
037   * @param input of the function
038   * @return output of the function
039   * @throws Exception thrown here will bubble up in VortexFuture#get as ExecutionException
040   * Exception should be thrown only after all resources are released as they cannot be cleared by Vortex
041   * For example if threads are spawned here, shut them down before throwing an exception
042   */
043  TOutput call(TInput input) throws Exception;
044
045  /**
046   * Users must define codec for the input. {@link org.apache.reef.vortex.util.VoidCodec} can be used if the input is
047   * empty, and {@link org.apache.reef.io.serialization.SerializableCodec} can be used for ({@link Serializable} input.
048   * {@link org.apache.reef.vortex.examples.matmul.MatMulInputCodec} is an example of codec for the custom input.
049   * @return Codec used to serialize/deserialize the input.
050   */
051  Codec<TInput> getInputCodec();
052
053  /**
054   * Users must define codec for the output. {@link org.apache.reef.vortex.util.VoidCodec} can be used if the output is
055   * empty, and {@link org.apache.reef.io.serialization.SerializableCodec} can be used for ({@link Serializable} output.
056   * {@link org.apache.reef.vortex.examples.matmul.MatMulOutputCodec} is an example of codec for the custom output.
057   * @return Codec used to serialize/deserialize the output.
058   */
059  Codec<TOutput> getOutputCodec();
060}