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; 022 023/** 024 * Typed user function. Implement your functions using this interface. 025 * Note that Kryo should be able to serialize/deserialize your function and input. 026 * Please refer to Kryo project's GitHub repository for how to make Kryo-compatible objects. 027 * 028 * @param <TInput> input type 029 * @param <TOutput> output type 030 */ 031@Unstable 032public interface VortexFunction<TInput, TOutput> { 033 /** 034 * @param input of the function 035 * @return output of the function 036 * @throws Exception thrown here will bubble up in VortexFuture#get as ExecutionException 037 * Exception should be thrown only after all resources are released as they cannot be cleared by Vortex 038 * For example if threads are spawned here, shut them down before throwing an exception 039 */ 040 TOutput call(TInput input) throws Exception; 041}