com.marketfactory.api

Class SubscriptionEvent

java.lang.Object

com.marketfactory.api.SubscriptionEvent

All Implemented Interfaces:

IMessage, java.io.Serializable, java.lang.Comparable<SubscriptionEvent>

public final class SubscriptionEvent
extends java.lang.Object
implements IMessage, java.lang.Comparable<SubscriptionEvent>, java.io.Serializable

An event that provides updates on the status of each subscription.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	clSubID Client-provided subscription request ID.
java.lang.String	reason Text that accompanies the status to explain the status of the subscription.
SubscriptionStatus	status This indicates whether the subscription succeeded or failed, with the details in the 'reason' field.
boolean	sticky Sticky subscription flag.
Subscription	sub The subscription description.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SubscriptionEvent()
protected	SubscriptionEvent(ProtoByteBuffer buffer)
	SubscriptionEvent(Subscription sub, java.lang.String clSubID, SubscriptionStatus status, java.lang.String reason, boolean sticky)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SubscriptionEvent rhs)
void	deserialize(ProtoByteBuffer buffer)
protected void	dump(TextWriter wr)
boolean	equals(java.lang.Object rhs)
int	getMsgType()
int	hashCode()
void	serialize(ProtoByteBuffer buffer)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sub

public Subscription sub

The subscription description.

clSubID

public java.lang.String clSubID

Client-provided subscription request ID.

status

public SubscriptionStatus status

This indicates whether the subscription succeeded or failed, with the details in the 'reason' field.

reason

public java.lang.String reason

Text that accompanies the status to explain the status of the subscription.

sticky

public boolean sticky

Sticky subscription flag.

Constructor Detail

SubscriptionEvent

public SubscriptionEvent()

SubscriptionEvent

protected SubscriptionEvent(ProtoByteBuffer buffer)

SubscriptionEvent

public SubscriptionEvent(Subscription sub,
                         java.lang.String clSubID,
                         SubscriptionStatus status,
                         java.lang.String reason,
                         boolean sticky)

Method Detail

getMsgType

public int getMsgType()

Specified by:

getMsgType in interface IMessage

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(SubscriptionEvent rhs)

Specified by:

compareTo in interface java.lang.Comparable<SubscriptionEvent>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

deserialize

public void deserialize(ProtoByteBuffer buffer)

Specified by:

deserialize in interface IMessage

serialize

public void serialize(ProtoByteBuffer buffer)

Specified by:

serialize in interface IMessage

toString

public java.lang.String toString()

Specified by:

toString in interface IMessage

Overrides:

toString in class java.lang.Object

dump

protected void dump(TextWriter wr)