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.wake.remote.ports;
020
021import org.apache.reef.tang.Configuration;
022import org.apache.reef.tang.annotations.DefaultImplementation;
023
024import java.util.Iterator;
025
026/**
027 * Provides an iterator that returns port numbers.
028*/
029@DefaultImplementation(RangeTcpPortProvider.class)
030public interface TcpPortProvider extends Iterable<Integer> {
031  /**
032   * Returns an iterator over a set of tcp ports
033   *
034   * @return an Iterator.
035   */
036  @Override
037  Iterator<Integer> iterator();
038
039  /**
040   * returns a configuration for the class that implements TcpPortProvider so that class can be instantiated
041   * somewhere else
042   *
043   * @return Configuration.
044   */
045  Configuration getConfiguration();
046}