Gets the message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

Sets the message's expiration value.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Namespace:  Kaazing.JMS
Assembly:  Kaazing.JMS (in Kaazing.JMS.dll)

Syntax

Visual Basic
Property JMSExpiration As Long
	Get
	Set
C#
long JMSExpiration { get; set; }
Visual C++
property long long JMSExpiration {
	long long get ();
	void set (long long value);
}

Return Value

the time the message expires, which is the sum of the time-to-live value specified by the client and the GMT at the time of the send

Exceptions

ExceptionCondition
Kaazing.JMS..::..JMSExceptionif the JMS provider fails to get the message expiration due to some internal error.
Kaazing.JMS..::..JMSExceptionif the JMS provider fails to set the message expiration due to some internal error.

See Also

IMessage..::..JMSExpiration
IMessage..::..JMSExpiration