statslogger.h File Reference

#include <mama/status.h>
#include <mama/types.h>

Go to the source code of this file.

Macros
#define	SL_TOPIC_USAGE_LOG   "SL_TOPIC_USAGE_LOG"
#define	STATS_TOPIC   "STATS_TOPIC"

Typedefs
typedef enum mamaSlEvent_	mamaSlEvent
	The event types handled by the stats logger. More...
typedef enum mamaSlSubFailReason_	mamaSlSubFailReason
	The reasons for a subscription to fail. More...

Enumerations
enum	mamaSlEvent_ {   MAMA_SL_EVENT_LOGIN = 0, MAMA_SL_EVENT_LOGOUT = 1, MAMA_SL_EVENT_SUB_CREATE = 2, MAMA_SL_EVENT_SUB_FAIL = 3,   MAMA_SL_EVENT_SUB_DESTROY = 4, MAMA_SL_EVENT_SUB_ENT_PASS = 5 }
	The event types handled by the stats logger. More...
enum	mamaSlSubFailReason_ { MAMA_SL_SUB_FAIL_REGEX = 0, MAMA_SL_SUB_FAIL_CODE = 1, MAMA_SL_SUB_FAIL_TIMEOUT = 2, MAMA_SL_SUB_FAIL_NOT_FOUND = 3 }
	The reasons for a subscription to fail. More...

Functions
const MAMAExpDLL char *	mamaStatsLogger_eventToString (mamaSlEvent event)
	Convert a mamaSlEvent value to a string. More...
const MAMAExpDLL char *	mamaStatsLogger_subFailReasonToString (mamaSlSubFailReason subFailReason)
	Convert a mamaSlSubFailReason value to a string. More...
MAMAExpDLL mama_status	mamaStatsLogger_allocate (mamaStatsLogger *logger)
	Allocate memory for a new stats logger. More...
MAMAExpDLL mama_status	mamaStatsLogger_create (mamaStatsLogger logger, mamaQueue queue, mamaTransport tport)
	Create and activate mamaStatsLogger object. More...
MAMAExpDLL mama_status	mamaStatsLogger_createForStats (mamaStatsLogger logger, mamaQueue queue, mamaTransport tport, const char *topic)
MAMAExpDLL mama_status	mamaStatsLogger_destroy (mamaStatsLogger logger)
	Destroy a mamaStatsLogger object, freeing any memory. More...
MAMAExpDLL mama_status	mamaStatsLogger_setReportInterval (mamaStatsLogger logger, mama_f64_t interval)
	Set the reporting interval. More...
MAMAExpDLL mama_status	mamaStatsLogger_setReportSize (mamaStatsLogger logger, mama_size_t numEvents)
	Set the maximum number of events to cache before reporting. More...
MAMAExpDLL mama_status	mamaStatsLogger_setUserName (mamaStatsLogger logger, const char *userName)
	Set the userName. More...
MAMAExpDLL mama_status	mamaStatsLogger_getUserName (const mamaStatsLogger logger, const char **userName)
	Get the userName. More...
MAMAExpDLL mama_status	mamaStatsLogger_setHostName (mamaStatsLogger logger, const char *hostName)
	Set the hostName. More...
MAMAExpDLL mama_status	mamaStatsLogger_getHostName (const mamaStatsLogger logger, const char **hostName)
	Get the hostName. More...
MAMAExpDLL mama_status	mamaStatsLogger_setApplicationName (mamaStatsLogger logger, const char *appName)
	Set the applicationName. More...
MAMAExpDLL mama_status	mamaStatsLogger_getApplicationName (const mamaStatsLogger logger, const char **appName)
	Get the applicationName. More...
MAMAExpDLL mama_status	mamaStatsLogger_setApplicationClass (mamaStatsLogger logger, const char *applClass)
	Set the applicationClass. More...
MAMAExpDLL mama_status	mamaStatsLogger_getApplicationClass (const mamaStatsLogger logger, const char **appClass)
	Get the applicationClass. More...
