Module org.eclipse.jetty.server

Package org.eclipse.jetty.server

Class DatagramServerConnector

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.server.DatagramServerConnector

All Implemented Interfaces:

Closeable, AutoCloseable, Connector, NetworkConnector, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.Graceful, org.eclipse.jetty.util.component.LifeCycle

public class DatagramServerConnector
extends AbstractNetworkConnector

Nested Class Summary

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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

org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.Dumpable.DumpAppendable

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

org.eclipse.jetty.util.component.Graceful.Shutdown, org.eclipse.jetty.util.component.Graceful.ThrowingRunnable

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

org.eclipse.jetty.util.component.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

LEGEND

Constructor Summary

Constructors

Constructor	Description
DatagramServerConnector(Server server, Executor executor, org.eclipse.jetty.util.thread.Scheduler scheduler, org.eclipse.jetty.io.ByteBufferPool bufferPool, ConnectionFactory... factories)
DatagramServerConnector(Server server, ConnectionFactory... factories)

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()
protected void	doStop()
int	getLocalPort()
Object	getTransport()	Get the underlying socket, channel, buffer etc. for the connector..
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)
protected org.eclipse.jetty.io.Connection	newConnection(org.eclipse.jetty.io.EndPoint endpoint)
protected org.eclipse.jetty.io.EndPoint	newEndPoint(DatagramChannel channel, org.eclipse.jetty.io.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.

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

getHost, getPort, handleAcceptFailure, setHost, setPort, shutdown, 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

DatagramServerConnector

public DatagramServerConnector(Server server,
 ConnectionFactory... factories)

DatagramServerConnector

public DatagramServerConnector(Server server,
 Executor executor,
 org.eclipse.jetty.util.thread.Scheduler scheduler,
 org.eclipse.jetty.io.ByteBufferPool bufferPool,
 ConnectionFactory... factories)

Method Details

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.

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

Overrides:

doStart in class AbstractNetworkConnector

Throws:

Exception

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

Overrides:

doStop in class AbstractNetworkConnector

Throws:

Exception

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

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 org.eclipse.jetty.io.EndPoint newEndPoint(DatagramChannel channel,
 org.eclipse.jetty.io.ManagedSelector selector,
 SelectionKey selectionKey)

newConnection

protected org.eclipse.jetty.io.Connection newConnection(org.eclipse.jetty.io.EndPoint endpoint)