1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.hc.core5.reactor; 29 30 import java.io.IOException; 31 import java.net.SocketAddress; 32 import java.util.Set; 33 import java.util.concurrent.Future; 34 35 import org.apache.hc.core5.concurrent.FutureCallback; 36 37 /** 38 * Non-blocking connection acceptor. 39 * 40 * @since 5.0 41 */ 42 public interface ConnectionAcceptor { 43 44 /** 45 * Opens a new listener endpoint with the given socket address. Once 46 * the endpoint is fully initialized it starts accepting incoming 47 * connections and propagates I/O activity notifications to the I/O event 48 * dispatcher. 49 * 50 * @param address the socket address to listen on. 51 * @param attachment the attachment object. 52 * @param callback the result callback. 53 * @return listener endpoint. 54 * 55 * @since 5.2 56 */ 57 default Future<ListenerEndpoint> listen( 58 SocketAddress address, Object attachment, FutureCallback<ListenerEndpoint> callback) { 59 return listen(address, callback); 60 } 61 62 /** 63 * Opens a new listener endpoint with the given socket address. Once 64 * the endpoint is fully initialized it starts accepting incoming 65 * connections and propagates I/O activity notifications to the I/O event 66 * dispatcher. 67 * 68 * @param address the socket address to listen on. 69 * @param callback the result callback. 70 * @return listener endpoint. 71 */ 72 Future<ListenerEndpoint> listen(SocketAddress address, FutureCallback<ListenerEndpoint> callback); 73 74 /** 75 * Suspends the I/O reactor preventing it from accepting new connections on 76 * all active endpoints. 77 * 78 * @throws IOException in case of an I/O error. 79 */ 80 void pause() throws IOException; 81 82 /** 83 * Resumes the I/O reactor restoring its ability to accept incoming 84 * connections on all active endpoints. 85 * 86 * @throws IOException in case of an I/O error. 87 */ 88 void resume() throws IOException; 89 90 /** 91 * Returns a set of endpoints for this I/O reactor. 92 * 93 * @return set of endpoints. 94 */ 95 Set<ListenerEndpoint> getEndpoints(); 96 97 }