Jetty 12.0.6 · org.eclipse.jetty.io.ClientConnector · APIdia, the JavaDoc alternative

The client-side component that connects to server sockets.

ClientConnector delegates the handling of SocketChannels to a SelectorManager, and centralizes the configuration of necessary components such as the executor, the scheduler, etc.

ClientConnector offers a low-level API that can be used to connect SocketChannels to listening servers via the connect(SocketAddress, Map) method.

However, a ClientConnector instance is typically just configured and then passed to an HttpClient transport, so that applications can use high-level APIs to make HTTP requests to servers:

// Create a ClientConnector instance.
ClientConnector connector = new ClientConnector();

// Configure the ClientConnector.
connector.setSelectors(1);
connector.setSslContextFactory(new SslContextFactory.Client());

// Pass it to the HttpClient transport.
HttpClientTransport transport = new HttpClientTransportDynamic(connector);
HttpClient httpClient = new HttpClient(transport);
httpClient.start();

Modifier and Type	Class and Description
protected class	ClientConnector.ClientSelectorManager
public static class	ClientConnector.Configurator Configures a `ClientConnector`.

Modifier and Type	Field and Description
public static final String	APPLICATION_PROTOCOLS_CONTEXT_KEY
private SocketAddress	bindAddress
private ByteBufferPool	byteBufferPool
public static final String	CLIENT_CONNECTION_FACTORY_CONTEXT_KEY
public static final String	CLIENT_CONNECTOR_CONTEXT_KEY
private final ClientConnector.Configurator	configurator
private boolean	connectBlocking
public static final String	CONNECTION_PROMISE_CONTEXT_KEY
private Duration	connectTimeout
private Executor	executor
private Duration	idleTimeout
private static final Logger	LOG Hides org.eclipse.jetty.util.component.ContainerLifeCycle.LOG.
private int	receiveBufferSize
public static final String	REMOTE_SOCKET_ADDRESS_CONTEXT_KEY
private boolean	reuseAddress
private boolean	reusePort
private Scheduler	scheduler
private SelectorManager	selectorManager
private int	selectors
private int	sendBufferSize
private SslContextFactory.Client	sslContextFactory
private boolean	tcpNoDelay

Access	Constructor and Description
public	ClientConnector()
public	ClientConnector(ClientConnector.Configurator configurator)

Method Summary

Modifier and Type	Method and Description
public void	accept(SelectableChannel selectable, Map<String, Object> context)
private void	bind(NetworkChannel channel, SocketAddress bindAddress)
protected void	configure(SelectableChannel selectable)
public void	connect(SocketAddress address, Map<String, Object> context)
protected void	connectFailed(Throwable failure, Map<String, Object> context)
protected void	doStart() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public static ClientConnector	Returns: a ClientConnector that connects to the given Unix-Domain path forUnixDomain(Path the Unix-Domain path to connect to path) Creates a ClientConnector configured to connect via Unix-Domain sockets to the given Unix-Domain path
public SocketAddress	getBindAddress() Returns: the address to bind a socket to before the connect operation
public ByteBufferPool	getByteBufferPool()
public Duration	getConnectTimeout() Returns: the timeout of `connect(SocketAddress, Map)` operations
public Executor	getExecutor()
public Duration	getIdleTimeout() Returns: the max duration for which a connection can be idle (that is, without traffic of bytes in either direction)
public int	getReceiveBufferSize() Returns: the receive buffer size in bytes, or -1 for the default value
public boolean	getReuseAddress() Returns: whether rebinding is allowed with sockets in tear-down states
public Scheduler	getScheduler()
public int	getSelectors() Returns: the number of NIO selectors
public int	getSendBufferSize() Returns: the send buffer size in bytes, or -1 for the default value
public SslContextFactory.Client	getSslContextFactory()
public boolean	isConnectBlocking() Returns: whether `connect(SocketAddress, Map)` operations are performed in blocking mode
public boolean	isIntrinsicallySecure(SocketAddress the SocketAddress to connect to address) Returns: whether the connection to the given SocketAddress is intrinsically secure
public boolean	isReusePort() Returns: whether binding to same host and port is allowed
public boolean	isTCPNoDelay() Returns: whether small TCP packets are sent without delay
protected Connection	newConnection(EndPoint endPoint, Map<String, Object> context)
protected EndPoint	newEndPoint(SelectableChannel selectable, ManagedSelector selector, SelectionKey selectionKey)
protected SelectorManager	newSelectorManager()
protected SslContextFactory.Client	newSslContextFactory()
public void	setBindAddress(SocketAddress the socket address to bind to before the connect operation bindAddress) Sets the bind address of sockets before the connect operation.
public void	setByteBufferPool(ByteBufferPool byteBufferPool)
public void	setConnectBlocking(boolean connectBlocking)
public void	setConnectTimeout(Duration connectTimeout)
public void	setExecutor(Executor executor)
public void	setIdleTimeout(Duration idleTimeout)
public void	setReceiveBufferSize(int receiveBufferSize)
public void	setReuseAddress(boolean whether rebinding is allowed with sockets in tear-down states reuseAddress) Sets whether it is allowed to bind a socket to a socket address that may be in use by another socket in tear-down state, for example in TIME_WAIT state.
public void	setReusePort(boolean whether binding to same host and port is allowed reusePort) Sets whether it is allowed to bind multiple sockets to the same socket address (same host and same port).
public void	setScheduler(Scheduler scheduler)
public void	setSelectors(int selectors)
public void	setSendBufferSize(int sendBufferSize)
private <T> void	setSocketOption(NetworkChannel channel, SocketOption<T> option, T value)
public void	setSslContextFactory(SslContextFactory.Client sslContextFactory)
public void	setTCPNoDelay(boolean tcpNoDelay)

public Class ClientConnector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary