org.restlet.engine.connector

Class ClientHelper

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.RestletHelper<T>

org.restlet.engine.connector.ConnectorHelper<Client>

org.restlet.engine.connector.ClientHelper

Direct Known Subclasses:

FtpClientHelper, HttpClientHelper, LocalClientHelper, RiapClientHelper

public class ClientHelper
extends ConnectorHelper<Client>

Client connector helper. Base client helper based on NIO non blocking sockets. Here is the list of parameters that are supported. They should be set in the Client's context before it is started:

Parameter name	Value type	Default value	Description
socketConnectTimeoutMs	int	0	The socket connection timeout or 0 for unlimited wait.

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
ClientHelper(Client client) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSocketConnectTimeoutMs() Returns the connection timeout.

Methods inherited from class org.restlet.engine.connector.ConnectorHelper

getConnectorService, getContext, getProtocols, start, stop, update

Methods inherited from class org.restlet.engine.RestletHelper

getAttributes, getHelped, getHelpedParameters, getLogger, getMetadataService, handle, setHelped

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientHelper

public ClientHelper(Client client)

Constructor.

Parameters:

client - The client to help.

Method Detail

getSocketConnectTimeoutMs

public int getSocketConnectTimeoutMs()

Returns the connection timeout.

Returns:

The connection timeout.