OrbPartitionCommunicationProtocol.java

/**
 * Licensed to Ravel, Inc. under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  Ravel, Inc. 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.goldenorb;

import org.apache.hadoop.ipc.VersionedProtocol;
import org.goldenorb.io.input.RawSplit;

/**
 * This interface provides a protocol framework for OrbPartitions to send messages and vertices. In most cases
 * a class will implement the methods using Hadoop RPC for intercommunication between partitions.
 */
public interface OrbPartitionCommunicationProtocol extends VersionedProtocol {
  public static final long versionID = 0L;
  
  /**
   * 
   * @param vertices
   */
  public void sendVertices(Vertices vertices);
  
  /**
   * 
   * @param messages
   */
  public void sendMessages(Messages messages);
  
  /**
   * 
   * @param partitionID
   */
  public void becomeActive(int partitionID);
  
  /**
   * 
   * @param rawsplit
   */
  public void loadVerticesFromInputSplit(RawSplit rawsplit);
}