/usr/include/tango/pollobj.h is in libtango7-dev 7.2.6+dfsg-4build2.
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 | //=============================================================================
//
// file : PollObj.h
//
// description : Include for the PollObj object. This class implements
// the polling ring buffer. Command result or attribute
// values are stored in this buffer manages as a ring
// buffer.
//
// project : TANGO
//
// author(s) : E.Taurel
//
// Copyright (C) : 2004,2005,2006,2007,2008,2009,2010,2011
// European Synchrotron Radiation Facility
// BP 220, Grenoble 38043
// FRANCE
//
// This file is part of Tango.
//
// Tango 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 3 of the License, or
// (at your option) any later version.
//
// Tango 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 Tango. If not, see <http://www.gnu.org/licenses/>.
//
// $Revision: 15556 $
//
// $Log$
// Revision 3.10 2010/09/09 13:46:01 taurel
// - Add year 2010 in Copyright notice
//
// Revision 3.9 2010/09/09 13:29:09 taurel
// - Commit after the last merge with the bugfixes branch
// - Fix some warning when compiled -W -Wall
//
// Revision 3.8 2009/01/21 12:47:15 taurel
// - Change CopyRights for 2009
//
// Revision 3.7 2008/12/19 14:27:08 taurel
// - First changes for compatibility between IDL 3 and IDL 4
//
// Revision 3.6 2008/10/06 15:01:36 taurel
// - Changed the licensing info from GPL to LGPL
//
// Revision 3.5 2008/10/03 06:52:31 taurel
// - Add some licensing info in each files
//
// Revision 3.4 2008/05/20 12:44:12 taurel
// - Commit after merge with release 7 branch
//
// Revision 3.3.2.3 2008/05/20 06:17:46 taurel
// - Last commit before merge with trunk
// (start the implementation of the new DevEncoded data type)
//
// Revision 3.3.2.2 2007/11/20 14:40:19 taurel
// - Add the new way to retrieve command history from polling buffer
// implemented in Tango V7
//
// Revision 3.3.2.1 2007/11/16 14:12:35 taurel
// - Added a new IDL interface (Device_4)
// - Added a new way to get attribute history from polling buffer (must faster)
//
// Revision 3.3 2007/03/29 07:08:10 taurel
// - Change some data types for 64 bits compatibility
//
// Revision 3.2 2003/09/02 13:08:14 taurel
// Add memorized attribute feature (only for SCALAR and WRITE/READ_WRITE attribute)
//
// Revision 3.1 2003/08/21 07:24:37 taurel
// - End of the implementation of the new way to transfer data for read and
// write attributes (better use of exception)
// - Added Attribute::set_date() and Attribute::set_value_date_quality() methods
// - Added DeviceAttribute ctors from "const char *"
// - Enable writing of spectrum and image attributes
// - Many new DeviceAttribute ctors/inserters to enable easy image and spectrums
// attribute writing
// - Attribute date automatically set in case of attribute quality factor set to INVALID
// - Change in the polling thread discarding element algo. to support case of polling
// several cmd/atts at the same polling period with cmd/attr having a long response time
// - Take cmd/attr execution time into account in the "Data not updated since" polling
// status string
// - Split "str().c_str()" code in two lines of code. It was the reason of some problem
// on Windows device server
// - Add the possibility to set a cmd/attr polling as "externally triggered". Add method
// to send trigger to the polling thread
//
// Revision 3.0 2003/03/25 16:44:08 taurel
// Many changes for Tango release 3.0 including
// - Added full logging features
// - Added asynchronous calls
// - Host name of clients now stored in black-box
// - Three serialization model in DS
// - Fix miscellaneous bugs
// - Ported to gcc 3.2
// - Added ApiUtil::cleanup() and destructor methods
// - Some internal cleanups
// - Change the way how TangoMonitor class is implemented. It's a recursive
// mutex
//
// Revision 2.8 2002/12/16 12:07:33 taurel
// No change in code at all but only forgot th emost important line in
// list of updates in the previous release :
// - Change underlying ORB from ORBacus to omniORB
//
// Revision 2.7 2002/12/16 10:16:23 taurel
// - New method get_device_list() in Util class
// - Util::get_class_list takes DServer device into account
// - Util::get_device_by_name() takes DServer device into account
// - Util::get_device_list_by_class() takes DServer device into account
// - New parameter to the attribute::set_value() method to enable CORBA to free
// memory allocated for the attribute
//
// Revision 2.6 2002/10/17 07:43:07 taurel
// Fix bug in history stored by the polling thread :
// - We need one copy of the attribute data to build an history!!! It is true
// also for command which return data created by the DeviceImpl::create_xxx
// methods. Chnage in pollring.cpp/pollring.h/dserverpoll.cpp/pollobj.cpp
// and pollobj.h
//
// Revision 2.5 2002/10/15 11:27:20 taurel
// Fix bugs in device.cpp file :
// - Protect the state and status CORBA attribute with the device monitor
// Add the "TgLibVers" string as a #define in tango_config.h
//
// Revision 2.4 2002/08/12 15:06:55 taurel
// Several big fixes and changes
// - Remove HP-UX specific code
// - Fix bug in polling alogorithm which cause the thread to enter an infinite
// loop (pollthread.cpp)
// - For bug for Win32 device when trying to set attribute config
// (attribute.cpp)
//
// Revision 2.3 2002/07/02 15:22:25 taurel
// Miscellaneous small changes/bug fixes for Tango CPP release 2.1.0
// - classes reference documentation now generated using doxygen instead of doc++
// - A little file added to the library which summarizes version number.
// The RCS/CVS "ident" command will now tells you that release library x.y.z is composed
// by C++ client classes set release a.b and C++ server classes set release c.d
// - Fix incorrect field setting for DevFailed exception re-thrown from a CORBA exception
// - It's now not possible to poll the Init command
// - It's now possible to define a default class doc. per control system
// instance (using property)
// - The test done to check if attribute value has been set before it is
// returned to caller is done only if the attribute quality is set to VALID
// - The JTCInitialize object is now stored in the Util
// - Windows specific : The tango.h file now also include winsock.h
//
// Revision 2.2 2002/04/30 10:50:42 taurel
// Don't check alarm on attribute if attribute quality factor is INVALID
//
// Revision 2.1 2002/04/29 12:24:04 taurel
// Fix bug in attribute::set_value method and on the check against min and max value when writing attributes
//
// Revision 2.0 2002/04/09 14:45:11 taurel
// See Tango WEB pages for list of changes
//
//=============================================================================
#ifndef _POLLOBJ_H
#define _POLLOBJ_H
#include <tango.h>
#include <pollring.h>
namespace Tango
{
//=============================================================================
//
// The PollObj class
//
// description : Class to store all the necessary information which will
// be stored and returned to client on request
//
// This class is protected against concurrent access by a
// omni_mutex. We use the Thread-Safe interface pattern
// to avoid "self-deadlock". This is why several methods
// are splitted in two: One method called "meth" and
// another one called "meth_i" (which is also sometimes
// public !!)
//
//=============================================================================
class PollObj: public omni_mutex
{
public:
PollObj(DeviceImpl *,PollObjType,const string &,int);
PollObj(DeviceImpl *,PollObjType,const string &,int,long);
void insert_data(CORBA::Any *,struct timeval &,struct timeval &);
void insert_data(Tango::AttributeValueList *,struct timeval &,struct timeval &);
void insert_data(Tango::AttributeValueList_3 *,struct timeval &,struct timeval &);
void insert_data(Tango::AttributeValueList_4 *,struct timeval &,struct timeval &);
void insert_except(Tango::DevFailed *,struct timeval &,struct timeval &);
double get_authorized_delta() {return max_delta_t;}
void update_upd(int);
CORBA::Any *get_last_cmd_result();
Tango::AttributeValue &get_last_attr_value(bool);
Tango::AttributeValue_3 &get_last_attr_value_3(bool);
Tango::AttributeValue_4 &get_last_attr_value_4(bool);
bool is_ring_empty() {omni_mutex_lock(*this);return is_ring_empty_i();}
bool is_ring_empty_i() {return ring.is_empty();}
long get_upd() {omni_mutex_lock(*this);return get_upd_i();}
long get_upd_i() {return ((upd.tv_sec * 1000) + (upd.tv_usec / 1000));}
string &get_name() {omni_mutex_lock(*this);return get_name_i();}
string &get_name_i() {return name;}
inline double get_needed_time() {omni_mutex_lock(*this);return get_needed_time_i();}
inline double get_needed_time_i()
{
return ((needed_time.tv_sec * 1000) + (needed_time.tv_usec / 1000.0));
}
inline PollObjType get_type() {omni_mutex_lock(*this);return get_type_i();}
inline PollObjType get_type_i() {return type;}
double get_last_insert_date() {omni_mutex_lock(*this);return get_last_insert_date_i();}
double get_last_insert_date_i();
bool is_last_an_error() {omni_mutex_lock(*this);return is_last_an_error_i();}
bool is_last_an_error_i() {return ring.is_last_an_error();}
bool is_last_an_error_i_3()
{if (type==POLL_CMD)return ring.is_last_cmd_an_error();else return ring.is_last_attr_an_error();}
Tango::DevFailed *get_last_except() {omni_mutex_lock(*this);return get_last_except_i();}
Tango::DevFailed *get_last_except_i() {return ring.get_last_except();}
Tango::DevErrorList &get_last_attr_error_i() {return ring.get_last_attr_error();}
inline void get_delta_t(vector<double> &vd, long nb)
{omni_mutex_lock(*this);get_delta_t_i(vd,nb);}
inline void get_delta_t_i(vector<double> &vd,long nb)
{ring.get_delta_t(vd,nb);}
inline long get_elt_nb_in_buffer()
{omni_mutex_lock(*this);return get_elt_nb_in_buffer_i();}
inline long get_elt_nb_in_buffer_i()
{return ring.get_nb_elt();}
void get_cmd_history(long,Tango::DevCmdHistoryList *);
void get_cmd_history(long,Tango::DevCmdHistory_4 *,Tango::CmdArgType &);
void get_attr_history(long n,Tango::DevAttrHistoryList *ptr,long type);
void get_attr_history(long n,Tango::DevAttrHistoryList_3 *ptr,long type);
void get_attr_history(long n,Tango::DevAttrHistory_4 *ptr,long type);
void get_attr_history_43(long n,Tango::DevAttrHistoryList_3 *ptr,long type);
protected:
DeviceImpl *dev;
PollObjType type;
string name;
struct timeval upd;
struct timeval needed_time;
double max_delta_t;
PollRing ring;
};
inline bool operator<(const PollObj &,const PollObj &)
{
return true;
}
inline bool operator==(const PollObj &,const PollObj &)
{
return true;
}
} // End of Tango namespace
#endif /* _POLLOBJ_ */
|