Package org.apache.hc.core5.http.impl.bootstrap

Class AsyncServer

java.lang.Object

org.apache.hc.core5.http.impl.bootstrap.AbstractConnectionInitiatorBase

org.apache.hc.core5.http.impl.bootstrap.AsyncServer

All Implemented Interfaces:

Closeable, AutoCloseable, ModalCloseable, ConnectionAcceptor, ConnectionInitiator, IOReactor, IOReactorService

Direct Known Subclasses:

HttpAsyncServer

public class AsyncServer
extends AbstractConnectionInitiatorBase
implements IOReactorService, ConnectionAcceptor

Protocol agnostic server side I/O session handler.

Field Summary

Fields

Modifier and Type	Field	Description
private final DefaultListeningIOReactor	ioReactor

Constructor Summary

Constructors

Constructor	Description
AsyncServer(IOEventHandlerFactory eventHandlerFactory, IOReactorConfig ioReactorConfig, Decorator<IOSession> ioSessionDecorator, Callback<Exception> exceptionCallback, IOSessionListener sessionListener, Callback<IOSession> sessionShutdownCallback)

Method Summary

Modifier and Type	Method	Description
void	awaitShutdown(TimeValue waitTime)	Blocks for the given period of time in milliseconds awaiting the completion of the reactor shutdown.
void	close()
void	close(CloseMode closeMode)	Shuts down the I/O reactor either gracefully or immediately.
Set<ListenerEndpoint>	getEndpoints()	Returns a set of endpoints for this I/O reactor.
(package private) ConnectionInitiator	getIOReactor()
IOReactorStatus	getStatus()	Returns the current status of the reactor.
void	initiateShutdown()	Initiates shutdown of the reactor without blocking.
Future<ListenerEndpoint>	listen(SocketAddress address)
Future<ListenerEndpoint>	listen(SocketAddress address, Object attachment, FutureCallback<ListenerEndpoint> callback)	Opens a new listener endpoint with the given socket address.
Future<ListenerEndpoint>	listen(SocketAddress address, FutureCallback<ListenerEndpoint> callback)	Opens a new listener endpoint with the given socket address.
void	pause()	Suspends the I/O reactor preventing it from accepting new connections on all active endpoints.
void	resume()	Resumes the I/O reactor restoring its ability to accept incoming connections on all active endpoints.
void	start()	Starts I/O reactor.

Methods inherited from class org.apache.hc.core5.http.impl.bootstrap.AbstractConnectionInitiatorBase

connect

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ioReactor

private final DefaultListeningIOReactor ioReactor

Constructor Details

AsyncServer

@Internal
public AsyncServer(IOEventHandlerFactory eventHandlerFactory,
 IOReactorConfig ioReactorConfig,
 Decorator<IOSession> ioSessionDecorator,
 Callback<Exception> exceptionCallback,
 IOSessionListener sessionListener,
 Callback<IOSession> sessionShutdownCallback)

Method Details

start

public void start()

Description copied from interface: IOReactorService

Starts I/O reactor.

Specified by:

start in interface IOReactorService

getIOReactor

ConnectionInitiator getIOReactor()

Specified by:

getIOReactor in class AbstractConnectionInitiatorBase

listen

public Future<ListenerEndpoint> listen(SocketAddress address,
 Object attachment,
 FutureCallback<ListenerEndpoint> callback)

Description copied from interface: ConnectionAcceptor

Opens a new listener endpoint with the given socket address. Once the endpoint is fully initialized it starts accepting incoming connections and propagates I/O activity notifications to the I/O event dispatcher.

Specified by:

listen in interface ConnectionAcceptor

Parameters:

address - the socket address to listen on.

attachment - the attachment object.

callback - the result callback.

Returns:

listener endpoint.

Since:

5.1

listen

public Future<ListenerEndpoint> listen(SocketAddress address,
 FutureCallback<ListenerEndpoint> callback)

Description copied from interface: ConnectionAcceptor

Opens a new listener endpoint with the given socket address. Once the endpoint is fully initialized it starts accepting incoming connections and propagates I/O activity notifications to the I/O event dispatcher.

Specified by:

listen in interface ConnectionAcceptor

Parameters:

address - the socket address to listen on.

callback - the result callback.

Returns:

listener endpoint.

listen

public Future<ListenerEndpoint> listen(SocketAddress address)

pause

public void pause()
           throws IOException

Description copied from interface: ConnectionAcceptor

Suspends the I/O reactor preventing it from accepting new connections on all active endpoints.

Specified by:

pause in interface ConnectionAcceptor

Throws:

IOException - in case of an I/O error.

resume

public void resume()
            throws IOException

Description copied from interface: ConnectionAcceptor

Resumes the I/O reactor restoring its ability to accept incoming connections on all active endpoints.

Specified by:

resume in interface ConnectionAcceptor

Throws:

IOException - in case of an I/O error.

getEndpoints

public Set<ListenerEndpoint> getEndpoints()

Description copied from interface: ConnectionAcceptor

Returns a set of endpoints for this I/O reactor.

Specified by:

getEndpoints in interface ConnectionAcceptor

Returns:

set of endpoints.

getStatus

public IOReactorStatus getStatus()

Description copied from interface: IOReactor

Returns the current status of the reactor.

Specified by:

getStatus in interface IOReactor

Returns:

reactor status.

initiateShutdown

public void initiateShutdown()

Description copied from interface: IOReactor

Initiates shutdown of the reactor without blocking. The reactor is expected to terminate all active connections, to shut down itself and to release system resources it currently holds

Specified by:

initiateShutdown in interface IOReactor

awaitShutdown

public void awaitShutdown(TimeValue waitTime)
                   throws InterruptedException

Description copied from interface: IOReactor

Blocks for the given period of time in milliseconds awaiting the completion of the reactor shutdown.

Specified by:

awaitShutdown in interface IOReactor

Parameters:

waitTime - wait time.

Throws:

InterruptedException

close

public void close(CloseMode closeMode)

Description copied from interface: IOReactor

Shuts down the I/O reactor either gracefully or immediately. During graceful shutdown individual I/O sessions should be informed about imminent termination and be given a grace period to complete the ongoing I/O sessions. During immediate shutdown all ongoing I/O sessions get aborted immediately.

Specified by:

close in interface IOReactor

Specified by:

close in interface ModalCloseable

Parameters:

closeMode - How to close the receiver.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException