Ice 3.8
C++ API Reference
Loading...
Searching...
No Matches
Exception.h
1// Copyright (c) ZeroC, Inc.
2
3// slice2cpp version 3.8.0
4// <auto-generated>Generated from Slice file 'Exception.ice'.</auto-generated>
5// clang-format off
6
7#ifndef IceGrid_Exception_h_
8#define IceGrid_Exception_h_
9
11#include <Ice/Ice.h>
12#include <Ice/Identity.h>
13#include <IceGrid/Config.h>
14
15#ifndef ICE_DISABLE_VERSION
16# if ICE_INT_VERSION / 100 != 308
17# error Ice version mismatch!
18# endif
19# if ICE_INT_VERSION % 100 >= 50
20# error Beta header file detected
21# endif
22# if ICE_INT_VERSION % 100 < 0
23# error Ice patch level mismatch!
24# endif
25#endif
26
27#ifndef ICEGRID_API
28# if defined(ICEGRID_API_EXPORTS)
29# define ICEGRID_API ICE_DECLSPEC_EXPORT
30# else
31# define ICEGRID_API ICE_DECLSPEC_IMPORT
32# endif
33#endif
34
35// NOLINTBEGIN(modernize-concat-nested-namespaces)
36
37namespace IceGrid
38{
39}
40
41namespace IceGrid
42{
43 /// The exception that is thrown when IceGrid does not know an application with the provided name.
44 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ApplicationNotExistException`.
45 /// @headerfile IceGrid/IceGrid.h
47 {
48 public:
49 /// Default constructor.
50 ApplicationNotExistException() noexcept = default;
51
52 /// One-shot constructor to initialize all data members.
53 /// @param name The name of the application.
54 ApplicationNotExistException(std::string name) noexcept :
55 name(std::move(name))
56 {
57 }
58
59 /// Copy constructor.
61
62 /// Creates a tuple with all the fields of this exception.
63 /// @return A tuple with all the fields of this exception.
64 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
65 {
66 return std::tie(name);
67 }
68
69 void ice_printFields(std::ostream& os) const override;
70 /// Gets the type ID of the associated Slice exception.
71 /// @return The string `"::IceGrid::ApplicationNotExistException"`.
72 static const char* ice_staticId() noexcept;
73
74 [[nodiscard]] const char* ice_id() const noexcept override;
75
76 void ice_throw() const override;
77
78 /// The name of the application.
79 std::string name;
80
81 protected:
82 /// @private
83 void _writeImpl(Ice::OutputStream*) const override;
84
85 /// @private
86 void _readImpl(Ice::InputStream*) override;
87 };
88
89 /// The exception that is thrown when IceGrid does not know a server with the provided server ID.
90 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ServerNotExistException`.
91 /// @headerfile IceGrid/IceGrid.h
92 class ICEGRID_API ServerNotExistException : public Ice::UserException
93 {
94 public:
95 /// Default constructor.
96 ServerNotExistException() noexcept = default;
97
98 /// One-shot constructor to initialize all data members.
99 /// @param id The server ID.
100 ServerNotExistException(std::string id) noexcept :
101 id(std::move(id))
102 {
103 }
104
105 /// Copy constructor.
107
108 /// Creates a tuple with all the fields of this exception.
109 /// @return A tuple with all the fields of this exception.
110 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
111 {
112 return std::tie(id);
113 }
114
115 void ice_printFields(std::ostream& os) const override;
116 /// Gets the type ID of the associated Slice exception.
117 /// @return The string `"::IceGrid::ServerNotExistException"`.
118 static const char* ice_staticId() noexcept;
119
120 [[nodiscard]] const char* ice_id() const noexcept override;
121
122 void ice_throw() const override;
123
124 /// The server ID.
125 std::string id;
126
127 protected:
128 /// @private
129 void _writeImpl(Ice::OutputStream*) const override;
130
131 /// @private
132 void _readImpl(Ice::InputStream*) override;
133 };
134
135 /// The exception that is thrown when a server failed to start.
136 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ServerStartException`.
137 /// @headerfile IceGrid/IceGrid.h
138 class ICEGRID_API ServerStartException : public Ice::UserException
139 {
140 public:
141 /// Default constructor.
142 ServerStartException() noexcept = default;
143
144 /// One-shot constructor to initialize all data members.
145 /// @param id The server ID.
146 /// @param reason The reason for the failure.
147 ServerStartException(std::string id, std::string reason) noexcept :
148 id(std::move(id)),
149 reason(std::move(reason))
150 {
151 }
152
153 /// Copy constructor.
154 ServerStartException(const ServerStartException&) noexcept = default;
155
156 /// Creates a tuple with all the fields of this exception.
157 /// @return A tuple with all the fields of this exception.
158 [[nodiscard]] std::tuple<const std::string&, const std::string&> ice_tuple() const
159 {
160 return std::tie(id, reason);
161 }
162
163 void ice_printFields(std::ostream& os) const override;
164 /// Gets the type ID of the associated Slice exception.
165 /// @return The string `"::IceGrid::ServerStartException"`.
166 static const char* ice_staticId() noexcept;
167
168 [[nodiscard]] const char* ice_id() const noexcept override;
169
170 void ice_throw() const override;
171
172 /// The server ID.
173 std::string id;
174
175 /// The reason for the failure.
176 std::string reason;
177
178 protected:
179 /// @private
180 void _writeImpl(Ice::OutputStream*) const override;
181
182 /// @private
183 void _readImpl(Ice::InputStream*) override;
184 };
185
186 /// The exception that is thrown when a server failed to stop.
187 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ServerStopException`.
188 /// @headerfile IceGrid/IceGrid.h
189 class ICEGRID_API ServerStopException : public Ice::UserException
190 {
191 public:
192 /// Default constructor.
193 ServerStopException() noexcept = default;
194
195 /// One-shot constructor to initialize all data members.
196 /// @param id The server ID.
197 /// @param reason The reason for the failure.
198 ServerStopException(std::string id, std::string reason) noexcept :
199 id(std::move(id)),
200 reason(std::move(reason))
201 {
202 }
203
204 /// Copy constructor.
205 ServerStopException(const ServerStopException&) noexcept = default;
206
207 /// Creates a tuple with all the fields of this exception.
208 /// @return A tuple with all the fields of this exception.
209 [[nodiscard]] std::tuple<const std::string&, const std::string&> ice_tuple() const
210 {
211 return std::tie(id, reason);
212 }
213
214 void ice_printFields(std::ostream& os) const override;
215 /// Gets the type ID of the associated Slice exception.
216 /// @return The string `"::IceGrid::ServerStopException"`.
217 static const char* ice_staticId() noexcept;
218
219 [[nodiscard]] const char* ice_id() const noexcept override;
220
221 void ice_throw() const override;
222
223 /// The server ID.
224 std::string id;
225
226 /// The reason for the failure.
227 std::string reason;
228
229 protected:
230 /// @private
231 void _writeImpl(Ice::OutputStream*) const override;
232
233 /// @private
234 void _readImpl(Ice::InputStream*) override;
235 };
236
237 /// The exception that is thrown when IceGrid does not know an object adapter with the provided adapter ID.
238 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::AdapterNotExistException`.
239 /// @headerfile IceGrid/IceGrid.h
240 class ICEGRID_API AdapterNotExistException : public Ice::UserException
241 {
242 public:
243 /// Default constructor.
244 AdapterNotExistException() noexcept = default;
245
246 /// One-shot constructor to initialize all data members.
247 /// @param id The adapter ID.
248 AdapterNotExistException(std::string id) noexcept :
249 id(std::move(id))
250 {
251 }
252
253 /// Copy constructor.
255
256 /// Creates a tuple with all the fields of this exception.
257 /// @return A tuple with all the fields of this exception.
258 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
259 {
260 return std::tie(id);
261 }
262
263 void ice_printFields(std::ostream& os) const override;
264 /// Gets the type ID of the associated Slice exception.
265 /// @return The string `"::IceGrid::AdapterNotExistException"`.
266 static const char* ice_staticId() noexcept;
267
268 [[nodiscard]] const char* ice_id() const noexcept override;
269
270 void ice_throw() const override;
271
272 /// The adapter ID.
273 std::string id;
274
275 protected:
276 /// @private
277 void _writeImpl(Ice::OutputStream*) const override;
278
279 /// @private
280 void _readImpl(Ice::InputStream*) override;
281 };
282
283 /// The exception that is thrown when IceGrid does not know a node with the provided name.
284 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::NodeNotExistException`.
285 /// @headerfile IceGrid/IceGrid.h
286 class ICEGRID_API NodeNotExistException : public Ice::UserException
287 {
288 public:
289 /// Default constructor.
290 NodeNotExistException() noexcept = default;
291
292 /// One-shot constructor to initialize all data members.
293 /// @param name The node name.
294 NodeNotExistException(std::string name) noexcept :
295 name(std::move(name))
296 {
297 }
298
299 /// Copy constructor.
301
302 /// Creates a tuple with all the fields of this exception.
303 /// @return A tuple with all the fields of this exception.
304 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
305 {
306 return std::tie(name);
307 }
308
309 void ice_printFields(std::ostream& os) const override;
310 /// Gets the type ID of the associated Slice exception.
311 /// @return The string `"::IceGrid::NodeNotExistException"`.
312 static const char* ice_staticId() noexcept;
313
314 [[nodiscard]] const char* ice_id() const noexcept override;
315
316 void ice_throw() const override;
317
318 /// The node name.
319 std::string name;
320
321 protected:
322 /// @private
323 void _writeImpl(Ice::OutputStream*) const override;
324
325 /// @private
326 void _readImpl(Ice::InputStream*) override;
327 };
328
329 /// The exception that is thrown when IceGrid does not know a registry with the provided name.
330 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::RegistryNotExistException`.
331 /// @headerfile IceGrid/IceGrid.h
332 class ICEGRID_API RegistryNotExistException : public Ice::UserException
333 {
334 public:
335 /// Default constructor.
336 RegistryNotExistException() noexcept = default;
337
338 /// One-shot constructor to initialize all data members.
339 /// @param name The registry name.
340 RegistryNotExistException(std::string name) noexcept :
341 name(std::move(name))
342 {
343 }
344
345 /// Copy constructor.
347
348 /// Creates a tuple with all the fields of this exception.
349 /// @return A tuple with all the fields of this exception.
350 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
351 {
352 return std::tie(name);
353 }
354
355 void ice_printFields(std::ostream& os) const override;
356 /// Gets the type ID of the associated Slice exception.
357 /// @return The string `"::IceGrid::RegistryNotExistException"`.
358 static const char* ice_staticId() noexcept;
359
360 [[nodiscard]] const char* ice_id() const noexcept override;
361
362 void ice_throw() const override;
363
364 /// The registry name.
365 std::string name;
366
367 protected:
368 /// @private
369 void _writeImpl(Ice::OutputStream*) const override;
370
371 /// @private
372 void _readImpl(Ice::InputStream*) override;
373 };
374
375 /// The exception that is thrown when the allocation of an object failed.
376 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::AllocationException`.
377 /// @headerfile IceGrid/IceGrid.h
378 class ICEGRID_API AllocationException : public Ice::UserException
379 {
380 public:
381 /// Default constructor.
382 AllocationException() noexcept = default;
383
384 /// One-shot constructor to initialize all data members.
385 /// @param reason The reason why the object couldn't be allocated.
386 AllocationException(std::string reason) noexcept :
387 reason(std::move(reason))
388 {
389 }
390
391 /// Copy constructor.
392 AllocationException(const AllocationException&) noexcept = default;
393
394 /// Creates a tuple with all the fields of this exception.
395 /// @return A tuple with all the fields of this exception.
396 [[nodiscard]] std::tuple<const std::string&> ice_tuple() const
397 {
398 return std::tie(reason);
399 }
400
401 void ice_printFields(std::ostream& os) const override;
402 /// Gets the type ID of the associated Slice exception.
403 /// @return The string `"::IceGrid::AllocationException"`.
404 static const char* ice_staticId() noexcept;
405
406 [[nodiscard]] const char* ice_id() const noexcept override;
407
408 void ice_throw() const override;
409
410 /// The reason why the object couldn't be allocated.
411 std::string reason;
412
413 protected:
414 /// @private
415 void _writeImpl(Ice::OutputStream*) const override;
416
417 /// @private
418 void _readImpl(Ice::InputStream*) override;
419 };
420
421 /// The exception that is thrown when the request to allocate an object times out.
422 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::AllocationTimeoutException`.
423 /// @headerfile IceGrid/IceGrid.h
425 {
426 public:
428
429 /// Gets the type ID of the associated Slice exception.
430 /// @return The string `"::IceGrid::AllocationTimeoutException"`.
431 static const char* ice_staticId() noexcept;
432
433 [[nodiscard]] const char* ice_id() const noexcept override;
434
435 void ice_throw() const override;
436
437 protected:
438 /// @private
439 void _writeImpl(Ice::OutputStream*) const override;
440
441 /// @private
442 void _readImpl(Ice::InputStream*) override;
443 };
444
445 /// The exception that is thrown when a well-known object is already registered.
446 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ObjectExistsException`.
447 /// @headerfile IceGrid/IceGrid.h
448 class ICEGRID_API ObjectExistsException : public Ice::UserException
449 {
450 public:
451 /// Default constructor.
452 ObjectExistsException() noexcept = default;
453
454 /// One-shot constructor to initialize all data members.
455 /// @param id The identity of the object.
456 ObjectExistsException(::Ice::Identity id) noexcept :
457 id(std::move(id))
458 {
459 }
460
461 /// Copy constructor.
463
464 /// Creates a tuple with all the fields of this exception.
465 /// @return A tuple with all the fields of this exception.
466 [[nodiscard]] std::tuple<const ::Ice::Identity&> ice_tuple() const
467 {
468 return std::tie(id);
469 }
470
471 void ice_printFields(std::ostream& os) const override;
472 /// Gets the type ID of the associated Slice exception.
473 /// @return The string `"::IceGrid::ObjectExistsException"`.
474 static const char* ice_staticId() noexcept;
475
476 [[nodiscard]] const char* ice_id() const noexcept override;
477
478 void ice_throw() const override;
479
480 /// The identity of the object.
481 ::Ice::Identity id;
482
483 protected:
484 /// @private
485 void _writeImpl(Ice::OutputStream*) const override;
486
487 /// @private
488 void _readImpl(Ice::InputStream*) override;
489 };
490
491 /// The exception that is thrown when a well-known object is not registered.
492 /// @remarks The Slice compiler generated this exception class from Slice exception `::IceGrid::ObjectNotRegisteredException`.
493 /// @headerfile IceGrid/IceGrid.h
494 class ICEGRID_API ObjectNotRegisteredException : public Ice::UserException
495 {
496 public:
497 /// Default constructor.
498 ObjectNotRegisteredException() noexcept = default;
499
500 /// One-shot constructor to initialize all data members.
501 /// @param id The identity of the object.
502 ObjectNotRegisteredException(::Ice::Identity id) noexcept :
503 id(std::move(id))
504 {
505 }
506
507 /// Copy constructor.
509
510 /// Creates a tuple with all the fields of this exception.
511 /// @return A tuple with all the fields of this exception.
512 [[nodiscard]] std::tuple<const ::Ice::Identity&> ice_tuple() const
513 {
514 return std::tie(id);
515 }
516
517 void ice_printFields(std::ostream& os) const override;
518 /// Gets the type ID of the associated Slice exception.
519 /// @return The string `"::IceGrid::ObjectNotRegisteredException"`.
520 static const char* ice_staticId() noexcept;
521
522 [[nodiscard]] const char* ice_id() const noexcept override;
523
524 void ice_throw() const override;
525
526 /// The identity of the object.
527 ::Ice::Identity id;
528
529 protected:
530 /// @private
531 void _writeImpl(Ice::OutputStream*) const override;
532
533 /// @private
534 void _readImpl(Ice::InputStream*) override;
535 };
536}
537
538// NOLINTEND(modernize-concat-nested-namespaces)
539
540#include <Ice/PopDisableWarnings.h>
541#endif
AdapterNotExistException(const AdapterNotExistException &) noexcept=default
Copy constructor.
void ice_throw() const override
Throws this exception.
AdapterNotExistException() noexcept=default
Default constructor.
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:258
const char * ice_id() const noexcept override
Returns the type ID of this exception.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:396
std::string reason
The reason why the object couldn't be allocated.
Definition Exception.h:411
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
AllocationException(const AllocationException &) noexcept=default
Copy constructor.
void ice_throw() const override
Throws this exception.
AllocationException() noexcept=default
Default constructor.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
const char * ice_id() const noexcept override
Returns the type ID of this exception.
void ice_throw() const override
Throws this exception.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
AllocationException() noexcept=default
Default constructor.
The exception that is thrown when the request to allocate an object times out.
Definition Exception.h:425
void ice_throw() const override
Throws this exception.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
std::string name
The name of the application.
Definition Exception.h:79
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:64
const char * ice_id() const noexcept override
Returns the type ID of this exception.
ApplicationNotExistException(const ApplicationNotExistException &) noexcept=default
Copy constructor.
ApplicationNotExistException() noexcept=default
Default constructor.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_throw() const override
Throws this exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:304
std::string name
The node name.
Definition Exception.h:319
NodeNotExistException() noexcept=default
Default constructor.
NodeNotExistException(const NodeNotExistException &) noexcept=default
Copy constructor.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
std::tuple< const ::Ice::Identity & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:466
const char * ice_id() const noexcept override
Returns the type ID of this exception.
ObjectExistsException(const ObjectExistsException &) noexcept=default
Copy constructor.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
ObjectExistsException() noexcept=default
Default constructor.
void ice_throw() const override
Throws this exception.
ObjectNotRegisteredException() noexcept=default
Default constructor.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
ObjectNotRegisteredException(const ObjectNotRegisteredException &) noexcept=default
Copy constructor.
std::tuple< const ::Ice::Identity & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:512
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_throw() const override
Throws this exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
void ice_throw() const override
Throws this exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
RegistryNotExistException(const RegistryNotExistException &) noexcept=default
Copy constructor.
std::string name
The registry name.
Definition Exception.h:365
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:350
RegistryNotExistException() noexcept=default
Default constructor.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
void ice_throw() const override
Throws this exception.
ServerNotExistException(const ServerNotExistException &) noexcept=default
Copy constructor.
ServerNotExistException() noexcept=default
Default constructor.
std::tuple< const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:110
void ice_throw() const override
Throws this exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
ServerStartException() noexcept=default
Default constructor.
ServerStartException(const ServerStartException &) noexcept=default
Copy constructor.
std::string reason
The reason for the failure.
Definition Exception.h:176
std::tuple< const std::string &, const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:158
ServerStopException() noexcept=default
Default constructor.
static const char * ice_staticId() noexcept
Gets the type ID of the associated Slice exception.
std::tuple< const std::string &, const std::string & > ice_tuple() const
Creates a tuple with all the fields of this exception.
Definition Exception.h:209
void ice_throw() const override
Throws this exception.
const char * ice_id() const noexcept override
Returns the type ID of this exception.
std::string reason
The reason for the failure.
Definition Exception.h:227
ServerStopException(const ServerStopException &) noexcept=default
Copy constructor.
void ice_printFields(std::ostream &os) const override
Outputs the name and value of each field of this instance, including inherited fields,...
Abstract base class for all exceptions defined in Slice.
Deploy and manage Ice servers.
Definition Admin.h:40
The Ice RPC framework.
Definition SampleEvent.h:66