OpenMAMA
Wombat::MamdaNewsManager Class Reference

MamdaNewsManager provides a class for managing access to streaming news headlines, headline queries, individual story queries, etc. More...

#include <MamdaNewsManager.h>

Public Member Functions

 MamdaNewsManager ()
 
virtual ~MamdaNewsManager ()
 
void addBroadcastHeadlineSource (MamaQueue *queue, MamaSource *source, const char *symbol, void *closure)
 Add a broadcast headline source to the news manager. More...
 
void clearBroadcastHeadlineSources ()
 Remove all broadcast headline sources from the news manager. More...
 
void addBroadcastStorySource (MamaQueue *queue, MamaSource *source, const char *symbol, void *closure)
 Add a broadcast story source to the news manager. More...
 
void clearBroadcastStorySources ()
 Remove all broadcast story sources from the news manager. More...
 
void addBroadcastHeadlineHandler (MamdaNewsHeadlineHandler *handler)
 Add a headline handler for broadcast headlines. More...
 
void addBroadcastStoryHandler (MamdaNewsStoryHandler *handler)
 Add a story handler for broadcast stories. More...
 
void addQualityHandler (MamdaQualityListener *handler)
 Add a quality data handler. More...
 
void addErrorHandler (MamdaErrorListener *handler)
 Add an error handler. More...
 
void clearQuerySources ()
 
void executeQuery (MamaQueue *queue, MamaSource *source, MamdaQuery *newsQuery, MamdaNewsQueryType queryType, MamdaNewsQueryHandler *handler, void *closure)
 Request a story (by headline), invoking the given story handler when the story arrives (or not). More...
 
void removeQuery (MamdaQuery *newsQuery)
 
void requestStory (const MamdaNewsHeadline &headline, MamdaNewsStoryHandler *handler, void *closure)
 Request a story (by headline), invoking the given story handler when the story arrives (or not). More...
 
void requestStory (MamaQueue *queue, MamaSource *source, MamdaNewsStoryId storyId, MamdaNewsStoryHandler *handler, void *closure)
 Request a story (by explicit headline ID, source and queue), invoking the given story handler when the story arrives (or not). More...
 
void requestStoryLater (const MamdaNewsHeadline &headline, MamdaNewsStoryHandler *handler, double secondsLater, void *closure)
 Request a story (by headline) after some delay, invoking the given story handler when the story arrives (or not). More...
 
void requestStoryLater (const MamdaNewsStory &story, MamdaNewsStoryHandler *handler, double secondsLater, void *closure)
 Request a story (by existing or partial story) after some delay, invoking the given story handler when the story arrives (or not). More...
 
void requestStoryLater (MamaQueue *queue, MamaSource *source, MamdaNewsStoryId storyId, MamdaNewsStoryHandler *handler, double secondsLater, void *closure)
 Request a story (by headline) after some delay, invoking the given story handler when the story arrives (or not). More...
 

Public Attributes

MamdaNewsManagerImpl & mImpl
 

Detailed Description

MamdaNewsManager provides a class for managing access to streaming news headlines, headline queries, individual story queries, etc.

Like the MAMDA "listener" classes, such as MamdaQuoteListener and MamdaTradeListener, the MamdaNewsManager cache certain information about the news service. Unlike those MAMDA "listener" classes, the MamdaNewsManager is also responsible for creating and managing its own subscriptions.

Constructor & Destructor Documentation

Wombat::MamdaNewsManager::MamdaNewsManager ( )
virtual Wombat::MamdaNewsManager::~MamdaNewsManager ( )
virtual

Member Function Documentation

void Wombat::MamdaNewsManager::addBroadcastHeadlineSource ( MamaQueue *  queue,
MamaSource *  source,
const char *  symbol,
void *  closure 
)

Add a broadcast headline source to the news manager.

Headline updates will be passed to the handler(s) registered by addBroadcastHeadlineHandler().

void Wombat::MamdaNewsManager::clearBroadcastHeadlineSources ( )

Remove all broadcast headline sources from the news manager.

void Wombat::MamdaNewsManager::addBroadcastStorySource ( MamaQueue *  queue,
MamaSource *  source,
const char *  symbol,
void *  closure 
)

Add a broadcast story source to the news manager.

Stories will be passed to the handler(s) registered by addBroadcastStoryHandler().

void Wombat::MamdaNewsManager::clearBroadcastStorySources ( )

Remove all broadcast story sources from the news manager.

void Wombat::MamdaNewsManager::addBroadcastHeadlineHandler ( MamdaNewsHeadlineHandler handler)

Add a headline handler for broadcast headlines.

void Wombat::MamdaNewsManager::addBroadcastStoryHandler ( MamdaNewsStoryHandler handler)

Add a story handler for broadcast stories.

void Wombat::MamdaNewsManager::addQualityHandler ( MamdaQualityListener handler)

Add a quality data handler.

void Wombat::MamdaNewsManager::addErrorHandler ( MamdaErrorListener handler)

Add an error handler.

void Wombat::MamdaNewsManager::clearQuerySources ( )
void Wombat::MamdaNewsManager::executeQuery ( MamaQueue *  queue,
MamaSource *  source,
MamdaQuery newsQuery,
MamdaNewsQueryType  queryType,
MamdaNewsQueryHandler handler,
void *  closure 
)

Request a story (by headline), invoking the given story handler when the story arrives (or not).

void Wombat::MamdaNewsManager::removeQuery ( MamdaQuery newsQuery)
void Wombat::MamdaNewsManager::requestStory ( const MamdaNewsHeadline headline,
MamdaNewsStoryHandler handler,
void *  closure 
)

Request a story (by headline), invoking the given story handler when the story arrives (or not).

void Wombat::MamdaNewsManager::requestStory ( MamaQueue *  queue,
MamaSource *  source,
MamdaNewsStoryId  storyId,
MamdaNewsStoryHandler handler,
void *  closure 
)

Request a story (by explicit headline ID, source and queue), invoking the given story handler when the story arrives (or not).

The source and queue are the same parameters that correspond to the headline source (see addHeadlineSource()).

void Wombat::MamdaNewsManager::requestStoryLater ( const MamdaNewsHeadline headline,
MamdaNewsStoryHandler handler,
double  secondsLater,
void *  closure 
)

Request a story (by headline) after some delay, invoking the given story handler when the story arrives (or not).

void Wombat::MamdaNewsManager::requestStoryLater ( const MamdaNewsStory story,
MamdaNewsStoryHandler handler,
double  secondsLater,
void *  closure 
)

Request a story (by existing or partial story) after some delay, invoking the given story handler when the story arrives (or not).

void Wombat::MamdaNewsManager::requestStoryLater ( MamaQueue *  queue,
MamaSource *  source,
MamdaNewsStoryId  storyId,
MamdaNewsStoryHandler handler,
double  secondsLater,
void *  closure 
)

Request a story (by headline) after some delay, invoking the given story handler when the story arrives (or not).

Member Data Documentation

MamdaNewsManagerImpl& Wombat::MamdaNewsManager::mImpl

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


© 2012 Linux Foundation