lang/java/reef-io/src/main/java/org/apache/reef/io/network/ConnectionFactory.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.reef.io.network;

import org.apache.reef.wake.Identifier;

/**
 * Factory that creates a new connection.
 *
 * @param <T> type
 */
public interface ConnectionFactory<T> {

  /**
   * Creates a new connection.
   *
   * @param destId a destination identifier
   * @return a connection
   */
  Connection<T> newConnection(Identifier destId);

  /**
   * @return the connection factory identifier.
   */
  Identifier getConnectionFactoryId();

  /**
   * Each connection factory has own local end point id. If connections
   * are created by the connection factory, the local end point id is used as
   * the source id of all the connections. It returns the local end point id.
   *
   * @return the local end point id
   */
  Identifier getLocalEndPointId();
}