1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 package org.apache.giraph.block_app.framework.piece.interfaces; 19 20 import org.apache.giraph.graph.Vertex; 21 import org.apache.giraph.writable.kryo.markers.NonKryoWritable; 22 import org.apache.hadoop.io.Writable; 23 import org.apache.hadoop.io.WritableComparable; 24 25 /** 26 * Interface representing actions that happen on worker, for each vertex, 27 * during receive phase: 28 * <ul> 29 * <li> to receive messages from vertices </li> 30 * <li> to receive data from master through aggregators </li> 31 * </ul> 32 * 33 * Marked to not allow seriazliation, as it should be created on the worker, 34 * so should never be serialiized, disallow only for catching problems early. 35 * 36 * @param <I> Vertex id type 37 * @param <V> Vertex value type 38 * @param <E> Edge value type 39 * @param <M> Message type 40 */ 41 @SuppressWarnings("rawtypes") 42 public interface VertexReceiver<I extends WritableComparable, 43 V extends Writable, E extends Writable, M extends Writable> 44 extends NonKryoWritable { 45 /** 46 * Must be defined by user to do computation on a single Vertex. 47 * 48 * @param vertex Vertex 49 * @param messages Messages that were sent to this vertex in the previous 50 * superstep. Each message is only guaranteed to have 51 * a life expectancy as long as next() is not called. 52 */ 53 void vertexReceive(Vertex<I, V, E> vertex, Iterable<M> messages); 54 }