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;
020
021import org.apache.reef.wake.Identifier;
022
023/**
024 * Factory that creates a new connection.
025 *
026 * @param <T> type
027 */
028public interface ConnectionFactory<T> {
029
030  /**
031   * Creates a new connection.
032   *
033   * @param destId a destination identifier
034   * @return a connection
035   */
036  Connection<T> newConnection(Identifier destId);
037
038  /**
039   * @return the connection factory identifier.
040   */
041  Identifier getConnectionFactoryId();
042
043  /**
044   * Each connection factory has own local end point id. If connections
045   * are created by the connection factory, the local end point id is used as
046   * the source id of all the connections. It returns the local end point id.
047   *
048   * @return the local end point id
049   */
050  Identifier getLocalEndPointId();
051}