Source code

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.transport;
020
021import org.apache.reef.wake.EventHandler;
022import org.apache.reef.wake.Stage;
023import org.apache.reef.wake.remote.Encoder;
024
025import java.io.IOException;
026import java.net.SocketAddress;
027
028/**
029 * Transport for sending and receiving data.
030 */
031public interface Transport extends Stage {
032
033  /**
034   * Constructs with a listening port number, a client-side event handling stage, and a server-side event handling stage
035   */
036
037  /**
038   * Returns a link for the remote address if cached; otherwise opens, caches and returns.
039   * When it opens a link for the remote address, only one attempt for the address is made at a given time
040   *
041   * @param remoteAddr the remote socket address
042   * @param encoder    the encoder
043   * @param listener   the link listener
044   * @return a link associated with the address
045   * @throws IOException
046   */
047  <T> Link<T> open(SocketAddress remoteAddr, Encoder<? super T> encoder, LinkListener<? super T> listener)
048      throws IOException;
049
050  /**
051   * Returns a link for the remote address if already cached; otherwise, returns null.
052   *
053   * @param remoteAddr the remote address
054   * @return a link if already cached; otherwise, null
055   */
056  <T> Link<T> get(SocketAddress remoteAddr);
057
058  /**
059   * Gets a server listening port of this transport.
060   *
061   * @return a listening port number
062   */
063  int getListeningPort();
064
065  /**
066   * Gets a server local socket address of this transport.
067   *
068   * @return a server local socket address
069   */
070  SocketAddress getLocalAddress();
071
072  /**
073   * Registers the exception handler.
074   *
075   * @param handler the exception handler
076   */
077  void registerErrorHandler(EventHandler<Exception> handler);
078}