Package com.alachisoft.ncache.runtime.caching

Class MessageEventArgs

java.lang.Object

com.alachisoft.ncache.runtime.caching.MessageEventArgs

Direct Known Subclasses:

MessageFailedEventArgs

public class MessageEventArgs
extends java.lang.Object

Arguments containing details of received message including topic, sender and type.

Constructor Summary

Constructors

Constructor	Description
MessageEventArgs(Message message, DeliveryOption deliverOption, Topic messageTopic, java.lang.String topicName)	This constructor of class MessageEventArgs creates an instance of class with message to be delivered, DeliveryOption, topic to which message belongs, and the topic on which message is published.

Method Summary

Modifier and Type	Method	Description
DeliveryOption	getDeliveryOption()	Gets the enum that indicates how the message should be delivered.
Message	getMessage()	Gets the message to be delivered.
Topic	getTopic()	Gets the topic to which the message belongs.
java.lang.String	getTopicName()	Gets the name of the topic on which message is published.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageEventArgs

public MessageEventArgs(Message message,
                        DeliveryOption deliverOption,
                        Topic messageTopic,
                        java.lang.String topicName)

This constructor of class MessageEventArgs creates an instance of class with message to be delivered, DeliveryOption, topic to which message belongs, and the topic on which message is published.

Parameters:

message - Message to be delivered.

deliverOption - How message should be delivered.

messageTopic - Topic to which message belongs.

topicName - Topic on which message is published.

Method Detail

getMessage

public final Message getMessage()

Gets the message to be delivered.

Returns:

The message to be delivered.

getDeliveryOption

public final DeliveryOption getDeliveryOption()

Gets the enum that indicates how the message should be delivered.

Returns:

The DeliveryOption enum.

getTopic

public final Topic getTopic()

Gets the topic to which the message belongs.

Returns:

The topic to which the message belongs.

getTopicName

public java.lang.String getTopicName()

Gets the name of the topic on which message is published.

Returns:

The topic name on which the message is published.