MAMAExpDLL mama_status	mamaStatsLogger_setIpAddress (mamaStatsLogger logger, const char *ipAddress)
	Set the ipAddress. More...
MAMAExpDLL mama_status	mamaStatsLogger_getIpAddress (const mamaStatsLogger logger, const char **ipAddress)
	Get the ipAddress. More...
MAMAExpDLL mama_status	mamaStatsLogger_logLogin (mamaStatsLogger logger)
	Log a login event. More...
MAMAExpDLL mama_status	mamaStatsLogger_logLogout (mamaStatsLogger logger)
	Log a logout event. More...
MAMAExpDLL mama_status	mamaStatsLogger_logSubscriptionEntitlePass (mamaStatsLogger logger, mamaSubscription subscription, int32_t entitleCode)
	Log a subscription entitlement check pass event. More...
MAMAExpDLL mama_status	mamaStatsLogger_logSubscriptionFail (mamaStatsLogger logger, mamaSubscription subscription, mamaSlSubFailReason reason)
	Log a subscription fail event. More...
MAMAExpDLL mama_status	mamaStatsLogger_logSubscriptionDestroy (mamaStatsLogger logger, mamaSubscription subscription)
	Log a subscription destroy event. More...
MAMAExpDLL mama_status	mamaStatsLogger_addStatMsg (mamaStatsLogger *logger, mamaMsg msg)
MAMAExpDLL mama_status	mamaStatsLogger_sendReport (mamaStatsLogger *logger)
MAMAExpDLL mama_status	mamaStatsLogger_getLogMsgStats (mamaStatsLogger logger, mama_bool_t *logMsgStats)
MAMAExpDLL mama_status	mamaStatsLogger_setLogMsgStats (mamaStatsLogger logger, mama_bool_t logMsgStats)
MAMAExpDLL mama_status	mamaStatsLogger_incMsgCount (mamaStatsLogger statsLogger)

Macro Definition Documentation

SL_TOPIC_USAGE_LOG

#define SL_TOPIC_USAGE_LOG   "SL_TOPIC_USAGE_LOG"

STATS_TOPIC

#define STATS_TOPIC   "STATS_TOPIC"

Typedef Documentation

mamaSlEvent

typedef enum mamaSlEvent_ mamaSlEvent

The event types handled by the stats logger.

mamaSlSubFailReason

typedef enum mamaSlSubFailReason_ mamaSlSubFailReason

The reasons for a subscription to fail.

Enumeration Type Documentation

mamaSlEvent_

enum mamaSlEvent_

The event types handled by the stats logger.

Enumerator
MAMA_SL_EVENT_LOGIN
MAMA_SL_EVENT_LOGOUT
MAMA_SL_EVENT_SUB_CREATE
MAMA_SL_EVENT_SUB_FAIL
MAMA_SL_EVENT_SUB_DESTROY
MAMA_SL_EVENT_SUB_ENT_PASS

{
    MAMA_SL_EVENT_LOGIN         = 0,
    MAMA_SL_EVENT_LOGOUT        = 1,
    MAMA_SL_EVENT_SUB_CREATE    = 2,
    MAMA_SL_EVENT_SUB_FAIL      = 3,
    MAMA_SL_EVENT_SUB_DESTROY   = 4,
    MAMA_SL_EVENT_SUB_ENT_PASS  = 5
} mamaSlEvent;

mamaSlSubFailReason_

enum mamaSlSubFailReason_

The reasons for a subscription to fail.

Enumerator
MAMA_SL_SUB_FAIL_REGEX
MAMA_SL_SUB_FAIL_CODE
MAMA_SL_SUB_FAIL_TIMEOUT
MAMA_SL_SUB_FAIL_NOT_FOUND

{
    MAMA_SL_SUB_FAIL_REGEX      = 0,
    MAMA_SL_SUB_FAIL_CODE       = 1,
    MAMA_SL_SUB_FAIL_TIMEOUT    = 2,
    MAMA_SL_SUB_FAIL_NOT_FOUND  = 3
} mamaSlSubFailReason;

