com.scaleoutsoftware.soss.client

Class Event

java.lang.Object

com.scaleoutsoftware.soss.client.Event

All Implemented Interfaces:

java.io.Serializable

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

Contains information about an event that was pushed from a ScaleOut client (via Pipeline.postEvent).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Event(NamedCache cache, CachedObjectId id, java.lang.String info, byte[] object)

Method Summary

Modifier and Type	Method and Description
NamedCache	getCache() The named cache that can be used to access the object associated with Id.
CachedObjectId	getId() The key to an object stored in the ScaleOut service to which the event is to be applied
java.lang.String	getInfo() An arbitrary user-provided UTF-8 String containing information about the event, passed from the client-side eventInfo parameter that's passed into Pipeline.postEvent().
byte[]	getPayload() An optional payload of bytes that can hold data related to the event (typically a serialized object).
void	setCache(NamedCache cache)
void	setId(CachedObjectId id)

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(NamedCache cache,
             CachedObjectId id,
             java.lang.String info,
             byte[] object)

Method Detail

getId

public CachedObjectId getId()

The key to an object stored in the ScaleOut service to which the event is to be applied

Returns:

the id of this object that is associated with this event

setId

public void setId(CachedObjectId id)

getInfo

public java.lang.String getInfo()

An arbitrary user-provided UTF-8 String containing information about the event, passed from the client-side eventInfo parameter that's passed into Pipeline.postEvent().

Returns:

the info

getPayload

public byte[] getPayload()

An optional payload of bytes that can hold data related to the event (typically a serialized object).

Returns:

the payload for this event

getCache

public NamedCache getCache()

The named cache that can be used to access the object associated with Id.

Returns:

the NamedCache where this event came from.

setCache

public void setCache(NamedCache cache)