001/* 002 * ==================================================================== 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, 014 * software distributed under the License is distributed on an 015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 016 * KIND, either express or implied. See the License for the 017 * specific language governing permissions and limitations 018 * under the License. 019 * ==================================================================== 020 * 021 * This software consists of voluntary contributions made by many 022 * individuals on behalf of the Apache Software Foundation. For more 023 * information on the Apache Software Foundation, please see 024 * <http://www.apache.org/>. 025 * 026 */ 027 028package org.apache.http.nio.reactor; 029 030import java.io.IOException; 031import java.net.SocketAddress; 032 033/** 034 * ListenerEndpoint interface represents an endpoint used by an I/O reactor 035 * to listen for incoming connection from remote clients. 036 * 037 * @since 4.0 038 */ 039public interface ListenerEndpoint { 040 041 /** 042 * Returns the socket address of this endpoint. 043 * 044 * @return socket address. 045 */ 046 SocketAddress getAddress(); 047 048 /** 049 * Returns an instance of {@link IOException} thrown during initialization 050 * of this endpoint or {@code null}, if initialization was successful. 051 * 052 * @return I/O exception object or {@code null}. 053 */ 054 IOException getException(); 055 056 /** 057 * Waits for completion of initialization process of this endpoint. 058 * 059 * @throws InterruptedException in case the initialization process was 060 * interrupted. 061 */ 062 void waitFor() throws InterruptedException; 063 064 /** 065 * Determines if this endpoint has been closed and is no longer listens 066 * for incoming connections. 067 * 068 * @return {@code true} if the endpoint has been closed, 069 * {@code false} otherwise. 070 */ 071 boolean isClosed(); 072 073 /** 074 * Closes this endpoint. The endpoint will stop accepting incoming 075 * connection. 076 */ 077 void close(); 078 079}