com.microsoft.reef.io.network.Connection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reef-io Show documentation

There is a newer version: 0.9

/**
 * Copyright (C) 2013 Microsoft Corporation
 *
 * Licensed 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 com.microsoft.reef.io.network;

import com.microsoft.reef.exception.evaluator.NetworkException;

/**
 * Connection between two end-points named by identifiers
 * 
 * @param  type
 */
public interface Connection {
  
  /**
   * Opens the connection
   * 
   * @throws NetworkException
   */
  public void open() throws NetworkException;
  
  /**
   * Writes an object to the connection
   * 
   * @param obj
   * @throws NetworkException
   */
  public void write(T obj) throws NetworkException;
  
  /**
   * Closes the connection
   * 
   * @throws NetworkException
   */
  public void close() throws NetworkException;
  
}