001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.reef.io.network.group.api.operators; 020 021import org.apache.reef.exception.evaluator.NetworkException; 022import org.apache.reef.io.network.group.impl.operators.BroadcastReceiver; 023import org.apache.reef.io.network.group.impl.operators.BroadcastSender; 024import org.apache.reef.tang.annotations.DefaultImplementation; 025 026/** 027 * MPI Broadcast operator. 028 * <p> 029 * The sender or root send's an element that is received by all the receivers or other tasks. 030 * <p> 031 * This is an asymmetric operation and hence the differentiation b/w Sender and Receiver. 032 */ 033public interface Broadcast { 034 035 /** 036 * Sender or Root. 037 */ 038 @DefaultImplementation(BroadcastSender.class) 039 interface Sender<T> extends GroupCommOperator { 040 041 /** 042 * Send element to all receivers. 043 */ 044 void send(T element) throws NetworkException, InterruptedException; 045 } 046 047 /** 048 * Receivers or Non-roots. 049 */ 050 @DefaultImplementation(BroadcastReceiver.class) 051 interface Receiver<T> extends GroupCommOperator { 052 053 /** 054 * Receiver the element broadcasted by sender. 055 * 056 * @return the element broadcasted by sender 057 */ 058 T receive() throws NetworkException, InterruptedException; 059 } 060}