/usr/include/opal/iax2/safestrings.h is in libopal-dev 3.10.10~dfsg2-2+b2.
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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | /*
*
*
* Inter Asterisk Exchange 2
*
* Provide string list handling in a thread safe fashion.
*
* Open Phone Abstraction Library (OPAL)
*
* Copyright (c) 2005 Indranet Technologies Ltd.
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Open Phone Abstraction Library.
*
* The Initial Developer of the Original Code is Indranet Technologies Ltd.
*
* The author of this code is Derek J Smithies
*
* $Revision: 24606 $
* $Author: dereksmithies $
* $Date: 2010-07-28 22:51:05 -0500 (Wed, 28 Jul 2010) $
*/
#ifndef OPAL_IAX2_SAFESTRINGS_H
#define OPAL_IAX2_SAFESTRINGS_H
#ifndef _PTLIB_H
#include <ptlib.h>
#endif
#include <opal/buildopts.h>
#if OPAL_IAX2
#ifdef P_USE_PRAGMA
#pragma interface
#endif
/**This class is used to manage a list of strings in a thread safe fashion.
This class is thread safe.
*/
class SafeStrings : public PObject
{
PCLASSINFO(SafeStrings, PObject);
public:
/**@name Construction/Destruction */
//@{
/**Construct SafeStrings class
*/
SafeStrings();
/**Destructor*/
~SafeStrings();
//@}
/**@name General Methods*/
//@{
/**Add a new string to the list, in a thread safe fashion. */
void AppendString(const PString & newString, /*!<String to add to the list. */
PBoolean splitString = false /*!<If True, the string is added to the list, character by character. */
);
/**Add a new string to the list, in a thread safe fashion. */
void AppendString(const char *newString, /*!<String to add to the list. */
PBoolean splitString = false /*!<If True, the string is added to the list, character by character. */
) { PString s(newString); AppendString(s, splitString); }
/**Remove the last string from this list, in a thread safe fashion. Return true if succesfull*/
PBoolean GetNextString(PString & nextString /*!< resultant string. */
);
/** Return True if this list is empty */
PBoolean IsEmpty();
/** Return True if there is data ready to be read from the list */
PBoolean StringsAvailable() { return !IsEmpty(); }
/** Return the first string on list, and then delete all elements on the list */
PString GetFirstDeleteAll();
/** Return the contents of this string array */
void GetAllDeleteAll(PStringArray & res);
//@}
protected:
/**Lock on this string array*/
PMutex accessMutex;
/**Internal String array */
PStringArray data;
};
////////////////////////////////////////////////////////////////////////////////
/** A class to handle thread safe access to a PString */
class SafeString : public PObject
{
PCLASSINFO(SafeString, PObject);
public:
/**Construct this class with an empty internal value */
SafeString() { internal = PString::Empty(); }
/**Construct this class with the internal value set to something */
SafeString(PString newValue) { internal = newValue; }
/**Assign a new value to the internal variable*/
void operator = (PString newValue);
/**Retrieve the value of the internal variable */
PString Get() { PWaitAndSignal m(mutex); return internal; }
/**print the internal string to the designated stream*/
virtual void PrintOn(ostream & str) const;
/**Retrive the value of the internal variable as a string */
operator PString();
/**Add a new text to the string, in a thread safe fashion. */
void operator += (PString toBeAdded);
/**Retrieve and clear the value of the internal variable */
PString GetAndDelete();
/** Return True if this list is empty */
PBoolean IsEmpty() const;
protected:
/**The internal variable which is accessed in a thread safe fashion.*/
PString internal;
/**The lock, which is used to safeguard access to this variable */
PMutex mutex;
};
////////////////////////////////////////////////////////////////////////////////
#endif // OPAL_IAX2
#endif // OPAL_IAX2_SAFESTRINGS_H
/* The comment below is magic for those who use emacs to edit this file.
* With the comment below, the tab key does auto indent to 2 spaces.
*
* Local Variables:
* mode:c
* c-basic-offset:2
* End:
*/
|