Package org.atmosphere.cpr

Class Deliver

java.lang.Object

org.atmosphere.cpr.Deliver

All Implemented Interfaces:

java.io.Serializable

public class Deliver
extends java.lang.Object
implements java.io.Serializable

A Deliver is an Broadcaster's internal token that is created before the message gets Broadcaster. A Deliver gives information about what will be delivered, to whow, etc.

Author:

Jeanfrancois Arcand

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Deliver.TYPE

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	async
protected CacheMessage	cache
protected BroadcasterFuture<?>	future
protected java.lang.Object	message
protected java.lang.Object	originalMessage
protected AtmosphereResource	resource
protected java.util.Set<AtmosphereResource>	resources
protected Deliver.TYPE	type
protected boolean	writeLocally

Constructor Summary

Constructors

Constructor	Description
Deliver(java.lang.Object message, java.util.Set<AtmosphereResource> resources, BroadcasterFuture<?> future, java.lang.Object originalMessage)
Deliver(java.lang.Object message, AtmosphereResource r, BroadcasterFuture<?> future, java.lang.Object originalMessage)
Deliver(java.lang.Object message, BroadcasterFuture<?> future, boolean writeLocally)
Deliver(java.lang.Object message, BroadcasterFuture<?> future, java.lang.Object originalMessage)
Deliver(AtmosphereResource r, Deliver e)
Deliver(AtmosphereResource r, Deliver e, CacheMessage cacheMessage)
Deliver(Deliver.TYPE type, java.lang.Object originalMessage, java.lang.Object message, AtmosphereResource r, BroadcasterFuture<?> future, CacheMessage cache, boolean writeLocally, java.util.Set<AtmosphereResource> resources, boolean async)

Method Summary

Modifier and Type	Method	Description
CacheMessage	getCache()
BroadcasterFuture<?>	getFuture()
java.lang.Object	getMessage()
java.lang.Object	getOriginalMessage()
AtmosphereResource	getResource()
java.util.Set<AtmosphereResource>	getResources()
Deliver.TYPE	getType()
boolean	isAsync()
boolean	isWriteLocally()
void	setAsync(boolean async)
void	setCache(CacheMessage cache)
void	setFuture(BroadcasterFuture<?> future)
void	setMessage(java.lang.Object message)
void	setOriginalMessage(java.lang.Object originalMessage)
void	setWriteLocally(boolean writeLocally)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

message

protected java.lang.Object message

future

protected BroadcasterFuture<?> future

writeLocally

protected boolean writeLocally

originalMessage

protected java.lang.Object originalMessage

resource

protected final AtmosphereResource resource

resources

protected final java.util.Set<AtmosphereResource> resources

type

protected final Deliver.TYPE type

cache

protected CacheMessage cache

async

protected boolean async

Constructor Detail

Deliver

public Deliver(Deliver.TYPE type,
               java.lang.Object originalMessage,
               java.lang.Object message,
               AtmosphereResource r,
               BroadcasterFuture<?> future,
               CacheMessage cache,
               boolean writeLocally,
               java.util.Set<AtmosphereResource> resources,
               boolean async)

Deliver

public Deliver(java.lang.Object message,
               AtmosphereResource r,
               BroadcasterFuture<?> future,
               java.lang.Object originalMessage)

Deliver

public Deliver(java.lang.Object message,
               BroadcasterFuture<?> future,
               java.lang.Object originalMessage)

Deliver

public Deliver(AtmosphereResource r,
               Deliver e)

Deliver

public Deliver(AtmosphereResource r,
               Deliver e,
               CacheMessage cacheMessage)

Deliver

public Deliver(java.lang.Object message,
               java.util.Set<AtmosphereResource> resources,
               BroadcasterFuture<?> future,
               java.lang.Object originalMessage)

Deliver

public Deliver(java.lang.Object message,
               BroadcasterFuture<?> future,
               boolean writeLocally)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMessage

public java.lang.Object getMessage()

setMessage

public void setMessage(java.lang.Object message)

getFuture

public BroadcasterFuture<?> getFuture()

setFuture

public void setFuture(BroadcasterFuture<?> future)

isWriteLocally

public boolean isWriteLocally()

setWriteLocally

public void setWriteLocally(boolean writeLocally)

getOriginalMessage

public java.lang.Object getOriginalMessage()

setOriginalMessage

public void setOriginalMessage(java.lang.Object originalMessage)

getResource

public AtmosphereResource getResource()

getResources

public java.util.Set<AtmosphereResource> getResources()

getType

public Deliver.TYPE getType()

getCache

public CacheMessage getCache()

setCache

public void setCache(CacheMessage cache)

isAsync

public boolean isAsync()

setAsync

public void setAsync(boolean async)