Ice 3.7 C++11 API Reference
Metrics.h
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 //
5 // Ice version 3.7.10
6 //
7 // <auto-generated>
8 //
9 // Generated from file `Metrics.ice'
10 //
11 // Warning: do not edit this file.
12 //
13 // </auto-generated>
14 //
15 
16 #ifndef __IceStorm_Metrics_h__
17 #define __IceStorm_Metrics_h__
18 
19 #include <IceUtil/PushDisableWarnings.h>
20 #include <Ice/ProxyF.h>
21 #include <Ice/ObjectF.h>
22 #include <Ice/ValueF.h>
23 #include <Ice/Exception.h>
24 #include <Ice/LocalObject.h>
25 #include <Ice/StreamHelpers.h>
26 #include <Ice/Comparable.h>
27 #include <Ice/Proxy.h>
28 #include <Ice/Object.h>
29 #include <Ice/GCObject.h>
30 #include <Ice/Value.h>
31 #include <Ice/Incoming.h>
32 #include <Ice/FactoryTableInit.h>
33 #include <IceUtil/ScopedArray.h>
34 #include <Ice/Optional.h>
35 #include <Ice/ExceptionHelpers.h>
36 #include <Ice/Metrics.h>
37 #include <IceUtil/UndefSysMacros.h>
38 #include <IceStorm/Config.h>
39 
40 #ifndef ICE_IGNORE_VERSION
41 # if ICE_INT_VERSION / 100 != 307
42 # error Ice version mismatch!
43 # endif
44 # if ICE_INT_VERSION % 100 >= 50
45 # error Beta header file detected
46 # endif
47 # if ICE_INT_VERSION % 100 < 10
48 # error Ice patch level mismatch!
49 # endif
50 #endif
51 
52 #ifndef ICESTORM_API
53 # if defined(ICE_STATIC_LIBS)
54 # define ICESTORM_API
55 # elif defined(ICESTORM_API_EXPORTS)
56 # define ICESTORM_API ICE_DECLSPEC_EXPORT
57 # else
58 # define ICESTORM_API ICE_DECLSPEC_IMPORT
59 # endif
60 #endif
61 
62 #ifdef ICE_CPP11_MAPPING // C++11 mapping
63 
64 namespace IceMX
65 {
66 
67 class TopicMetrics;
68 class SubscriberMetrics;
69 
70 }
71 
72 namespace IceMX
73 {
74 
79 class ICE_CLASS(ICESTORM_API) TopicMetrics : public ::Ice::ValueHelper<TopicMetrics, Metrics>
80 {
81 public:
82 
83  ICE_MEMBER(ICESTORM_API) virtual ~TopicMetrics();
84 
85  TopicMetrics() = default;
86 
87  TopicMetrics(const TopicMetrics&) = default;
88  TopicMetrics(TopicMetrics&&) = default;
89  TopicMetrics& operator=(const TopicMetrics&) = default;
90  TopicMetrics& operator=(TopicMetrics&&) = default;
91 
102  TopicMetrics(const ::std::string& id, long long int total, int current, long long int totalLifetime, int failures, long long int published, long long int forwarded) :
103  Ice::ValueHelper<TopicMetrics, Metrics>(id, total, current, totalLifetime, failures),
104  published(published),
105  forwarded(forwarded)
106  {
107  }
108 
113  std::tuple<const ::std::string&, const long long int&, const int&, const long long int&, const int&, const long long int&, const long long int&> ice_tuple() const
114  {
115  return std::tie(id, total, current, totalLifetime, failures, published, forwarded);
116  }
117 
122  ICE_MEMBER(ICESTORM_API) static const ::std::string& ice_staticId();
123 
127  long long int published = 0LL;
131  long long int forwarded = 0LL;
132 };
133 
135 static TopicMetrics _iceS_TopicMetrics_init;
137 
142 class ICE_CLASS(ICESTORM_API) SubscriberMetrics : public ::Ice::ValueHelper<SubscriberMetrics, Metrics>
143 {
144 public:
145 
146  ICE_MEMBER(ICESTORM_API) virtual ~SubscriberMetrics();
147 
148  SubscriberMetrics() = default;
149 
150  SubscriberMetrics(const SubscriberMetrics&) = default;
151  SubscriberMetrics(SubscriberMetrics&&) = default;
152  SubscriberMetrics& operator=(const SubscriberMetrics&) = default;
153  SubscriberMetrics& operator=(SubscriberMetrics&&) = default;
154 
166  SubscriberMetrics(const ::std::string& id, long long int total, int current, long long int totalLifetime, int failures, int queued, int outstanding, long long int delivered) :
167  Ice::ValueHelper<SubscriberMetrics, Metrics>(id, total, current, totalLifetime, failures),
168  queued(queued),
169  outstanding(outstanding),
170  delivered(delivered)
171  {
172  }
173 
178  std::tuple<const ::std::string&, const long long int&, const int&, const long long int&, const int&, const int&, const int&, const long long int&> ice_tuple() const
179  {
180  return std::tie(id, total, current, totalLifetime, failures, queued, outstanding, delivered);
181  }
182 
187  ICE_MEMBER(ICESTORM_API) static const ::std::string& ice_staticId();
188 
192  int queued = 0;
196  int outstanding = 0;
200  long long int delivered = 0LL;
201 };
202 
203 }
204 
205 namespace IceMX
206 {
207 
208 }
209 
211 namespace Ice
212 {
213 
214 template<typename S>
215 struct StreamWriter<::IceMX::TopicMetrics, S>
216 {
217  static void write(S* ostr, const ::IceMX::TopicMetrics& v)
218  {
219  ostr->writeAll(v.published, v.forwarded);
220  }
221 };
222 
223 template<typename S>
224 struct StreamReader<::IceMX::TopicMetrics, S>
225 {
226  static void read(S* istr, ::IceMX::TopicMetrics& v)
227  {
228  istr->readAll(v.published, v.forwarded);
229  }
230 };
231 
232 template<typename S>
233 struct StreamWriter<::IceMX::SubscriberMetrics, S>
234 {
235  static void write(S* ostr, const ::IceMX::SubscriberMetrics& v)
236  {
237  ostr->writeAll(v.queued, v.outstanding, v.delivered);
238  }
239 };
240 
241 template<typename S>
242 struct StreamReader<::IceMX::SubscriberMetrics, S>
243 {
244  static void read(S* istr, ::IceMX::SubscriberMetrics& v)
245  {
246  istr->readAll(v.queued, v.outstanding, v.delivered);
247  }
248 };
249 
250 }
252 
254 namespace IceMX
255 {
256 
257 using TopicMetricsPtr = ::std::shared_ptr<TopicMetrics>;
258 
259 using SubscriberMetricsPtr = ::std::shared_ptr<SubscriberMetrics>;
260 
261 }
263 
264 #else // C++98 mapping
265 
266 namespace IceProxy
267 {
268 
269 namespace IceMX
270 {
271 
272 class TopicMetrics;
274 ICESTORM_API void _readProxy(::Ice::InputStream*, ::IceInternal::ProxyHandle< TopicMetrics>&);
275 ICESTORM_API ::IceProxy::Ice::Object* upCast(TopicMetrics*);
277 
278 class SubscriberMetrics;
280 ICESTORM_API void _readProxy(::Ice::InputStream*, ::IceInternal::ProxyHandle< SubscriberMetrics>&);
281 ICESTORM_API ::IceProxy::Ice::Object* upCast(SubscriberMetrics*);
283 
284 }
285 
286 }
287 
288 namespace IceMX
289 {
290 
291 class TopicMetrics;
293 ICESTORM_API ::Ice::Object* upCast(TopicMetrics*);
295 typedef ::IceInternal::Handle< TopicMetrics> TopicMetricsPtr;
296 typedef ::IceInternal::ProxyHandle< ::IceProxy::IceMX::TopicMetrics> TopicMetricsPrx;
297 typedef TopicMetricsPrx TopicMetricsPrxPtr;
299 ICESTORM_API void _icePatchObjectPtr(TopicMetricsPtr&, const ::Ice::ObjectPtr&);
301 
302 class SubscriberMetrics;
304 ICESTORM_API ::Ice::Object* upCast(SubscriberMetrics*);
306 typedef ::IceInternal::Handle< SubscriberMetrics> SubscriberMetricsPtr;
307 typedef ::IceInternal::ProxyHandle< ::IceProxy::IceMX::SubscriberMetrics> SubscriberMetricsPrx;
308 typedef SubscriberMetricsPrx SubscriberMetricsPrxPtr;
310 ICESTORM_API void _icePatchObjectPtr(SubscriberMetricsPtr&, const ::Ice::ObjectPtr&);
312 
313 }
314 
315 namespace IceMX
316 {
317 
318 }
319 
320 namespace IceProxy
321 {
322 
323 namespace IceMX
324 {
325 
326 class ICE_CLASS(ICESTORM_API) TopicMetrics : public virtual ::Ice::Proxy<TopicMetrics, ::IceProxy::IceMX::Metrics>
327 {
328 public:
329 
334  ICE_MEMBER(ICESTORM_API) static const ::std::string& ice_staticId();
335 
336 protected:
338 
339  ICE_MEMBER(ICESTORM_API) virtual ::IceProxy::Ice::Object* _newInstance() const;
341 };
342 
343 class ICE_CLASS(ICESTORM_API) SubscriberMetrics : public virtual ::Ice::Proxy<SubscriberMetrics, ::IceProxy::IceMX::Metrics>
344 {
345 public:
346 
351  ICE_MEMBER(ICESTORM_API) static const ::std::string& ice_staticId();
352 
353 protected:
355 
356  ICE_MEMBER(ICESTORM_API) virtual ::IceProxy::Ice::Object* _newInstance() const;
358 };
359 
360 }
361 
362 }
363 
364 namespace IceMX
365 {
366 
371 class ICESTORM_API TopicMetrics : public Metrics
372 {
373 public:
374 
375  typedef TopicMetricsPrx ProxyType;
376  typedef TopicMetricsPtr PointerType;
377 
378  virtual ~TopicMetrics();
379 
381  TopicMetrics() :
382  published(ICE_INT64(0)),
383  forwarded(ICE_INT64(0))
384  {
385  }
386 
397  TopicMetrics(const ::std::string& id, ::Ice::Long total, ::Ice::Int current, ::Ice::Long totalLifetime, ::Ice::Int failures, ::Ice::Long published, ::Ice::Long forwarded) :
398  ::IceMX::Metrics(id, total, current, totalLifetime, failures),
399  published(published),
400  forwarded(forwarded)
401  {
402  }
403 
404 #ifdef ICE_CPP11_COMPILER
405  TopicMetrics(const TopicMetrics&) = default;
406  TopicMetrics& operator=(const TopicMetrics&) = default;
407 #endif
408 
413  virtual ::Ice::ObjectPtr ice_clone() const;
414 
421  virtual bool ice_isA(const ::std::string& id, const ::Ice::Current& current = ::Ice::emptyCurrent) const;
422 
428  virtual ::std::vector< ::std::string> ice_ids(const ::Ice::Current& current = ::Ice::emptyCurrent) const;
429 
435  virtual const ::std::string& ice_id(const ::Ice::Current& current = ::Ice::emptyCurrent) const;
436 
441  static const ::std::string& ice_staticId();
442 
447  static ::Ice::ValueFactoryPtr ice_factory();
448 
449 protected:
450 
452  virtual void _iceWriteImpl(::Ice::OutputStream*) const;
453  virtual void _iceReadImpl(::Ice::InputStream*);
455 
456 public:
457 
461  ::Ice::Long published;
465  ::Ice::Long forwarded;
466 };
468 static ::Ice::ValueFactoryPtr _iceS_TopicMetrics_init = ::IceMX::TopicMetrics::ice_factory();
470 
472 inline bool operator==(const TopicMetrics& lhs, const TopicMetrics& rhs)
473 {
474  return static_cast<const ::Ice::Object&>(lhs) == static_cast<const ::Ice::Object&>(rhs);
475 }
476 
477 inline bool operator<(const TopicMetrics& lhs, const TopicMetrics& rhs)
478 {
479  return static_cast<const ::Ice::Object&>(lhs) < static_cast<const ::Ice::Object&>(rhs);
480 }
482 
487 class ICESTORM_API SubscriberMetrics : public Metrics
488 {
489 public:
490 
491  typedef SubscriberMetricsPrx ProxyType;
492  typedef SubscriberMetricsPtr PointerType;
493 
494  virtual ~SubscriberMetrics();
495 
497  SubscriberMetrics() :
498  queued(0),
499  outstanding(0),
500  delivered(ICE_INT64(0))
501  {
502  }
503 
515  SubscriberMetrics(const ::std::string& id, ::Ice::Long total, ::Ice::Int current, ::Ice::Long totalLifetime, ::Ice::Int failures, ::Ice::Int queued, ::Ice::Int outstanding, ::Ice::Long delivered) :
516  ::IceMX::Metrics(id, total, current, totalLifetime, failures),
517  queued(queued),
518  outstanding(outstanding),
519  delivered(delivered)
520  {
521  }
522 
523 #ifdef ICE_CPP11_COMPILER
524  SubscriberMetrics(const SubscriberMetrics&) = default;
525  SubscriberMetrics& operator=(const SubscriberMetrics&) = default;
526 #endif
527 
532  virtual ::Ice::ObjectPtr ice_clone() const;
533 
540  virtual bool ice_isA(const ::std::string& id, const ::Ice::Current& current = ::Ice::emptyCurrent) const;
541 
547  virtual ::std::vector< ::std::string> ice_ids(const ::Ice::Current& current = ::Ice::emptyCurrent) const;
548 
554  virtual const ::std::string& ice_id(const ::Ice::Current& current = ::Ice::emptyCurrent) const;
555 
560  static const ::std::string& ice_staticId();
561 
566  static ::Ice::ValueFactoryPtr ice_factory();
567 
568 protected:
569 
571  virtual void _iceWriteImpl(::Ice::OutputStream*) const;
572  virtual void _iceReadImpl(::Ice::InputStream*);
574 
575 public:
576 
580  ::Ice::Int queued;
584  ::Ice::Int outstanding;
588  ::Ice::Long delivered;
589 };
591 static ::Ice::ValueFactoryPtr _iceS_SubscriberMetrics_init = ::IceMX::SubscriberMetrics::ice_factory();
593 
595 inline bool operator==(const SubscriberMetrics& lhs, const SubscriberMetrics& rhs)
596 {
597  return static_cast<const ::Ice::Object&>(lhs) == static_cast<const ::Ice::Object&>(rhs);
598 }
599 
600 inline bool operator<(const SubscriberMetrics& lhs, const SubscriberMetrics& rhs)
601 {
602  return static_cast<const ::Ice::Object&>(lhs) < static_cast<const ::Ice::Object&>(rhs);
603 }
605 
606 }
607 
609 namespace Ice
610 {
611 
612 template<typename S>
613 struct StreamWriter< ::IceMX::TopicMetrics, S>
614 {
615  static void write(S* ostr, const ::IceMX::TopicMetrics& v)
616  {
617  ostr->write(v.published);
618  ostr->write(v.forwarded);
619  }
620 };
621 
622 template<typename S>
623 struct StreamReader< ::IceMX::TopicMetrics, S>
624 {
625  static void read(S* istr, ::IceMX::TopicMetrics& v)
626  {
627  istr->read(v.published);
628  istr->read(v.forwarded);
629  }
630 };
631 
632 template<typename S>
633 struct StreamWriter< ::IceMX::SubscriberMetrics, S>
634 {
635  static void write(S* ostr, const ::IceMX::SubscriberMetrics& v)
636  {
637  ostr->write(v.queued);
638  ostr->write(v.outstanding);
639  ostr->write(v.delivered);
640  }
641 };
642 
643 template<typename S>
644 struct StreamReader< ::IceMX::SubscriberMetrics, S>
645 {
646  static void read(S* istr, ::IceMX::SubscriberMetrics& v)
647  {
648  istr->read(v.queued);
649  istr->read(v.outstanding);
650  istr->read(v.delivered);
651  }
652 };
653 
654 }
656 
657 namespace IceMX
658 {
659 
660 }
661 
662 #endif
663 
664 #include <IceUtil/PopDisableWarnings.h>
665 #endif
IceMX::TopicMetrics::operator=
TopicMetrics & operator=(const TopicMetrics &)=default
Optional.h
IceMX::SubscriberMetrics::SubscriberMetrics
SubscriberMetrics(SubscriberMetrics &&)=default
Ice::InputStream
Interface for input streams used to extract Slice types from a sequence of bytes.
Definition: InputStream.h:50
Ice::emptyCurrent
const Current emptyCurrent
A default-initialized Current instance.
StreamHelpers.h
Ice::Object
The base class for servants.
Definition: Object.h:91
Ice::operator==
bool operator==(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:184
IceMX::SubscriberMetrics::operator=
SubscriberMetrics & operator=(SubscriberMetrics &&)=default
IceMX::TopicMetrics::operator=
TopicMetrics & operator=(TopicMetrics &&)=default
GCObject.h
Incoming.h
IceMX
Definition: Metrics.h:65
IceMX::TopicMetrics::TopicMetrics
TopicMetrics()=default
IceMX::TopicMetrics::ice_staticId
static const ::std::string & ice_staticId()
Obtains the Slice type ID of this value.
ICE_MEMBER
#define ICE_MEMBER(API)
Definition: Config.h:177
FactoryTableInit.h
IceMX::Metrics
The base class for metrics.
Definition: Metrics.h:341
IceMX::TopicMetrics
Provides information on IceStorm topics.
Definition: Metrics.h:80
IceMX::TopicMetrics::TopicMetrics
TopicMetrics(const ::std::string &id, long long int total, int current, long long int totalLifetime, int failures, long long int published, long long int forwarded)
One-shot constructor to initialize all data members.
Definition: Metrics.h:102
IceMX::SubscriberMetrics::ice_staticId
static const ::std::string & ice_staticId()
Obtains the Slice type ID of this value.
IceMX::TopicMetrics::TopicMetrics
TopicMetrics(TopicMetrics &&)=default
LocalObject.h
PushDisableWarnings.h
IceMX::TopicMetrics::~TopicMetrics
virtual ~TopicMetrics()
ICE_INT64
#define ICE_INT64(n)
Definition: Config.h:343
IceMX::SubscriberMetrics::SubscriberMetrics
SubscriberMetrics(const ::std::string &id, long long int total, int current, long long int totalLifetime, int failures, int queued, int outstanding, long long int delivered)
One-shot constructor to initialize all data members.
Definition: Metrics.h:166
IceMX::SubscriberMetrics::~SubscriberMetrics
virtual ~SubscriberMetrics()
ProxyF.h
Ice::operator<
bool operator<(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:136
Metrics.h
ICESTORM_API
#define ICESTORM_API
Definition: Metrics.h:58
Object.h
Proxy.h
IceMX::SubscriberMetrics
Provides information on IceStorm subscribers.
Definition: Metrics.h:143
IceMX::SubscriberMetrics::queued
int queued
Number of queued events.
Definition: Metrics.h:192
UndefSysMacros.h
Ice::OutputStream
Interface for output streams used to create a sequence of bytes from Slice types.
Definition: OutputStream.h:28
IceMX::SubscriberMetrics::SubscriberMetrics
SubscriberMetrics()=default
ObjectF.h
IceMX::TopicMetrics::published
long long int published
Number of events published on the topic by publishers.
Definition: Metrics.h:127
Ice::Long
long long int Long
The mapping for the Slice long type.
Definition: Config.h:57
Ice
Definition: BuiltinSequences.h:56
ExceptionHelpers.h
IceMX::TopicMetrics::ice_tuple
std::tuple< const ::std::string &, const long long int &, const int &, const long long int &, const int &, const long long int &, const long long int & > ice_tuple() const
Obtains a tuple containing all of the value's data members.
Definition: Metrics.h:113
IceMX::SubscriberMetrics::SubscriberMetrics
SubscriberMetrics(const SubscriberMetrics &)=default
IceMX::SubscriberMetrics::delivered
long long int delivered
Number of forwarded events.
Definition: Metrics.h:200
IceMX::SubscriberMetrics::ice_tuple
std::tuple< const ::std::string &, const long long int &, const int &, const long long int &, const int &, const int &, const int &, const long long int & > ice_tuple() const
Obtains a tuple containing all of the value's data members.
Definition: Metrics.h:178
Comparable.h
Config.h
ScopedArray.h
IceMX::SubscriberMetrics::operator=
SubscriberMetrics & operator=(const SubscriberMetrics &)=default
IceMX::TopicMetrics::TopicMetrics
TopicMetrics(const TopicMetrics &)=default
Ice::Proxy
Helper template that supplies proxy factory functions.
Definition: Proxy.h:1204
Exception.h
ValueF.h
Ice::Int
int Int
The mapping for the Slice int type.
Definition: Config.h:54
IceMX::SubscriberMetrics::outstanding
int outstanding
Number of outstanding events.
Definition: Metrics.h:196
Value.h
IceMX::TopicMetrics::forwarded
long long int forwarded
Number of events forwarded on the topic by IceStorm topic links.
Definition: Metrics.h:131
PopDisableWarnings.h
Generated by doxygen 1.8.20