com.vmware.vapi.protocol.server.rpc.http

Interface Endpoint

All Known Subinterfaces:

SslEndpoint

All Known Implementing Classes:

HttpEndpoint, HttpsEndpoint

public interface Endpoint

An HTTP server (host, port, protocol) triple plus connector specific configuration

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Endpoint.EndpointType Describe the endpoint's I/O connector type
static class	Endpoint.Protocol Describes the endpoint's protocol

Method Summary

Modifier and Type	Method and Description
int	getAcceptQueueSize() Get number of connection requests that can be queued up before the operating system starts to send rejections.
Endpoint.EndpointType	getEndpointType() Get the endpoint connector I/O type.
String	getHost() Returns the endpoint's host.
int	getMaxIdleTime() Default valule is 200000 ms
int	getNumAcceptors() Get the number of thread dedicated to accepting incoming connections.
int	getPort() Returns the endpoint's port number.
Endpoint.Protocol	getProtocol() Returns the endpoint's protocol.
void	setAcceptQueueSize(int acceptQueueSize) Set number of connection requests that can be queued up before the operating system starts to send rejections.
void	setEndpointType(Endpoint.EndpointType type) Set the endpoint connector I/O type (like blocking or NIO).
void	setMaxIdleTime(int maxIdleTime) Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call but depends on the application server used and how it is configured.
void	setNumAcceptors(int acceptors) Set the number of thread dedicated to accepting incoming connections.

Method Detail

getPort

int getPort()

Returns the endpoint's port number.

Returns:

The endpoint's port number.

getHost

String getHost()

Returns the endpoint's host.

Returns:

The endpoint's host.

getProtocol

Endpoint.Protocol getProtocol()

Returns the endpoint's protocol.

Returns:

The endpoint's protocol.

getNumAcceptors

int getNumAcceptors()

Get the number of thread dedicated to accepting incoming connections.

Returns:

thread number

setNumAcceptors

void setNumAcceptors(int acceptors)

Set the number of thread dedicated to accepting incoming connections.

Parameters:

acceptors - thread number. Defaults to 1

getAcceptQueueSize

int getAcceptQueueSize()

Get number of connection requests that can be queued up before the operating system starts to send rejections.

Returns:

max number of queued requests

setAcceptQueueSize

void setAcceptQueueSize(int acceptQueueSize)

Set number of connection requests that can be queued up before the operating system starts to send rejections.

Parameters:

acceptQueueSize - max number of queued requests. Defaults to 0. For the semantics see backlog parameter in ServerSocket.bind(java.net.SocketAddress, int)

setMaxIdleTime

void setMaxIdleTime(int maxIdleTime)

Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call but depends on the application server used and how it is configured. The max idle time is applied:

• When waiting for a new request to be received on a connection
• When reading the headers and content of a request
• When writing the headers and content of a response

This value MUST be bigger than the keep alive period on the client.

Default value is 200000 ms

Parameters:

maxIdleTime - The maxIdleTime to set.

getMaxIdleTime

int getMaxIdleTime()

Default valule is 200000 ms

Returns:

Returns the maxIdleTime.

setEndpointType

void setEndpointType(Endpoint.EndpointType type)

Set the endpoint connector I/O type (like blocking or NIO). Default is Endpoint.EndpointType.BLOCKING.

Parameters:

type - the I/O type to use

getEndpointType

Endpoint.EndpointType getEndpointType()

Get the endpoint connector I/O type.

Returns:

EndpointType representing the type