Package org.eclipse.jetty.quic.server

Class QuicServerConnector

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.AbstractConnector

org.eclipse.jetty.server.AbstractNetworkConnector

org.eclipse.jetty.quic.server.QuicServerConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Connector, NetworkConnector, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, Graceful, LifeCycle

Direct Known Subclasses:

HTTP3ServerConnector

public class QuicServerConnector
extends AbstractNetworkConnector

A server side network connector that uses a DatagramChannel to listen on a network port for QUIC traffic.

This connector uses ConnectionFactorys to configure the protocols to be transported by QUIC. The protocol is negotiated during the connection establishment by QuicSession, and for each QUIC stream managed by a QuicSession a ConnectionFactory is used to create a Connection for the correspondent QuicStreamEndPoint.

See Also:

• ServerQuicConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Graceful

Graceful.Shutdown, Graceful.ThrowingRunnable

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.NetworkConnector

NetworkConnector.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.server.AbstractConnector

LOG

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
QuicServerConnector(Server server, Executor executor, Scheduler scheduler, ByteBufferPool bufferPool, ServerQuicConfiguration quicConfiguration, ConnectionFactory... factories)
QuicServerConnector(Server server, Executor executor, Scheduler scheduler, ByteBufferPool bufferPool, SslContextFactory.Server sslContextFactory, ConnectionFactory... factories)	Deprecated, for removal: This API element is subject to removal in a future version. use QuicServerConnector(Server, Executor, Scheduler, ByteBufferPool, ServerQuicConfiguration, ConnectionFactory...) instead
QuicServerConnector(Server server, ServerQuicConfiguration quicConfiguration, ConnectionFactory... factories)
QuicServerConnector(Server server, SslContextFactory.Server sslContextFactory, ConnectionFactory... factories)	Deprecated, for removal: This API element is subject to removal in a future version. use QuicServerConnector(Server, ServerQuicConfiguration, ConnectionFactory...) instead

Method Summary

Modifier and Type	Method	Description
protected void	accept(int acceptorID)
void	close()	Performs the activities needed to close the network communication (for example, to stop accepting network connections).
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
int	getInputBufferSize()
int	getLocalPort()
int	getOutputBufferSize()
ServerQuicConfiguration	getQuicConfiguration()
Object	getTransport()	Get the underlying socket, channel, buffer etc.
boolean	isOpen()	A Connector may be opened and not started (to reserve a port) or closed and running (to allow graceful shutdown of existing connections)
boolean	isUseInputDirectByteBuffers()
boolean	isUseOutputDirectByteBuffers()
protected ServerQuicConnection	newConnection(EndPoint endpoint)
protected EndPoint	newEndPoint(DatagramChannel channel, ManagedSelector selector, SelectionKey selectionKey)
void	open()	Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).
protected DatagramChannel	openDatagramChannel()
void	setIdleTimeout(long idleTimeout)	Sets the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call, although with NIO implementations other mechanisms may be used to implement the timeout.
void	setInputBufferSize(int inputBufferSize)
void	setOutputBufferSize(int outputBufferSize)
void	setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)
void	setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)
CompletableFuture<Void>	shutdown()	Shutdown the component.

Methods inherited from class org.eclipse.jetty.server.AbstractNetworkConnector

getHost, getPort, handleAcceptFailure, setHost, setPort, toString

Methods inherited from class org.eclipse.jetty.server.AbstractConnector

addConnectionFactory, addFirstConnectionFactory, addIfAbsentConnectionFactory, clearConnectionFactories, getAcceptorPriorityDelta, getAcceptors, getByteBufferPool, getConnectedEndPoints, getConnectionFactories, getConnectionFactory, getConnectionFactory, getDefaultConnectionFactory, getDefaultProtocol, getExecutor, getIdleTimeout, getName, getProtocols, getScheduler, getServer, getShutdownIdleTimeout, interruptAcceptors, isAccepting, isShutdown, join, join, onEndPointClosed, onEndPointOpened, removeConnectionFactory, setAccepting, setAcceptorPriorityDelta, setConnectionFactories, setDefaultProtocol, setName, setShutdownIdleTimeout

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.Connector

getByteBufferPool, getConnectedEndPoints, getConnectionFactories, getConnectionFactory, getConnectionFactory, getDefaultConnectionFactory, getExecutor, getIdleTimeout, getName, getProtocols, getScheduler, getServer

Methods inherited from interface org.eclipse.jetty.util.component.Container

addBean, addBean, addEventListener, getBean, getBeans, getBeans, getCachedBeans, getContainedBeans, getEventListeners, isManaged, manage, removeBean, removeEventListener, unmanage

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dump, dump, dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Graceful

isShutdown

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

QuicServerConnector

@Deprecated(since="12.0.7",
            forRemoval=true)
public QuicServerConnector(Server server,
 SslContextFactory.Server sslContextFactory,
 ConnectionFactory... factories)

