View Javadoc
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  import java.util.concurrent.ThreadFactory;
35  
36  import org.apache.hc.core5.concurrent.DefaultThreadFactory;
37  import org.apache.hc.core5.concurrent.FutureCallback;
38  import org.apache.hc.core5.function.Callback;
39  import org.apache.hc.core5.function.Decorator;
40  import org.apache.hc.core5.io.CloseMode;
41  import org.apache.hc.core5.util.Args;
42  import org.apache.hc.core5.util.TimeValue;
43  
44  /**
45   * Multi-core I/O reactor that can act as both {@link ConnectionInitiator}
46   * and {@link ConnectionAcceptor}. Internally this I/O reactor distributes newly created
47   * I/O session equally across multiple I/O worker threads for a more optimal resource
48   * utilization and a better I/O performance. Usually it is recommended to have
49   * one worker I/O reactor per physical CPU core.
50   *
51   * @since 4.0
52   */
53  public class DefaultListeningIOReactor extends AbstractIOReactorBase implements ConnectionAcceptor {
54  
55      private final static ThreadFactory DISPATCH_THREAD_FACTORY = new DefaultThreadFactory("I/O server dispatch", true);
56      private final static ThreadFactory LISTENER_THREAD_FACTORY = new DefaultThreadFactory("I/O listener", true);
57  
58      private final int workerCount;
59      private final SingleCoreIOReactor[] workers;
60      private final SingleCoreListeningIOReactor listener;
61      private final MultiCoreIOReactor ioReactor;
62      private final IOWorkers.Selector workerSelector;
63  
64      /**
65       * Creates an instance of DefaultListeningIOReactor with the given configuration.
66       *
67       * @param eventHandlerFactory the factory to create I/O event handlers.
68       * @param ioReactorConfig I/O reactor configuration.
69       * @param listenerThreadFactory the factory to create listener thread.
70       *   Can be {@code null}.
71       *
72       * @since 5.0
73       */
74      public DefaultListeningIOReactor(
75              final IOEventHandlerFactory eventHandlerFactory,
76              final IOReactorConfig ioReactorConfig,
77              final ThreadFactory dispatchThreadFactory,
78              final ThreadFactory listenerThreadFactory,
79              final Decorator<IOSession> ioSessionDecorator,
80              final Callback<Exception> exceptionCallback,
81              final IOSessionListener sessionListener,
82              final Callback<IOSession> sessionShutdownCallback) {
83          Args.notNull(eventHandlerFactory, "Event handler factory");
84          this.workerCount = ioReactorConfig != null ? ioReactorConfig.getIoThreadCount() : IOReactorConfig.DEFAULT.getIoThreadCount();
85          this.workers = new SingleCoreIOReactor[workerCount];
86          final Thread[] threads = new Thread[workerCount + 1];
87          for (int i = 0; i < this.workers.length; i++) {
88              final SingleCoreIOReactoractor.html#SingleCoreIOReactor">SingleCoreIOReactor dispatcher = new SingleCoreIOReactor(
89                      exceptionCallback,
90                      eventHandlerFactory,
91                      ioReactorConfig != null ? ioReactorConfig : IOReactorConfig.DEFAULT,
92                      ioSessionDecorator,
93                      sessionListener,
94                      sessionShutdownCallback);
95              this.workers[i] = dispatcher;
96              threads[i + 1] = (dispatchThreadFactory != null ? dispatchThreadFactory : DISPATCH_THREAD_FACTORY).newThread(new IOReactorWorker(dispatcher));
97          }
98          final IOReactortor.html#IOReactor">IOReactor[] ioReactors = new IOReactor[this.workerCount + 1];
99          System.arraycopy(this.workers, 0, ioReactors, 1, this.workerCount);
100         this.listener = new SingleCoreListeningIOReactor(exceptionCallback, ioReactorConfig, new Callback<ChannelEntry>() {
101 
102             @Override
103             public void execute(final ChannelEntry entry) {
104                 enqueueChannel(entry);
105             }
106 
107         });
108         ioReactors[0] = this.listener;
109         threads[0] = (listenerThreadFactory != null ? listenerThreadFactory : LISTENER_THREAD_FACTORY).newThread(new IOReactorWorker(listener));
110 
111         this.ioReactor = new MultiCoreIOReactor(ioReactors, threads);
112 
113         workerSelector = IOWorkers.newSelector(workers);
114     }
115 
116     /**
117      * Creates an instance of DefaultListeningIOReactor with the given configuration.
118      *
119      * @param eventHandlerFactory the factory to create I/O event handlers.
120      * @param config I/O reactor configuration.
121      *   Can be {@code null}.
122      *
123      * @since 5.0
124      */
125     public DefaultListeningIOReactor(
126             final IOEventHandlerFactory eventHandlerFactory,
127             final IOReactorConfig config,
128             final Callback<IOSession> sessionShutdownCallback) {
129         this(eventHandlerFactory, config, null, null, null, null, null, sessionShutdownCallback);
130     }
131 
132     /**
133      * Creates an instance of DefaultListeningIOReactor with default configuration.
134      *
135      * @param eventHandlerFactory the factory to create I/O event handlers.
136      *
137      * @since 5.0
138      */
139     public DefaultListeningIOReactor(final IOEventHandlerFactory eventHandlerFactory) {
140         this(eventHandlerFactory, null, null);
141     }
142 
143     @Override
144     public void start() {
145         ioReactor.start();
146     }
147 
148     public Future<ListenerEndpoint> listen(
149             final SocketAddress address, final Object attachment, final FutureCallback<ListenerEndpoint> callback) {
150         return listener.listen(address, attachment, callback);
151     }
152 
153     @Override
154     public Future<ListenerEndpoint> listen(final SocketAddress address, final FutureCallback<ListenerEndpoint> callback) {
155         return listen(address, null, callback);
156     }
157 
158     public Future<ListenerEndpoint> listen(final SocketAddress address) {
159         return listen(address, null);
160     }
161 
162     @Override
163     public Set<ListenerEndpoint> getEndpoints() {
164         return listener.getEndpoints();
165     }
166 
167     @Override
168     public void pause() throws IOException {
169         listener.pause();
170     }
171 
172     @Override
173     public void resume() throws IOException {
174         listener.resume();
175     }
176 
177     @Override
178     public IOReactorStatus getStatus() {
179         return ioReactor.getStatus();
180     }
181 
182     @Override
183     IOWorkers.Selector getWorkerSelector() {
184         return workerSelector;
185     }
186 
187     private void enqueueChannel(final ChannelEntry entry) {
188         try {
189             workerSelector.next().enqueueChannel(entry);
190         } catch (final IOReactorShutdownException ex) {
191             initiateShutdown();
192         }
193     }
194 
195 
196     @Override
197     public void initiateShutdown() {
198         ioReactor.initiateShutdown();
199     }
200 
201     @Override
202     public void awaitShutdown(final TimeValue waitTime) throws InterruptedException {
203         ioReactor.awaitShutdown(waitTime);
204     }
205 
206     @Override
207     public void close(final CloseMode closeMode) {
208         ioReactor.close(closeMode);
209     }
210 
211     @Override
212     public void close() throws IOException {
213         ioReactor.close();
214     }
215 
216 }