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.exception.evaluator.NetworkException;
022
023import java.util.List;
024
025/**
026 * Connection between two end-points named by identifiers.
027 *
028 * @param <T> type
029 */
030public interface Connection<T> extends AutoCloseable {
031
032  /**
033   * Opens the connection.
034   *
035   * @throws NetworkException
036   */
037  void open() throws NetworkException;
038
039  /**
040   * Writes a message to the connection.
041   *
042   * @param message
043   */
044  void write(T message);
045
046  /**
047   * Writes a list of messages to the connection.
048   *
049   * @param messages
050   */
051  void write(List<T> messages);
052
053  /**
054   * Closes the connection.
055   *
056   * @throws NetworkException
057   */
058  @Override
059  void close() throws NetworkException;
060}