Deprecated, for removal: This API element is subject to removal in a future version.

use QuicServerConnector(Server, ServerQuicConfiguration, ConnectionFactory...) instead

Parameters:

server - the Server

sslContextFactory - the SslContextFactory.Server

factories - the ConnectionFactorys of the protocols transported by QUIC

QuicServerConnector

public QuicServerConnector(Server server,
 ServerQuicConfiguration quicConfiguration,
 ConnectionFactory... factories)

QuicServerConnector

@Deprecated(since="12.0.7",
            forRemoval=true)
public QuicServerConnector(Server server,
 Executor executor,
 Scheduler scheduler,
 ByteBufferPool bufferPool,
 SslContextFactory.Server sslContextFactory,
 ConnectionFactory... factories)

Deprecated, for removal: This API element is subject to removal in a future version.

use QuicServerConnector(Server, Executor, Scheduler, ByteBufferPool, ServerQuicConfiguration, ConnectionFactory...) instead

Parameters:

server - the Server

executor - the Executor

scheduler - the Scheduler

bufferPool - the ByteBufferPool

sslContextFactory - the SslContextFactory.Server

factories - the ConnectionFactorys of the protocols transported by QUIC

QuicServerConnector

public QuicServerConnector(Server server,
 Executor executor,
 Scheduler scheduler,
 ByteBufferPool bufferPool,
 ServerQuicConfiguration quicConfiguration,
 ConnectionFactory... factories)

Method Details

getQuicConfiguration

public ServerQuicConfiguration getQuicConfiguration()

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface NetworkConnector

Overrides:

getLocalPort in class AbstractNetworkConnector

Returns:

The actual port the connector is listening on, or -1 if it has not been opened, or -2 if it has been closed.

getInputBufferSize

public int getInputBufferSize()

setInputBufferSize

public void setInputBufferSize(int inputBufferSize)

getOutputBufferSize

public int getOutputBufferSize()

setOutputBufferSize

public void setOutputBufferSize(int outputBufferSize)

isUseInputDirectByteBuffers

public boolean isUseInputDirectByteBuffers()

setUseInputDirectByteBuffers

public void setUseInputDirectByteBuffers(boolean useInputDirectByteBuffers)

isUseOutputDirectByteBuffers

public boolean isUseOutputDirectByteBuffers()

setUseOutputDirectByteBuffers

public void setUseOutputDirectByteBuffers(boolean useOutputDirectByteBuffers)

isOpen

public boolean isOpen()

Description copied from interface: NetworkConnector

A Connector may be opened and not started (to reserve a port) or closed and running (to allow graceful shutdown of existing connections)

Returns:

True if the connector is Open.

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class AbstractNetworkConnector

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

open

public void open()
          throws IOException

Description copied from interface: NetworkConnector

Performs the activities needed to open the network communication (for example, to start accepting incoming network connections).

Implementation must be idempotent.

Specified by:

open in interface NetworkConnector

Overrides:

open in class AbstractNetworkConnector

Throws:

IOException - if this connector cannot be opened

See Also:

• NetworkConnector.close()

openDatagramChannel

protected DatagramChannel openDatagramChannel()
                                       throws IOException

Throws:

IOException

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Description copied from class: AbstractConnector

Sets the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call, although with NIO implementations other mechanisms may be used to implement the timeout.

The max idle time is applied:

• When waiting for a new message to be received on a connection
• When waiting for a new message to be sent on a connection

This value is interpreted as the maximum time between some progress being made on the connection. So if a single byte is read or written, then the timeout is reset.

Overrides:

setIdleTimeout in class AbstractConnector

Parameters:

idleTimeout - the idle timeout

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class AbstractNetworkConnector

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state

close

public void close()

Description copied from interface: NetworkConnector

Performs the activities needed to close the network communication (for example, to stop accepting network connections).

Once a connector has been closed, it cannot be opened again without first calling LifeCycle.stop() and it will not be active again until a subsequent call to LifeCycle.start().

Implementation must be idempotent.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface NetworkConnector

Overrides:

close in class AbstractNetworkConnector

shutdown

public CompletableFuture<Void> shutdown()

Description copied from interface: Graceful

Shutdown the component. When this method returns, the component should not accept any new load.

Specified by:

shutdown in interface Graceful

Overrides:

shutdown in class AbstractNetworkConnector

Returns:

A future that is completed once all load on the component is completed

getTransport

public Object getTransport()

Description copied from interface: Connector

Get the underlying socket, channel, buffer etc. for the connector..

Returns:

the underlying socket, channel, buffer etc. for the connector.

accept

protected void accept(int acceptorID)

Specified by:

accept in class AbstractConnector

newEndPoint

protected EndPoint newEndPoint(DatagramChannel channel,
 ManagedSelector selector,
 SelectionKey selectionKey)

newConnection

protected ServerQuicConnection newConnection(EndPoint endpoint)