Ice 3.7 Slice API Reference
LocalException.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/Identity.ice>
22 #include <Ice/Version.ice>
23 #include <Ice/BuiltinSequences.ice>
24 
25 #ifndef __SLICE2JAVA_COMPAT__
26 [["java:package:com.zeroc"]]
27 #endif
28 
29 ["objc:prefix:ICE"]
30 module Ice
31 {
32 
38 ["cpp:ice_print"]
39 local exception InitializationException
40 {
46  string reason;
47 }
48 
55 ["cpp:ice_print"]
57 {
63  string reason;
64 }
65 
72 ["cpp:ice_print", "deprecate:This exception is no longer used by the Ice run time"]
74 {
75 }
76 
88 ["cpp:ice_print"]
90 {
98  string kindOfObject;
99 
105  string id;
106 }
107 
122 ["cpp:ice_print"]
123 local exception NotRegisteredException
124 {
132  string kindOfObject;
133 
139  string id;
140 }
141 
152 ["cpp:ice_print"]
153 local exception TwowayOnlyException
154 {
160  string operation;
161 }
162 
174 ["cpp:ice_print"]
176 {
177 }
178 
188 ["cpp:ice_print"]
189 local exception UnknownException
190 {
197  string unknown;
198 }
199 
211 ["cpp:ice_print"]
213 {
214 }
215 
231 ["cpp:ice_print"]
232 local exception UnknownUserException extends UnknownException
233 {
234 }
235 
242 ["cpp:ice_print"]
244 {
245 }
246 
254 ["cpp:ice_print"]
256 {
257 }
258 
268 ["cpp:ice_print"]
270 {
276  string name;
277 }
278 
287 ["cpp:ice_print"]
289 {
295  string id;
296 }
297 
303 ["cpp:ice_print"]
304 local exception NoEndpointException
305 {
312  string proxy;
313 }
314 
321 ["cpp:ice_print"]
322 local exception EndpointParseException
323 {
329  string str;
330 }
331 
338 ["cpp:ice_print"]
340 {
346  string str;
347 }
348 
355 ["cpp:ice_print"]
356 local exception VersionParseException
357 {
363  string str;
364 }
365 
372 ["cpp:ice_print"]
373 local exception IdentityParseException
374 {
380  string str;
381 }
382 
389 ["cpp:ice_print"]
390 local exception ProxyParseException
391 {
397  string str;
398 }
399 
405 ["cpp:ice_print"]
407 {
414 }
415 
422 ["cpp:ice_print"]
423 local exception IllegalServantException
424 {
430  string reason;
431 }
432 
441 ["cpp:ice_print"]
442 local exception RequestFailedException
443 {
446 
448  string facet;
449 
451  string operation;
452 }
453 
460 ["cpp:ice_print"]
462 {
463 }
464 
471 ["cpp:ice_print"]
473 {
474 }
475 
483 ["cpp:ice_print"]
485 {
486 }
487 
496 ["cpp:ice_print"]
497 local exception SyscallException
498 {
508  int error = 0; // Don't use errno, as errno is usually a macro.
509 }
510 
516 ["cpp:ice_print"]
517 local exception SocketException extends SyscallException
518 {
519 }
520 
526 ["cpp:ice_print"]
527 local exception CFNetworkException extends SocketException
528 {
534  string domain;
535 }
536 
542 ["cpp:ice_print"]
543 local exception FileException extends SyscallException
544 {
546  string path;
547 }
548 
554 ["cpp:ice_print"]
556 {
557 }
558 
565 ["cpp:ice_print"]
567 {
568 }
569 
575 ["cpp:ice_print"]
577 {
578 }
579 
586 ["cpp:ice_print"]
587 local exception DNSException
588 {
597  int error = 0; // Don't use h_errno, as h_errno is usually a macro.
598 
604  string host;
605 }
606 
612 ["cpp:ice_print"]
614 {
615 }
616 
622 ["cpp:ice_print"]
623 local exception TimeoutException
624 {
625 }
626 
632 ["cpp:ice_print"]
634 {
635 }
636 
642 ["cpp:ice_print"]
644 {
645 }
646 
653 ["cpp:ice_print"]
655 {
656 }
657 
664 ["cpp:ice_print"]
666 {
667 }
668 
675 ["cpp:ice_print"]
677 {
678 }
679 
686 ["cpp:ice_print"]
687 local exception ProtocolException
688 {
694  string reason;
695 }
696 
703 ["cpp:ice_print"]
704 local exception BadMagicException extends ProtocolException
705 {
712 }
713 
719 ["cpp:ice_print"]
721 {
728 
735 }
736 
742 ["cpp:ice_print"]
744 {
751 
758 }
759 
765 ["cpp:ice_print"]
767 {
768 }
769 
776 ["cpp:ice_print"]
778 {
779 }
780 
787 ["cpp:ice_print"]
789 {
790 }
791 
797 ["cpp:ice_print"]
799 {
800 }
801 
814 ["cpp:ice_print"]
816 {
817 }
818 
827 ["cpp:ice_print"]
829 {
831  bool graceful;
832 }
833 
840 ["cpp:ice_print"]
842 {
843 }
844 
850 ["cpp:ice_print"]
852 {
853 }
854 
863 ["cpp:ice_print"]
865 {
866 }
867 
873 ["cpp:ice_print"]
874 local exception MarshalException extends ProtocolException
875 {
876 }
877 
883 ["cpp:ice_print"]
885 {
886 }
887 
893 ["cpp:ice_print"]
895 {
896 }
897 
909 ["cpp:ice_print"]
911 {
918  string type;
919 }
920 
932 ["cpp:ice_print"]
934 {
940  string type;
941 
947  string expectedType;
948 }
949 
957 ["cpp:ice_print"]
958 local exception MemoryLimitException extends MarshalException
959 {
960 }
961 
968 ["cpp:ice_print"]
970 {
971 }
972 
978 ["cpp:ice_print"]
980 {
981 }
982 
990 ["cpp:ice_print"]
992 {
999 }
1000 
1007 ["cpp:ice_print"]
1008 local exception SecurityException
1009 {
1015  string reason;
1016 }
1017 
1024 ["cpp:ice_print"]
1025 local exception FixedProxyException
1026 {
1027 }
1028 
1035 ["cpp:ice_print"]
1036 local exception ResponseSentException
1037 {
1038 }
1039 
1040 }
Ice::SecurityException
This exception indicates a failure in a security subsystem, such as the IceSSL plug-in.
Definition: LocalException.ice:1009
Ice::NotRegisteredException
An attempt was made to find or deregister something that is not registered with the Ice run time or I...
Definition: LocalException.ice:124
Ice::IllegalServantException::reason
string reason
Describes why this servant is illegal.
Definition: LocalException.ice:430
Ice::BadMagicException::badMagic
ByteSeq badMagic
A sequence containing the first four bytes of the incorrect message.
Definition: LocalException.ice:711
Ice::IllegalMessageSizeException
This exception indicates that a message size is less than the minimum required size.
Definition: LocalException.ice:842
Ice::ConnectionTimeoutException
This exception indicates that a connection has been shut down because it has been idle for some time.
Definition: LocalException.ice:655
Ice::VersionMismatchException
This exception is raised if the Ice library version does not match the version in the Ice header file...
Definition: LocalException.ice:244
Ice::UnsupportedEncodingException::supported
EncodingVersion supported
The version of the encoding that is supported.
Definition: LocalException.ice:757
Ice::ByteSeq
sequence< byte > ByteSeq
A sequence of bytes.
Definition: BuiltinSequences.ice:33
Ice::EndpointParseException
This exception is raised if there was an error while parsing an endpoint.
Definition: LocalException.ice:323
Ice::DNSException::host
string host
The host name that could not be resolved.
Definition: LocalException.ice:604
Ice::UnknownReplyStatusException
This exception indicates that an unknown reply status has been received.
Definition: LocalException.ice:799
Ice::CFNetworkException::domain
string domain
The domain of the error.
Definition: LocalException.ice:534
Ice::NoEndpointException::proxy
string proxy
The stringified proxy for which no suitable endpoint is available.
Definition: LocalException.ice:312
Ice::UnknownMessageException
This exception indicates that an unknown protocol message has been received.
Definition: LocalException.ice:767
BuiltinSequences.ice
Ice::VersionParseException::str
string str
Describes the failure and includes the string that could not be parsed.
Definition: LocalException.ice:363
Ice::ConnectionManuallyClosedException
This exception is raised by an operation call if the application closes the connection locally using ...
Definition: LocalException.ice:829
Ice::UnknownException
This exception is raised if an operation call on a server raises an unknown exception.
Definition: LocalException.ice:190
Ice::IllegalServantException
This exception is raised to reject an illegal servant (typically a null servant)
Definition: LocalException.ice:424
Ice::InitializationException
This exception is raised when a failure occurs during initialization.
Definition: LocalException.ice:40
Ice::EndpointSelectionTypeParseException
This exception is raised if there was an error while parsing an endpoint selection type.
Definition: LocalException.ice:340
Ice::ProxyParseException::str
string str
Describes the failure and includes the string that could not be parsed.
Definition: LocalException.ice:397
Ice::ConnectionRefusedException
This exception indicates a connection failure for which the server host actively refuses a connection...
Definition: LocalException.ice:567
Ice::SyscallException
This exception is raised if a system error occurred in the server or client process.
Definition: LocalException.ice:498
Ice::ConnectionManuallyClosedException::graceful
bool graceful
True if the connection was closed gracefully, false otherwise.
Definition: LocalException.ice:831
Ice::ProxyParseException
This exception is raised if there was an error while parsing a stringified proxy.
Definition: LocalException.ice:391
Ice::SocketException
This exception indicates socket errors.
Definition: LocalException.ice:518
Ice::VersionParseException
This exception is raised if there was an error while parsing a version.
Definition: LocalException.ice:357
Ice::EndpointParseException::str
string str
Describes the failure and includes the string that could not be parsed.
Definition: LocalException.ice:329
Ice::AlreadyRegisteredException::id
string id
The ID (or name) of the object that is registered already.
Definition: LocalException.ice:105
Ice::NoValueFactoryException::type
string type
The Slice type ID of the class instance for which no no factory could be found.
Definition: LocalException.ice:918
Ice::UnexpectedObjectException::type
string type
The Slice type ID of the class instance that was unmarshaled.
Definition: LocalException.ice:940
Ice::FixedProxyException
This exception indicates that an attempt has been made to change the connection properties of a fixed...
Definition: LocalException.ice:1026
Ice::ConnectTimeoutException
This exception indicates a connection establishment timeout condition.
Definition: LocalException.ice:634
Ice::FileException::path
string path
The path of the file responsible for the error.
Definition: LocalException.ice:546
Ice::ResponseSentException
Indicates that the response to a request has already been sent; re-dispatching such a request is not ...
Definition: LocalException.ice:1037
Ice::IdentityParseException
This exception is raised if there was an error while parsing a stringified identity.
Definition: LocalException.ice:374
Ice::BadMagicException
This exception indicates that a message did not start with the expected magic number ('I',...
Definition: LocalException.ice:705
Ice::EncodingVersion
A version structure for the encoding version.
Definition: Version.ice:46
Ice::UnsupportedProtocolException::bad
ProtocolVersion bad
The version of the unsupported protocol.
Definition: LocalException.ice:727
Ice::RequestFailedException
This exception is raised if a request failed.
Definition: LocalException.ice:443
Ice::ProtocolException::reason
string reason
The reason for the failure.
Definition: LocalException.ice:694
Ice::UnknownUserException
An operation raised an incorrect user exception.
Definition: LocalException.ice:233
Ice::AlreadyRegisteredException
An attempt was made to register something more than once with the Ice run time.
Definition: LocalException.ice:90
Ice::AlreadyRegisteredException::kindOfObject
string kindOfObject
The kind of object that could not be removed: "servant", "facet", "object", "default servant",...
Definition: LocalException.ice:98
Ice::ObjectAdapterIdInUseException
This exception is raised if an ObjectAdapter cannot be activated.
Definition: LocalException.ice:289
Ice::RequestFailedException::facet
string facet
The facet to which the request was sent.
Definition: LocalException.ice:448
Ice::UnsupportedEncodingException
This exception indicates an unsupported data encoding version.
Definition: LocalException.ice:744
Ice::FeatureNotSupportedException::unsupportedFeature
string unsupportedFeature
The name of the unsupported feature.
Definition: LocalException.ice:998
Ice::ObjectAdapterDeactivatedException::name
string name
Name of the adapter.
Definition: LocalException.ice:276
Ice::FacetNotExistException
This exception is raised if no facet with the given name exists, but at least one facet with the give...
Definition: LocalException.ice:473
Ice::ProtocolException
A generic exception base for all kinds of protocol error conditions.
Definition: LocalException.ice:688
Ice::TwowayOnlyException::operation
string operation
The name of the operation that was invoked.
Definition: LocalException.ice:160
Ice::DatagramLimitException
A datagram exceeds the configured size.
Definition: LocalException.ice:865
Ice::MarshalException
This exception is raised for errors during marshaling or unmarshaling data.
Definition: LocalException.ice:875
Ice::CollocationOptimizationException
This exception is raised if a feature is requested that is not supported with collocation optimizatio...
Definition: LocalException.ice:74
Ice::CommunicatorDestroyedException
This exception is raised if the Communicator has been destroyed.
Definition: LocalException.ice:256
Ice::DNSException
This exception indicates a DNS problem.
Definition: LocalException.ice:588
Ice::IllegalIdentityException::id
Identity id
The illegal identity.
Definition: LocalException.ice:413
Ice::UnknownRequestIdException
This exception indicates that a response for an unknown request ID has been received.
Definition: LocalException.ice:789
Ice::UnsupportedEncodingException::bad
EncodingVersion bad
The version of the unsupported encoding.
Definition: LocalException.ice:750
Ice::NotRegisteredException::id
string id
The ID (or name) of the object that could not be removed.
Definition: LocalException.ice:139
Ice::CFNetworkException
This exception indicates CFNetwork errors.
Definition: LocalException.ice:528
Ice::ConnectFailedException
This exception indicates connection failures.
Definition: LocalException.ice:556
Ice::ObjectNotExistException
This exception is raised if an object does not exist on the server, that is, if no facets with the gi...
Definition: LocalException.ice:462
Ice::NoValueFactoryException
This exception is raised if no suitable value factory was found during unmarshaling of a Slice class ...
Definition: LocalException.ice:911
Ice::IllegalIdentityException
This exception is raised if an illegal identity is encountered.
Definition: LocalException.ice:407
Ice::UnexpectedObjectException
This exception is raised if the type of an unmarshaled Slice class instance does not match its expect...
Definition: LocalException.ice:934
Ice::OperationNotExistException
This exception is raised if an operation for a given object does not exist on the server.
Definition: LocalException.ice:485
Ice::TimeoutException
This exception indicates a timeout condition.
Definition: LocalException.ice:624
Ice::PluginInitializationException::reason
string reason
The reason for the failure.
Definition: LocalException.ice:63
Ice::MemoryLimitException
This exception is raised when Ice receives a request or reply message whose size exceeds the limit sp...
Definition: LocalException.ice:959
Ice::InvocationCanceledException
This exception indicates that an asynchronous invocation failed because it was canceled explicitly by...
Definition: LocalException.ice:677
Ice::InitializationException::reason
string reason
The reason for the failure.
Definition: LocalException.ice:46
Ice::UnexpectedObjectException::expectedType
string expectedType
The Slice type ID that was expected by the receiving operation.
Definition: LocalException.ice:947
Ice::ObjectAdapterIdInUseException::id
string id
Adapter ID.
Definition: LocalException.ice:295
Ice::PluginInitializationException
This exception indicates that a failure occurred while initializing a plug-in.
Definition: LocalException.ice:57
Ice::UnknownException::unknown
string unknown
This field is set to the textual representation of the unknown exception if available.
Definition: LocalException.ice:197
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Version.ice
Ice::UnsupportedProtocolException
This exception indicates an unsupported protocol version.
Definition: LocalException.ice:721
Ice::ConnectionLostException
This exception indicates a lost connection.
Definition: LocalException.ice:577
Ice::OperationInterruptedException
This exception indicates a request was interrupted.
Definition: LocalException.ice:614
Ice::UnknownLocalException
This exception is raised if an operation call on a server raises a local exception.
Definition: LocalException.ice:213
Ice::RequestFailedException::id
Identity id
The identity of the Ice Object to which the request was sent.
Definition: LocalException.ice:445
Ice::UnmarshalOutOfBoundsException
This exception is raised if an out-of-bounds condition occurs during unmarshaling.
Definition: LocalException.ice:895
Identity.ice
Ice::CloneNotImplementedException
An attempt was made to clone a class that does not support cloning.
Definition: LocalException.ice:176
Ice::EncapsulationException
This exception indicates a malformed data encapsulation.
Definition: LocalException.ice:980
Ice::ConnectionNotValidatedException
This exception is raised if a message is received over a connection that is not yet validated.
Definition: LocalException.ice:778
Ice::CloseTimeoutException
This exception indicates a connection closure timeout condition.
Definition: LocalException.ice:644
Ice::SecurityException::reason
string reason
The reason for the failure.
Definition: LocalException.ice:1015
Ice::StringConversionException
This exception is raised when a string conversion to or from UTF-8 fails during marshaling or unmarsh...
Definition: LocalException.ice:970
Ice::NoEndpointException
This exception is raised if no suitable endpoint is available.
Definition: LocalException.ice:305
Ice::ObjectAdapterDeactivatedException
This exception is raised if an attempt is made to use a deactivated ObjectAdapter.
Definition: LocalException.ice:270
Ice::IdentityParseException::str
string str
Describes the failure and includes the string that could not be parsed.
Definition: LocalException.ice:380
Ice::Identity
The identity of an Ice object.
Definition: Identity.ice:40
Ice::ProxyUnmarshalException
This exception is raised if inconsistent data is received while unmarshaling a proxy.
Definition: LocalException.ice:885
Ice::RequestFailedException::operation
string operation
The operation name of the request.
Definition: LocalException.ice:451
Ice::TwowayOnlyException
The operation can only be invoked with a twoway request.
Definition: LocalException.ice:154
Ice::InvocationTimeoutException
This exception indicates that an invocation failed because it timed out.
Definition: LocalException.ice:666
Ice::NotRegisteredException::kindOfObject
string kindOfObject
The kind of object that could not be removed: "servant", "facet", "object", "default servant",...
Definition: LocalException.ice:132
Ice::CloseConnectionException
This exception indicates that the connection has been gracefully shut down by the server.
Definition: LocalException.ice:816
Ice::CompressionException
This exception indicates a problem with compressing or uncompressing data.
Definition: LocalException.ice:852
Ice::EndpointSelectionTypeParseException::str
string str
Describes the failure and includes the string that could not be parsed.
Definition: LocalException.ice:346
Ice::ProtocolVersion
A version structure for the protocol version.
Definition: Version.ice:35
Ice::FeatureNotSupportedException
This exception is raised if an unsupported feature is used.
Definition: LocalException.ice:992
Ice::FileException
This exception indicates file errors.
Definition: LocalException.ice:544
Ice::UnsupportedProtocolException::supported
ProtocolVersion supported
The version of the protocol that is supported.
Definition: LocalException.ice:734