This project has retired. For details please refer to its Attic page.
VertexSender xref
View Javadoc

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 send phase:
28   * <ul>
29   * <li> to send messages to vertices </li>
30   * <li> to send data for aggregation on master </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   */
40  @SuppressWarnings("rawtypes")
41  public interface VertexSender<I extends WritableComparable,
42      V extends Writable, E extends Writable> extends NonKryoWritable {
43    /** Must be defined by user to do computation on a single Vertex. */
44    void vertexSend(Vertex<I, V, E> vertex);
45  }