Inspirel.YAMI.OutgoingMessage Class Reference

Outgoing message. More...

List of all members.

Classes
class	MessageStateInfo
	Helper class for reporting full message state. More...
Public Types
enum	MessageState {   POSTED, TRANSMITTED, ABANDONED, REPLIED,   REJECTED }
	Enumeration defining all possible message states. More...
Public Member Functions
void	WaitForTransmission ()
	Waits for the transmission of this message.
void	WaitForTransmission (long relativeTimeout)
	Waits for the transmission of this message.
void	WaitForTransmissionAbsolute (long absoluteTimeout)
	Waits for the transmission of this message.
void	WaitForCompletion ()
	Waits for the completion of this message.
void	WaitForCompletion (long relativeTimeout)
	Waits for the completion of this message.
void	WaitForCompletionAbsolute (long absoluteTimeout)
	Waits for the completion of this message.
void	Close ()
	Cleans up internal resources related to this message.
Properties
MessageState	State [get]
	Gets the current state of the message.
MessageStateInfo	StateInfo [get]
	Gets the current state and information about the message progress.
Parameters	Reply [get]
	Gets the reply body.
byte[]	RawReply [get]
	Gets the raw reply body.
string	ExceptionMsg [get]
	Gets the rejection reason for this message.

---

Detailed Description

Outgoing message.

The handler (proxy) allowing to track the progress of outgoing message, inspect its state and to obtain the reply content.

Note: The objects of this class can be safely used from multiple threads.

---

Member Enumeration Documentation

enum Inspirel::YAMI::OutgoingMessage::MessageState

Enumeration defining all possible message states.

Enumerator:

POSTED	Message was posted for transmission.
TRANSMITTED	Message was fully transmitted.
ABANDONED	Message was abandoned due to error or channel closing.
REPLIED	The reply was received for the given message.
REJECTED	Message was rejected.

---

Member Function Documentation

void Inspirel.YAMI.OutgoingMessage.Close

(

)

Cleans up internal resources related to this message.

void Inspirel.YAMI.OutgoingMessage.WaitForCompletion

(

long

relativeTimeout

)

Waits for the completion of this message.

The wait is terminated either when the message is completed - which means that there was a reply or rejection received for it - or when the message is cancelled due to error or channel closing request or when the timeout expires.

Parameters:

relativeTimeout

relative timeout in milliseconds

void Inspirel.YAMI.OutgoingMessage.WaitForCompletion

(

)

Waits for the completion of this message.

The wait is terminated either when the message is completed - which means that there was a reply or rejection received for it - or when the message is cancelled due to error or channel closing request.

void Inspirel.YAMI.OutgoingMessage.WaitForCompletionAbsolute

(

long

absoluteTimeout

)

Waits for the completion of this message.

The wait is terminated either when the message is completed - which means that there was a reply or rejection received for it - or when the message is cancelled due to error or channel closing request or when the timeout expires.

Parameters:

absoluteTimeout

absolute timeout in milliseconds, counted from the beginning of the epoch (UTC)

void Inspirel.YAMI.OutgoingMessage.WaitForTransmission

(

long

relativeTimeout

)

Waits for the transmission of this message.

The wait is terminated either when the transmission is successful or when the message is cancelled due to error or channel closing request or when the timeout expires.

Parameters:

relativeTimeout

relative timeout in milliseconds

void Inspirel.YAMI.OutgoingMessage.WaitForTransmission

(

)

Waits for the transmission of this message.

The wait is terminated either when the transmission is successful or when the message is cancelled due to error or channel closing request.

void Inspirel.YAMI.OutgoingMessage.WaitForTransmissionAbsolute

(

long

absoluteTimeout

)

Waits for the transmission of this message.

The wait is terminated either when the transmission is successful or when the message is cancelled due to error or channel closing request or when the timeout expires.

Parameters:

absoluteTimeout

absolute timeout in milliseconds, counted from the beginning of the epoch (UTC)

---

Property Documentation

string Inspirel.YAMI.OutgoingMessage.ExceptionMsg [get]

Gets the rejection reason for this message.

Rejection reason (or exception message) if the current state is REJECTED

Exceptions:

BadStateException

if the current state is not REJECTED

byte [] Inspirel.YAMI.OutgoingMessage.RawReply [get]

Gets the raw reply body.

Exceptions:

BadStateException

if the current state is not REPLIED or if the agent was not configured for raw delivery

Parameters Inspirel.YAMI.OutgoingMessage.Reply [get]

Gets the reply body.

Reply body if the current state is REPLIED

Exceptions:

BadStateException

if the current state is not REPLIED

MessageState Inspirel.YAMI.OutgoingMessage.State [get]

Gets the current state of the message.

MessageStateInfo Inspirel.YAMI.OutgoingMessage.StateInfo [get]

Gets the current state and information about the message progress.

---

The documentation for this class was generated from the following file:

• src/OutgoingMessage.cs