org.atmosphere.wasync.impl

Class AtmosphereClient

java.lang.Object

org.atmosphere.wasync.impl.AtmosphereClient

All Implemented Interfaces:

Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

public class AtmosphereClient
extends java.lang.Object
implements Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

A specialized Client for the Atmosphere Framework. This client support the Atmosphere Protocol.
An AtmosphereRequest.AtmosphereRequestBuilder will be created and Atmosphere's specific protocol information can be set using this object.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
AtmosphereClient()

Method Summary

Modifier and Type	Method and Description
Socket	create() Create a Socket
Socket	create(DefaultOptions options) Create a Socket configured using the Options
DefaultOptionsBuilder	newOptionsBuilder() Return an OptionsBuilder
AtmosphereRequest.AtmosphereRequestBuilder	newRequestBuilder() Return a RequestBuilder
AtmosphereRequest.AtmosphereRequestBuilder	newRequestBuilder(java.lang.Class<AtmosphereRequest.AtmosphereRequestBuilder> clazz) Create a new RequestBuilder based on the class' implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtmosphereClient

public AtmosphereClient()

Method Detail

create

public Socket create()

Create a Socket

Specified by:

create in interface Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

Returns:

Socket

create

public Socket create(DefaultOptions options)

Create a Socket configured using the Options

Specified by:

create in interface Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

Returns:

Socket

newRequestBuilder

public AtmosphereRequest.AtmosphereRequestBuilder newRequestBuilder(java.lang.Class<AtmosphereRequest.AtmosphereRequestBuilder> clazz)

Create a new RequestBuilder based on the class' implementation.

Specified by:

newRequestBuilder in interface Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

Parameters:

clazz - an implementation of RequestBuilder

Returns:

a RequestBuilder

newOptionsBuilder

public DefaultOptionsBuilder newOptionsBuilder()

Return an OptionsBuilder

Specified by:

newOptionsBuilder in interface Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

Returns:

OptionsBuilder

newRequestBuilder

public AtmosphereRequest.AtmosphereRequestBuilder newRequestBuilder()

Return a RequestBuilder

Specified by:

newRequestBuilder in interface Client<DefaultOptions,DefaultOptionsBuilder,AtmosphereRequest.AtmosphereRequestBuilder>

Returns:

a RequestBuilder