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.IMessageQueue Interface Reference

Interface that defines members necessary for a message queue. More...

Inherits PreEmptive.Analytics.Common.IMessageDequeuer.

Inherited by PreEmptive.Analytics.Common.MessageQueue.

Public Member Functions

void Start ()
 A thread safe way to start the message queue and prepare it for accepting messages. More...
 
void Stop ()
 A thread safe way to halt the message queue. More...
 
void Queue (Message message)
 A thread safe way of adding messages. More...
 
void SendDisabledChanged (bool stop)
 A thread safe way of enabling or disabling the sending of messages. More...
 
void SendMessages ()
 A manual way to send messages that have been queued. More...
 
- Public Member Functions inherited from PreEmptive.Analytics.Common.IMessageDequeuer
IList< MessageDequeueMessages ()
 A thread safe way of removing messages for sending. More...
 
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

bool Stopped [get]
 If the queue has been stopped. More...
 

Detailed Description

Interface that defines members necessary for a message queue.

Member Function Documentation

void PreEmptive.Analytics.Common.IMessageQueue.Queue ( Message  message)

A thread safe way of adding messages.

Parameters
messageThe message object to add.

Implemented in PreEmptive.Analytics.Common.MessageQueue.

void PreEmptive.Analytics.Common.IMessageQueue.SendDisabledChanged ( bool  stop)

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

Parameters
stopShould the sending of messages be stopped.

Implemented in PreEmptive.Analytics.Common.MessageQueue.

void PreEmptive.Analytics.Common.IMessageQueue.SendMessages ( )

A manual way to send messages that have been queued.

Implemented in PreEmptive.Analytics.Common.MessageQueue.

void PreEmptive.Analytics.Common.IMessageQueue.Start ( )

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

Implemented in PreEmptive.Analytics.Common.MessageQueue.

void PreEmptive.Analytics.Common.IMessageQueue.Stop ( )

A thread safe way to halt the message queue.

Implemented in PreEmptive.Analytics.Common.MessageQueue.

Property Documentation

bool PreEmptive.Analytics.Common.IMessageQueue.Stopped
get

If the queue has been stopped.


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