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.net.InetAddress;
030import java.util.concurrent.ExecutorService;
031
032/**
033 * Interface for a connection
034 */
035public interface Connection {
036
037    /**
038     * Activate this connection
039     */
040    void activate();
041
042    /**
043     * Returns an Initiator instance
044     * @return
045     */
046    Initiator getInitiator();
047
048
049    /**
050     * Closes the connection
051     */
052    void close();
053
054    /**
055     * Returns true if this connection is open
056     *
057     * @return true if this connection is open
058     */
059    boolean isOpen();
060
061    /**
062     * Returns the address on the remote end of this connection. Note that in the case
063     * of a {@link LazyConnection} this method may return <code>null</code>.
064     * 
065     * @see #getRemotePort()
066     */
067    InetAddress getRemoteAddress();
068
069    ExecutorService getExecutorService();
070
071    /**
072     * Returns the port on the remote end of this connection. Note that in the case
073     * of a {@link LazyConnection} this method may return <code>null</code>.
074     * 
075     * @see #getRemoteAddress()
076     */
077        Integer getRemotePort();
078}