Function Documentation

mamaStatsLogger_eventToString()

const MAMAExpDLL char* mamaStatsLogger_eventToString

(

mamaSlEvent

event

)

Convert a mamaSlEvent value to a string.

Do no attempt to free the string result.

Parameters

event

The mamaSlEvent to convert.

mamaStatsLogger_subFailReasonToString()

const MAMAExpDLL char* mamaStatsLogger_subFailReasonToString

(

mamaSlSubFailReason

subFailReason

)

Convert a mamaSlSubFailReason value to a string.

Do no attempt to free the string result.

Parameters

subFailReason

The mamaSlSubFailReason to convert.

mamaStatsLogger_allocate()

MAMAExpDLL mama_status mamaStatsLogger_allocate

(

mamaStatsLogger *

logger

)

Allocate memory for a new stats logger.

The logger is not actually created until a call the create() functions is made. Memory must be freed using the mamaStatsLogger_Deallocate() function.

Parameters

logger

Where the address of the new logger will be written

mamaStatsLogger_create()

MAMAExpDLL mama_status mamaStatsLogger_create	(	mamaStatsLogger	logger,
		mamaQueue	queue,
		mamaTransport	tport
	)

Create and activate mamaStatsLogger object.

Parameters

logger	The location of a mamaStatsLogger
queue	The queue for the Stats Logger to use for publishing
tport	the transport

mamaStatsLogger_createForStats()

MAMAExpDLL mama_status mamaStatsLogger_createForStats	(	mamaStatsLogger	logger,
		mamaQueue	queue,
		mamaTransport	tport,
		const char *	topic
	)

mamaStatsLogger_destroy()

MAMAExpDLL mama_status mamaStatsLogger_destroy

(

mamaStatsLogger

logger

)

Destroy a mamaStatsLogger object, freeing any memory.

Parameters

logger

The location of a mamaStatsLogger

mamaStatsLogger_setReportInterval()

MAMAExpDLL mama_status mamaStatsLogger_setReportInterval	(	mamaStatsLogger	logger,
		mama_f64_t	interval
	)

Set the reporting interval.

Parameters

logger	The location of a mamaStatsLogger
interval	The report interval in seconds

mamaStatsLogger_setReportSize()

MAMAExpDLL mama_status mamaStatsLogger_setReportSize	(	mamaStatsLogger	logger,
		mama_size_t	numEvents
	)

Set the maximum number of events to cache before reporting.

Parameters

logger	The location of a mamaStatsLogger
numEvents	The number of events to report after

mamaStatsLogger_setUserName()

MAMAExpDLL mama_status mamaStatsLogger_setUserName	(	mamaStatsLogger	logger,
		const char *	userName
	)

Set the userName.

Parameters

logger	The logger object to update.
userName	The user name for the logger

mamaStatsLogger_getUserName()

MAMAExpDLL mama_status mamaStatsLogger_getUserName	(	const mamaStatsLogger	logger,
		const char **	userName
	)

Get the userName.

Parameters

logger	The logger object to check.
userName	Location of the result for the description of the logger.

mamaStatsLogger_setHostName()

MAMAExpDLL mama_status mamaStatsLogger_setHostName	(	mamaStatsLogger	logger,
		const char *	hostName
	)

Set the hostName.

Parameters

logger	The logger object to update.
hostName	The host name for the logger

mamaStatsLogger_getHostName()

MAMAExpDLL mama_status mamaStatsLogger_getHostName	(	const mamaStatsLogger	logger,
		const char **	hostName
	)

Get the hostName.

Parameters

logger	The logger object to check.
hostName	Location of the result for the description of the logger.

mamaStatsLogger_setApplicationName()

MAMAExpDLL mama_status mamaStatsLogger_setApplicationName	(	mamaStatsLogger	logger,
		const char *	appName
	)

Set the applicationName.

Parameters

logger	The logger object to update.
appName	The applicationName for the logger

mamaStatsLogger_getApplicationName()

