/usr/include/sipxtapi/ptapi/PtConfigDb.h is in libsipxtapi-dev 3.3.0~test17-2.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 | //
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PtConfigDb_h_
#define _PtConfigDb_h_
// SYSTEM INCLUDES
#include <stdio.h>
// APPLICATION INCLUDES
#include "PtDefs.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
//:Configuration database containing key/value pairs.
// This class maintains a dictionary of key/value pairs.
class PtConfigDb
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */
PtConfigDb();
//:Default constructor
virtual
~PtConfigDb();
//:Destructor
/* ============================ MANIPULATORS ============================== */
PtStatus loadFromFile(FILE* fp);
//:Load the configuration database from a file
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus storeToFile(FILE* fp);
//:Store the config database to a file
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus remove(const char* pKey);
//:Remove the key/value pair associated with pKey.
//!param: pKey - The key for the key/value pair to be removed
//!retcode: PT_SUCCESS - Success
//!retcode: PT_NOT_FOUND - The key was not found
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus set(const char* pKey, const char* pNewValue);
//:Insert the key/value pair into the config database.
// If the database already contains an entry for this key, then
// set the value for the existing entry to pNewValue.
//!param: pKey - The key for the key/value pair being added (or modified)
//!param: pNewValue - The new value for the key/value pair being added (or modified)
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ ACCESSORS ================================= */
PtStatus get(const char* pKey, char*& rpValue);
//:Sets <i>rpValue</i> to point to the value in the database
//:associated with <i>pKey</i>.
// If pKey is found in the database, returns PT_SUCCESS. Otherwise,
// returns PT_NOT_FOUND and sets rpValue to point to an empty string.
//!param: pKey - The lookup key
//!param: rpValue - Set to point to the value corresponding to <i>pKey</i>
//!retcode: PT_SUCCESS - Success
//!retcode: PT_NOT_FOUND - The key was not found
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus get(const char* pKey, int& rValue);
//:Sets <i>rValue</i> to the integer value in the database associated
//:with <i>pKey</i>.
// If pKey is found in the database, returns PT_SUCCESS. Otherwise,
// returns PT_NOT_FOUND and sets rValue to -1.
//!param: pKey - The lookup key
//!param: rValue - Set to the integer value corresponding to <i>pKey</i>
//!retcode: PT_SUCCESS - Success
//!retcode: PT_NOT_FOUND - The key was not found
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus getNext(const char* pKey,
char*& rpNextKey, char*& rpNextValue);
//:Relative to <i>pKey</i>, sets <i>rpNextKey</i> and
//:<i>rpNextValue</i> to point to the key and value associated with
//:next (lexicographically ordered) key/value pair stored in the
//:database.
// If pKey is the empty string, the key and value associated
// with the first entry in the database will be returned.
//!param: pKey - The lookup key
//!param: rpNextKey - Set to point to the key for the next key/value pair stored in the database
//!param: rpNextValue - Set to point to the value for the next key/value pair stored in the database
//!retcode: PT_SUCCESS - Success
//!retcode: PT_NO_MORE_DATA - There is no "next" entry
//!retcode: PT_NOT_FOUND - The key was not found
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ INQUIRY =================================== */
PtStatus isEmpty(PtBoolean& rIsEmpty);
//:Sets <i>rIsEmpty</i> to TRUE if the database is empty, otherwise
//:FALSE.
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
PtStatus numEntries(int& rNumEntries);
//:Sets <i>rNumEntries</i> to the number of entries in the config database
//!retcode: PT_SUCCESS - Success
//!retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
};
/* ============================ INLINE METHODS ============================ */
#endif // _PtConfigDb_h_
|