001/*
002 The contents of this file are subject to the Mozilla Public License Version 1.1
003 (the "License"); you may not use this file except in compliance with the License.
004 You may obtain a copy of the License at http://www.mozilla.org/MPL/
005 Software distributed under the License is distributed on an "AS IS" basis,
006 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
007 specific language governing rights and limitations under the License.
008
009 The Original Code is "Connection.java".  Description:
010 "Interface for a Connection"
011
012 The Initial Developer of the Original Code is University Health Network. Copyright (C)
013 2013.  All Rights Reserved.
014
015 Contributor(s): ______________________________________.
016
017 Alternatively, the contents of this file may be used under the terms of the
018 GNU General Public License (the "GPL"), in which case the provisions of the GPL are
019 applicable instead of those above.  If you wish to allow use of your version of this
020 file only under the terms of the GPL and not to allow others to use your version
021 of this file under the MPL, indicate your decision by deleting  the provisions above
022 and replace  them with the notice and other provisions required by the GPL License.
023 If you do not delete the provisions above, a recipient may use your version of
024 this file under either the MPL or the GPL.
025 */
026
027package ca.uhn.hl7v2.app;
028
029import java.io.Closeable;
030import java.net.InetAddress;
031import java.util.concurrent.ExecutorService;
032
033/**
034 * Interface for a connection
035 */
036public interface Connection extends Closeable {
037
038    /**
039     * Activate this connection
040     */
041    void activate();
042
043    /**
044     * Returns an Initiator instance
045     * @return
046     */
047    Initiator getInitiator();
048
049
050    /**
051     * Returns true if this connection is open
052     *
053     * @return true if this connection is open
054     */
055    boolean isOpen();
056
057    /**
058     * Returns the address on the remote end of this connection. Note that in the case
059     * of a {@link LazyConnection} this method may return <code>null</code>.
060     * 
061     * @see #getRemotePort()
062     */
063    InetAddress getRemoteAddress();
064
065    ExecutorService getExecutorService();
066
067    /**
068     * Returns the port on the remote end of this connection. Note that in the case
069     * of a {@link LazyConnection} this method may return <code>null</code>.
070     * 
071     * @see #getRemoteAddress()
072     */
073        Integer getRemotePort();
074}