org.atmosphere.wasync.impl

Class AtmosphereRequest

java.lang.Object

org.atmosphere.wasync.impl.DefaultRequest<AtmosphereRequest.AtmosphereRequestBuilder>

org.atmosphere.wasync.impl.AtmosphereRequest

All Implemented Interfaces:

Request

public class AtmosphereRequest
extends DefaultRequest<AtmosphereRequest.AtmosphereRequestBuilder>

A specialized Request implementation to use with the Atmosphere Framework. Functionality like track message length, broadcaster cache, etc. can be configured using this object. Make sure your server is properly configured before changing the default. AtmosphereRequest MUST NOT be shared between Socket instance because they hold information about the Atmosphere Protocol like the UUID.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AtmosphereRequest.AtmosphereRequestBuilder A builder for AtmosphereRequest.
static class	AtmosphereRequest.CACHE

Nested classes/interfaces inherited from interface org.atmosphere.wasync.Request

Request.METHOD, Request.TRANSPORT

Field Summary

Fields inherited from class org.atmosphere.wasync.impl.DefaultRequest

builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AtmosphereRequest(AtmosphereRequest.AtmosphereRequestBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	enableProtocol() True if the Atmosphere Protocol is enabled
AtmosphereRequest.CACHE	getCacheType() Return the AtmosphereRequest.CACHE used.
String	getTrackMessageLengthDelimiter() The delimiter used by the Atmosphere Framework when sending message length and message's size.
boolean	isTrackMessageLength() Is tracking message's length enabled.

Methods inherited from class org.atmosphere.wasync.impl.DefaultRequest

decoders, encoders, functionResolver, headers, method, queryString, transport, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

AtmosphereRequest

protected AtmosphereRequest(AtmosphereRequest.AtmosphereRequestBuilder builder)

Method Detail

getCacheType

public AtmosphereRequest.CACHE getCacheType()

Return the AtmosphereRequest.CACHE used. The value must match the Atmosphere's Broadcaster cache implementation of the server.

Returns:

the AtmosphereRequest.CACHE

isTrackMessageLength

public boolean isTrackMessageLength()

Is tracking message's length enabled.

Returns:

true if enabled

enableProtocol

public boolean enableProtocol()

True if the Atmosphere Protocol is enabled

Returns:

true if the Atmosphere Protocol is enabled.

getTrackMessageLengthDelimiter

public String getTrackMessageLengthDelimiter()

The delimiter used by the Atmosphere Framework when sending message length and message's size.

Returns:

delimiter used. Default is '|'