Inspirel.YAMI.Agent.OutgoingFlowState Class Reference

Helper class for returning the state of outgoing flow. More...

List of all members.

Properties
int	CurrentLevel [get]
	Gets number of currently queued outgoing messages waiting for send.
int	HighWaterMark [get]
	Gets upper limit of queued outgoing messages.
int	LowWaterMark [get]
	Gets the "low water mark" limit.

---

Detailed Description

Helper class for returning the state of outgoing flow.

---

Property Documentation

int Inspirel.YAMI.Agent.OutgoingFlowState.CurrentLevel [get]

Gets number of currently queued outgoing messages waiting for send.

int Inspirel.YAMI.Agent.OutgoingFlowState.HighWaterMark [get]

Gets upper limit of queued outgoing messages.

If this limit is reached, further attempts to send the message are suppressed (that is, the user code is blocked) until the queues are consumed to the level defined by LowWaterMark.

int Inspirel.YAMI.Agent.OutgoingFlowState.LowWaterMark [get]

Gets the "low water mark" limit.

CurrentLevel should be lower than LowWaterMark to resume user code execution after reaching HighWaterMark limit.

---

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

• src/Agent.cs