Source code

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.task;
020
021import org.apache.reef.annotations.Provided;
022import org.apache.reef.annotations.audience.TaskSide;
023import org.apache.reef.io.network.group.impl.task.GroupCommClientImpl;
024import org.apache.reef.tang.annotations.DefaultImplementation;
025import org.apache.reef.tang.annotations.Name;
026
027
028/**
029 * The task side interface for the Group Communication Service.
030 */
031@TaskSide
032@Provided
033@DefaultImplementation(value = GroupCommClientImpl.class)
034public interface GroupCommClient {
035
036  /**
037   * @param groupName a group name
038   * @return The communication group client with the given name that gives access
039   * to the operators configured on it that will be used to do group communication
040   */
041  CommunicationGroupClient getCommunicationGroup(Class<? extends Name<String>> groupName);
042}