PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
PreEmptive.Analytics.Common.MessageQueue Class Reference

Class that handles the incoming messages. More...

Inherits PreEmptive.Analytics.Common.IMessageQueue.

Public Member Functions

 MessageQueue (IClientToolsProvider client, IFlowController flowController)
 Constructor for the MessageQueue. More...
 
virtual void Start ()
 A thread safe way to start the message queue and prepare it for accepting messages. More...
 
virtual void Stop ()
 A thread safe way to halt the message queue. More...
 
virtual void Queue (Message message)
 A thread safe way of adding messages. More...
 
virtual void SendDisabledChanged (bool stop)
 A thread safe way of enabling or disabling the sending of messages. More...
 
virtual void SendMessages ()
 A manual way to send messages that have been queued. More...
 
virtual IList< MessageDequeueMessages ()
 A thread safe way of removing messages for sending. More...
 
virtual IList< MessagePeekMessages ()
 Makes a clone of the list holding the messages and returns the copy of the list of messages Unlike Dequeing, this does not consume the messages returned. More...
 

Properties

IList< MessageMessages [get, set]
 An IList of queued Messages. More...
 
bool Stopped [get, set]
 If the queue has been stopped. More...
 
virtual IQueueTransmitter TransmitterThread [get]
 The transmitter thread being used by the MessageQueue More...
 
virtual IQueuePersister OfflineStorageThread [get]
 The offline storage thread being used by the MessageQueue More...
 
- Properties inherited from PreEmptive.Analytics.Common.IMessageQueue
bool Stopped [get]
 If the queue has been stopped. More...
 

Detailed Description

Class that handles the incoming messages.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.MessageQueue.MessageQueue ( IClientToolsProvider  client,
IFlowController  flowController 
)

Constructor for the MessageQueue.

Parameters
clientThe instance of the CoreClient with settings to be used by the message queue.
flowControllerThe IFlowController instance that determines the behavior of the message queue.

Member Function Documentation

virtual IList<Message> PreEmptive.Analytics.Common.MessageQueue.DequeueMessages ( )
virtual

A thread safe way of removing messages for sending.

Returns
The messages that have been removed

Implements PreEmptive.Analytics.Common.IMessageDequeuer.

virtual IList<Message> PreEmptive.Analytics.Common.MessageQueue.PeekMessages ( )
virtual

Makes a clone of the list holding the messages and returns the copy of the list of messages Unlike Dequeing, this does not consume the messages returned.

Returns
The messages currently in the queue

Implements PreEmptive.Analytics.Common.IMessageDequeuer.

virtual void PreEmptive.Analytics.Common.MessageQueue.Queue ( Message  message)
virtual

A thread safe way of adding messages.

Parameters
messageThe message object to add.

Implements PreEmptive.Analytics.Common.IMessageQueue.

virtual void PreEmptive.Analytics.Common.MessageQueue.SendDisabledChanged ( bool  stop)
virtual

A thread safe way of enabling or disabling the sending of messages.

Parameters
stopShould the sending of messages be stopped.

Implements PreEmptive.Analytics.Common.IMessageQueue.

virtual void PreEmptive.Analytics.Common.MessageQueue.SendMessages ( )
virtual

A manual way to send messages that have been queued.

Implements PreEmptive.Analytics.Common.IMessageQueue.

virtual void PreEmptive.Analytics.Common.MessageQueue.Start ( )
virtual

A thread safe way to start the message queue and prepare it for accepting messages.

Implements PreEmptive.Analytics.Common.IMessageQueue.

virtual void PreEmptive.Analytics.Common.MessageQueue.Stop ( )
virtual

A thread safe way to halt the message queue.

Implements PreEmptive.Analytics.Common.IMessageQueue.

Property Documentation

IList<Message> PreEmptive.Analytics.Common.MessageQueue.Messages
getsetprotected

An IList of queued Messages.

virtual IQueuePersister PreEmptive.Analytics.Common.MessageQueue.OfflineStorageThread
get

The offline storage thread being used by the MessageQueue

bool PreEmptive.Analytics.Common.MessageQueue.Stopped
getset

If the queue has been stopped.

virtual IQueueTransmitter PreEmptive.Analytics.Common.MessageQueue.TransmitterThread
get

The transmitter thread being used by the MessageQueue


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