/usr/include/mama/statscollector.h is in libmama-dev 2.2.2.1-11.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef MamaStatsCollectorH__
#define MamaStatsCollectorH__
#include "mama/status.h"
#if defined(__cplusplus)
extern "C" {
#endif
typedef enum mamaStatsCollectorType
{
MAMA_STATS_COLLECTOR_TYPE_QUEUE = 0,
MAMA_STATS_COLLECTOR_TYPE_TRANSPORT = 1,
MAMA_STATS_COLLECTOR_TYPE_USER = 2,
MAMA_STATS_COLLECTOR_TYPE_GLOBAL = 3
} mamaStatsCollectorType;
/**
* Create a mamaStatsCollector object
*
* @param statsCollector The stats collector object to create
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_create (mamaStatsCollector* statsCollector, mamaStatsCollectorType type, const char* name, const char* middleware);
/**
* Destroy a mamaStatsCollector object
*
* @param statsCollector The stats collector object to destroy
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_destroy (mamaStatsCollector statsCollector);
/**
* Register a stats object with the collector
*
* @param statscollector The stats collector object to register with
* @param stat The stat object to register
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_addStat (mamaStatsCollector statsCollector, mamaStat stat);
/**
* Increment the current interval value of the stat represented
* by FID identifier
*
* @param statscollector The stats collector object for which to increment the stat
* @param identifier FID of the stat to increment
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_incrementStat (mamaStatsCollector statsCollector, mama_fid_t identifier);
/**
* Set the name of the stats collector object. By default, this will be
* the same as the associated queue, transport, or MAMA Application.
*
* @param statscollector The stats collector object for which to set the name
* @param name The name to set for the stats collector
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_setName (mamaStatsCollector statsCollector, const char* name);
/**
* Set whether or not stats for this stats collector object should be
* published in stats messages.
*
* @param statscollector The stats collector object to set publishing for
* @param publish Whether or not to publish stats for this stats collector
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_setPublish (mamaStatsCollector statsCollector, int publish);
/**
* Get whether or not stats are being published for this stats collector.
*
* @param statscollector The stats collector object to get publishing for
*/
MAMAExpDLL
extern int
mamaStatsCollector_getPublish (mamaStatsCollector statsCollector);
/**
* Set whether or not stats for this stats collector object should be
* logged to the MAMA log.
*
* @param statscollector The stats collector object to set logging for
* @param log Whether or not to log stats for this stats collector
*/
MAMAExpDLL
extern mama_status
mamaStatsCollector_setLog (mamaStatsCollector statsCollector, int log);
/**
* Get whether or not stats are being logged for this stats collector.
*
* @param statscollector The stats collector object to get logging for.
*/
MAMAExpDLL
extern int
mamaStatsCollector_getLog (mamaStatsCollector statsCollector);
/**
* Return a string representation of a mamaStatsCollectorType
*
* @param type The stats collector type to return as a string
*/
MAMAExpDLL
extern const char*
mamaStatsCollectorType_stringForType (mamaStatsCollectorType type);
#if defined(__cplusplus)
}
#endif
#endif /* MamaStatsCollectorH__ */
|