org.apache.flink.runtime.rpc.messages.RpcInvocation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.13.6
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.runtime.rpc.messages;

import java.io.IOException;

/**
 * Interface for rpc invocation messages. The interface allows to request all necessary information
 * to lookup a method and call it with the corresponding arguments.
 */
public interface RpcInvocation {

	/**
	 * Returns the method's name.
	 *
	 * @return Method name
	 * @throws IOException if the rpc invocation message is a remote message and could not be deserialized
	 * @throws ClassNotFoundException if the rpc invocation message is a remote message and contains
	 * serialized classes which cannot be found on the receiving side
	 */
	String getMethodName() throws IOException, ClassNotFoundException;

	/**
	 * Returns the method's parameter types
	 *
	 * @return Method's parameter types
	 * @throws IOException if the rpc invocation message is a remote message and could not be deserialized
	 * @throws ClassNotFoundException if the rpc invocation message is a remote message and contains
	 * serialized classes which cannot be found on the receiving side
	 */
	Class[] getParameterTypes() throws IOException, ClassNotFoundException;

	/**
	 * Returns the arguments of the remote procedure call
	 *
	 * @return Arguments of the remote procedure call
	 * @throws IOException if the rpc invocation message is a remote message and could not be deserialized
	 * @throws ClassNotFoundException if the rpc invocation message is a remote message and contains
	 * serialized classes which cannot be found on the receiving side
	 */
	Object[] getArgs() throws IOException, ClassNotFoundException;
}