This project has retired. For details please refer to its Attic page.
BlockMasterApi 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.api;
19  
20  import org.apache.giraph.aggregators.Aggregator;
21  import org.apache.giraph.block_app.framework.piece.global_comm.BroadcastHandle;
22  import org.apache.giraph.master.MasterAggregatorUsage;
23  import org.apache.giraph.master.MasterGlobalCommUsage;
24  import org.apache.hadoop.io.Writable;
25  
26  /**
27   * Block computation API available for the master methods.
28   *
29   * Interface to the MasterCompute methods.
30   */
31  public interface BlockMasterApi extends MasterAggregatorUsage,
32      MasterGlobalCommUsage, StatusReporter, BlockApi, BlockOutputApi {
33    /**
34     * No need to use it, and introduces global dependencies.
35     *
36     * Store data locally within the piece, or use ObjectHolder.
37     */
38    @Deprecated
39    @Override
40    <A extends Writable>
41    boolean registerPersistentAggregator(
42        String name, Class<? extends Aggregator<A>> aggregatorClass
43    ) throws InstantiationException, IllegalAccessException;
44  
45    /**
46     * Broadcast given value to all workers for next computation.
47     * @param value Value to broadcast
48     */
49    <T extends Writable> BroadcastHandle<T> broadcast(T value);
50  
51    /**
52     * Call this to log a line to command line of the job. Use in moderation -
53     * it's a synchronous call to Job client
54     *
55     * @param line Line to print
56     */
57    void logToCommandLine(String line);
58  }