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; 032import java.util.Set; 033 034/** 035 * ListeningIOReactor represents an I/O reactor capable of listening for 036 * incoming connections on one or several ports. 037 * 038 * @since 4.0 039 */ 040public interface ListeningIOReactor extends IOReactor { 041 042 /** 043 * Opens a new listener endpoint with the given socket address. Once 044 * the endpoint is fully initialized it starts accepting incoming 045 * connections and propagates I/O activity notifications to the I/O event 046 * dispatcher. 047 * <p> 048 * {@link ListenerEndpoint#waitFor()} can be used to wait for the 049 * listener to be come ready to accept incoming connections. 050 * <p> 051 * {@link ListenerEndpoint#close()} can be used to shut down 052 * the listener even before it is fully initialized. 053 * 054 * @param address the socket address to listen on. 055 * @return listener endpoint. 056 */ 057 ListenerEndpoint listen(SocketAddress address); 058 059 /** 060 * Suspends the I/O reactor preventing it from accepting new connections on 061 * all active endpoints. 062 * 063 * @throws IOException in case of an I/O error. 064 */ 065 void pause() 066 throws IOException; 067 068 /** 069 * Resumes the I/O reactor restoring its ability to accept incoming 070 * connections on all active endpoints. 071 * 072 * @throws IOException in case of an I/O error. 073 */ 074 void resume() 075 throws IOException; 076 077 /** 078 * Returns a set of endpoints for this I/O reactor. 079 * 080 * @return set of endpoints. 081 */ 082 Set<ListenerEndpoint> getEndpoints(); 083 084}