MAMAExpDLL mama_status mamaStatsLogger_getApplicationName	(	const mamaStatsLogger	logger,
		const char **	appName
	)

Get the applicationName.

Parameters

logger	The logger object to check.
appName	Location of the result for the applicationName

mamaStatsLogger_setApplicationClass()

MAMAExpDLL mama_status mamaStatsLogger_setApplicationClass	(	mamaStatsLogger	logger,
		const char *	applClass
	)

Set the applicationClass.

Parameters

logger	The logger object to update.
applClass	The applicationName for the logger

mamaStatsLogger_getApplicationClass()

MAMAExpDLL mama_status mamaStatsLogger_getApplicationClass	(	const mamaStatsLogger	logger,
		const char **	appClass
	)

Get the applicationClass.

Parameters

logger	The logger object to check.
appClass	Location of the result for the applicationClass

mamaStatsLogger_setIpAddress()

MAMAExpDLL mama_status mamaStatsLogger_setIpAddress	(	mamaStatsLogger	logger,
		const char *	ipAddress
	)

Set the ipAddress.

Parameters

logger	The logger object to update.
ipAddress	The ipAddress for the logger

mamaStatsLogger_getIpAddress()

MAMAExpDLL mama_status mamaStatsLogger_getIpAddress	(	const mamaStatsLogger	logger,
		const char **	ipAddress
	)

Get the ipAddress.

Parameters

logger	The logger object to check.
ipAddress	Location of the result for the ipAddress of the logger.

mamaStatsLogger_logLogin()

MAMAExpDLL mama_status mamaStatsLogger_logLogin

(

mamaStatsLogger

logger

)

Log a login event.

Parameters

logger

The logger object to use.

mamaStatsLogger_logLogout()

MAMAExpDLL mama_status mamaStatsLogger_logLogout

(

mamaStatsLogger

logger

)

Log a logout event.

Parameters

logger

The logger object to use.

mamaStatsLogger_logSubscriptionEntitlePass()

MAMAExpDLL mama_status mamaStatsLogger_logSubscriptionEntitlePass	(	mamaStatsLogger	logger,
		mamaSubscription	subscription,
		int32_t	entitleCode
	)

Log a subscription entitlement check pass event.

Parameters

logger	The logger object to use.
subscription	the subscription
entitleCode	the entitlement code

mamaStatsLogger_logSubscriptionFail()

MAMAExpDLL mama_status mamaStatsLogger_logSubscriptionFail	(	mamaStatsLogger	logger,
		mamaSubscription	subscription,
		mamaSlSubFailReason	reason
	)

Log a subscription fail event.

Parameters

logger	The logger object to use.
subscription	the subscription
reason	the reason

mamaStatsLogger_logSubscriptionDestroy()

MAMAExpDLL mama_status mamaStatsLogger_logSubscriptionDestroy	(	mamaStatsLogger	logger,
		mamaSubscription	subscription
	)

Log a subscription destroy event.

Parameters

logger	The logger object to use.
subscription	the subscription

mamaStatsLogger_addStatMsg()

MAMAExpDLL mama_status mamaStatsLogger_addStatMsg	(	mamaStatsLogger *	logger,
		mamaMsg	msg
	)

mamaStatsLogger_sendReport()

MAMAExpDLL mama_status mamaStatsLogger_sendReport

(

mamaStatsLogger *

logger

)

mamaStatsLogger_getLogMsgStats()

MAMAExpDLL mama_status mamaStatsLogger_getLogMsgStats	(	mamaStatsLogger	logger,
		mama_bool_t *	logMsgStats
	)

mamaStatsLogger_setLogMsgStats()

MAMAExpDLL mama_status mamaStatsLogger_setLogMsgStats	(	mamaStatsLogger	logger,
		mama_bool_t	logMsgStats
	)

mamaStatsLogger_incMsgCount()

MAMAExpDLL mama_status mamaStatsLogger_incMsgCount

(

mamaStatsLogger

statsLogger

)