AMPS.Client.MessageStream Class Reference

Allows iteration over the messages in an AMPS SOW cache, or over the stream of messages on a subscription, or both. More...

Inheritance diagram for AMPS.Client.MessageStream:

Public Member Functions
MessageStream	timeout (int timeout_)
	Sets a timeout on this message stream. If no message is received with this timeout, forward iteration returns null for the next message. More...
MessageStream	conflate ()
	Causes messages on a SOW topic to be conflated by their SOW key, so that when messages are consumed the latest value for each distinct key is returned instead of every message. More...
MessageStream	maxDepth (int maxQueueDepth_)
	Bounds the internal queue of this stream to a specified count of messages. If the consumer of this stream does not process messages in a timely fashion and this internal queue limit is reached, the AMPS client will not respond to incoming messages including acknowledgements and may become disconnected. More...
int	getMaxDepth ()
	Returns the current maximum queue depth before pushing back on the receive thread. More...
int	getDepth ()
	Returns the curent count of messages queued in the MessageStream. More...
void	Dispose ()
void	close ()
bool	MoveNext ()
void	Reset ()
IEnumerator< Message >	GetEnumerator ()

Properties
Message	Current [get]

Detailed Description

Allows iteration over the messages in an AMPS SOW cache, or over the stream of messages on a subscription, or both.

Member Function Documentation

conflate()

MessageStream AMPS.Client.MessageStream.conflate ( )

inline

Causes messages on a SOW topic to be conflated by their SOW key, so that when messages are consumed the latest value for each distinct key is returned instead of every message.

Returns

This instance

getDepth()

int AMPS.Client.MessageStream.getDepth ( )

inline

Returns the curent count of messages queued in the MessageStream.

Returns

The current number of messages queued in the stream.

getMaxDepth()

int AMPS.Client.MessageStream.getMaxDepth ( )

inline

Returns the current maximum queue depth before pushing back on the receive thread.

Returns

The internal queue depth limit, default is In32.MaxValue.

maxDepth()

MessageStream AMPS.Client.MessageStream.maxDepth ( int  maxQueueDepth_ )

inline

Bounds the internal queue of this stream to a specified count of messages. If the consumer of this stream does not process messages in a timely fashion and this internal queue limit is reached, the AMPS client will not respond to incoming messages including acknowledgements and may become disconnected.

Parameters

maxQueueDepth_

The internal queue depth limit (default: unlimited)

Returns

This instance

Reset()

void AMPS.Client.MessageStream.Reset ( )

inline

This is a forward only, one time iterator and cannot be reset.

timeout()

MessageStream AMPS.Client.MessageStream.timeout ( int  timeout_ )

inline

Sets a timeout on this message stream. If no message is received with this timeout, forward iteration returns null for the next message.

Parameters

timeout_

The timeout value in milliseconds.

Returns

This instance.

---

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

• AMPS.Client/MessageStream.cs