zeroc-ice 3.6.5 → 3.7.4

data/slice/Ice/LocalException.ice

@@ -1,20 +1,30 @@
-// **********************************************************************
 //
-// Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
+// Copyright (c) ZeroC, Inc. All rights reserved.
 //
-// This copy of Ice is licensed to you under the terms described in the
-// ICE_LICENSE file included in this distribution.
-//
-// **********************************************************************
 
 #pragma once
 
-[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
+[["cpp:dll-export:ICE_API"]]
+[["cpp:doxygen:include:Ice/Ice.h"]]
+[["cpp:header-ext:h"]]
+
+[["ice-prefix"]]
+
+[["js:module:ice"]]
+
+[["objc:dll-export:ICE_API"]]
+[["objc:header-dir:objc"]]
+
+[["python:pkgdir:Ice"]]
 
 #include <Ice/Identity.ice>
 #include <Ice/Version.ice>
 #include <Ice/BuiltinSequences.ice>
 
+#ifndef __SLICE2JAVA_COMPAT__
+[["java:package:com.zeroc"]]
+#endif
+
 ["objc:prefix:ICE"]
 module Ice
 {
@@ -33,7 +43,7 @@ local exception InitializationException
      *
      **/
     string reason;
-};
+}
 
 /**
  *
@@ -50,7 +60,7 @@ local exception PluginInitializationException
      *
      **/
     string reason;
-};
+}
 
 /**
  *
@@ -61,7 +71,7 @@ local exception PluginInitializationException
 ["cpp:ice_print", "deprecate:This exception is no longer used by the Ice run time"]
 local exception CollocationOptimizationException
 {
-};
+}
 
 /**
  *
@@ -69,7 +79,7 @@ local exception CollocationOptimizationException
  * the Ice run time.
  *
  * This exception is raised if an attempt is made to register a
- * servant, servant locator, facet, object factory, plug-in, object
+ * servant, servant locator, facet, value factory, plug-in, object
  * adapter, object, or user exception factory more than once for the
  * same ID.
  *
@@ -79,9 +89,9 @@ local exception AlreadyRegisteredException
 {
     /**
      *
-     * The kind of object that is registered already: "servant",
-     * "servant locator", "object factory", "plug-in",
-     * "object adapter", "object", or "user exception factory".
+     * The kind of object that could not be removed: "servant", "facet",
+     * "object", "default servant", "servant locator", "value factory", "plugin",
+     * "object adapter", "object adapter with router", "replica group".
      *
      **/
     string kindOfObject;
@@ -92,7 +102,7 @@ local exception AlreadyRegisteredException
      *
      **/
     string id;
-};
+}
 
 /**
  *
@@ -100,7 +110,7 @@ local exception AlreadyRegisteredException
  * registered with the Ice run time or Ice locator.
  *
  * This exception is raised if an attempt is made to remove a servant,
- * servant locator, facet, object factory, plug-in, object adapter,
+ * servant locator, facet, value factory, plug-in, object adapter,
  * object, or user exception factory that is not currently registered.
  *
  * It's also raised if the Ice locator can't find an object or object
@@ -113,9 +123,9 @@ local exception NotRegisteredException
 {
     /**
      *
-     * The kind of object that could not be removed: "servant",
-     * "servant locator", "object factory", "plug-in",
-     * "object adapter", "object", or "user exception factory".
+     * The kind of object that could not be removed: "servant", "facet",
+     * "object", "default servant", "servant locator", "value factory", "plugin",
+     * "object adapter", "object adapter with router", "replica group".
      *
      **/
     string kindOfObject;
@@ -126,15 +136,15 @@ local exception NotRegisteredException
      *
      **/
     string id;
-};
+}
 
 /**
  *
  * The operation can only be invoked with a twoway request.
  *
  * This exception is raised if an attempt is made to invoke an
- * operation with <tt>ice_oneway</tt>, <tt>ice_batchOneway</tt>, <tt>ice_datagram</tt>,
- * or <tt>ice_batchDatagram</tt> and the operation has a return value,
+ * operation with <code>ice_oneway</code>, <code>ice_batchOneway</code>, <code>ice_datagram</code>,
+ * or <code>ice_batchDatagram</code> and the operation has a return value,
  * out-parameters, or an exception specification.
  *
  **/
@@ -147,31 +157,31 @@ local exception TwowayOnlyException
      *
      **/
     string operation;
-};
+}
 
 /**
  *
  * An attempt was made to clone a class that does not support
  * cloning.
  *
- * This exception is raised if <tt>ice_clone</tt> is called on
+ * This exception is raised if <code>ice_clone</code> is called on
  * a class that is derived from an abstract Slice class (that is,
  * a class containing operations), and the derived class does not
- * provide an implementation of the <tt>ice_clone</tt> operation (C++ only).
+ * provide an implementation of the <code>ice_clone</code> operation (C++ only).
  *
  **/
 ["cpp:ice_print"]
 local exception CloneNotImplementedException
 {
-};
+}
 
 /**
  *
  * This exception is raised if an operation call on a server raises an
  * unknown exception. For example, for C++, this exception is raised
  * if the server throws a C++ exception that is not directly or
- * indirectly derived from <tt>Ice::LocalException</tt> or
- * <tt>Ice::UserException</tt>.
+ * indirectly derived from <code>Ice::LocalException</code> or
+ * <code>Ice::UserException</code>.
  *
  **/
 ["cpp:ice_print"]
@@ -184,7 +194,7 @@ local exception UnknownException
      *
      **/
     string unknown;
-};
+}
 
 /**
  *
@@ -194,13 +204,13 @@ local exception UnknownException
  * by the server as {@link UnknownLocalException}. The only exception to this
  * rule are all exceptions derived from {@link RequestFailedException},
  * which are transmitted by the Ice protocol even though they are
- * declared <tt>local</tt>.
+ * declared <code>local</code>.
  *
  **/
 ["cpp:ice_print"]
 local exception UnknownLocalException extends UnknownException
 {
-};
+}
 
 /**
  *
@@ -208,19 +218,19 @@ local exception UnknownLocalException extends UnknownException
  *
  * This exception is raised if an operation raises a
  * user exception that is not declared in the exception's
- * <tt>throws</tt> clause. Such undeclared exceptions are
+ * <code>throws</code> clause. Such undeclared exceptions are
  * not transmitted from the server to the client by the Ice
  * protocol, but instead the client just gets an
  * {@link UnknownUserException}. This is necessary in order to not violate
  * the contract established by an operation's signature: Only local
  * exceptions and user exceptions declared in the
- * <tt>throws</tt> clause can be raised.
+ * <code>throws</code> clause can be raised.
  *
  **/
 ["cpp:ice_print"]
 local exception UnknownUserException extends UnknownException
 {
-};
+}
 
 /**
  *
@@ -231,7 +241,7 @@ local exception UnknownUserException extends UnknownException
 ["cpp:ice_print"]
 local exception VersionMismatchException
 {
-};
+}
 
 /**
  *
@@ -243,7 +253,7 @@ local exception VersionMismatchException
 ["cpp:ice_print"]
 local exception CommunicatorDestroyedException
 {
-};
+}
 
 /**
  *
@@ -263,7 +273,7 @@ local exception ObjectAdapterDeactivatedException
      *
      **/
     string name;
-};
+}
 
 /**
  *
@@ -282,7 +292,7 @@ local exception ObjectAdapterIdInUseException
      *
      **/
     string id;
-};
+}
 
 /**
  *
@@ -299,7 +309,7 @@ local exception NoEndpointException
      *
      **/
     string proxy;
-};
+}
 
 /**
  *
@@ -316,7 +326,7 @@ local exception EndpointParseException
      *
      **/
     string str;
-};
+}
 
 /**
  *
@@ -333,7 +343,7 @@ local exception EndpointSelectionTypeParseException
      *
      **/
     string str;
-};
+}
 
 /**
  *
@@ -350,7 +360,7 @@ local exception VersionParseException
      *
      **/
     string str;
-};
+}
 
 /**
  *
@@ -367,7 +377,7 @@ local exception IdentityParseException
      *
      **/
     string str;
-};
+}
 
 /**
  *
@@ -384,7 +394,7 @@ local exception ProxyParseException
      *
      **/
     string str;
-};
+}
 
 /**
  *
@@ -400,7 +410,7 @@ local exception IllegalIdentityException
      *
      **/
     Identity id;
-};
+}
 
 /**
  *
@@ -417,15 +427,14 @@ local exception IllegalServantException
      *
      **/
     string reason;
-};
-
+}
 
 /**
  *
  * This exception is raised if a request failed. This exception, and
  * all exceptions derived from {@link RequestFailedException}, are
  * transmitted by the Ice protocol, even though they are declared
- * <tt>local</tt>.
+ * <code>local</code>.
  *
  **/
 ["cpp:ice_print"]
@@ -439,7 +448,7 @@ local exception RequestFailedException
 
     /** The operation name of the request. */
     string operation;
-};
+}
 
 /**
  *
@@ -450,7 +459,7 @@ local exception RequestFailedException
 ["cpp:ice_print"]
 local exception ObjectNotExistException extends RequestFailedException
 {
-};
+}
 
 /**
  *
@@ -461,7 +470,7 @@ local exception ObjectNotExistException extends RequestFailedException
 ["cpp:ice_print"]
 local exception FacetNotExistException extends RequestFailedException
 {
-};
+}
 
 /**
  *
@@ -473,7 +482,7 @@ local exception FacetNotExistException extends RequestFailedException
 ["cpp:ice_print"]
 local exception OperationNotExistException extends RequestFailedException
 {
-};
+}
 
 /**
  *
@@ -489,14 +498,14 @@ local exception SyscallException
     /**
      *
      * The error number describing the system exception. For C++ and
-     * Unix, this is equivalent to <tt>errno</tt>. For C++
+     * Unix, this is equivalent to <code>errno</code>. For C++
      * and Windows, this is the value returned by
-     * <tt>GetLastError()</tt> or
-     * <tt>WSAGetLastError()</tt>.
+     * <code>GetLastError()</code> or
+     * <code>WSAGetLastError()</code>.
      *
      **/
     int error = 0; // Don't use errno, as errno is usually a macro.
-};
+}
 
 /**
  *
@@ -506,14 +515,13 @@ local exception SyscallException
 ["cpp:ice_print"]
 local exception SocketException extends SyscallException
 {
-};
+}
 
 /**
  *
  * This exception indicates CFNetwork errors.
  *
  **/
-#ifdef ICE_USE_CFSTREAM
 ["cpp:ice_print"]
 local exception CFNetworkException extends SocketException
 {
@@ -523,8 +531,7 @@ local exception CFNetworkException extends SocketException
      *
      **/
     string domain;
-};
-#endif
+}
 
 /**
  *
@@ -536,7 +543,7 @@ local exception FileException extends SyscallException
 {
     /** The path of the file responsible for the error. */
     string path;
-};
+}
 
 /**
  *
@@ -546,7 +553,7 @@ local exception FileException extends SyscallException
 ["cpp:ice_print"]
 local exception ConnectFailedException extends SocketException
 {
-};
+}
 
 /**
  *
@@ -557,7 +564,7 @@ local exception ConnectFailedException extends SocketException
 ["cpp:ice_print"]
 local exception ConnectionRefusedException extends ConnectFailedException
 {
-};
+}
 
 /**
  *
@@ -567,7 +574,7 @@ local exception ConnectionRefusedException extends ConnectFailedException
 ["cpp:ice_print"]
 local exception ConnectionLostException extends SocketException
 {
-};
+}
 
 /**
  *
@@ -581,9 +588,9 @@ local exception DNSException
     /**
      *
      * The error number describing the DNS problem. For C++ and Unix,
-     * this is equivalent to <tt>h_errno</tt>. For C++ and
+     * this is equivalent to <code>h_errno</code>. For C++ and
      * Windows, this is the value returned by
-     * <tt>WSAGetLastError()</tt>.
+     * <code>WSAGetLastError()</code>.
      *
      **/
     int error = 0; // Don't use h_errno, as h_errno is usually a macro.
@@ -594,7 +601,7 @@ local exception DNSException
      *
      **/
     string host;
-};
+}
 
 /**
  *
@@ -604,7 +611,7 @@ local exception DNSException
 ["cpp:ice_print"]
 local exception OperationInterruptedException
 {
-};
+}
 
 /**
  *
@@ -614,7 +621,7 @@ local exception OperationInterruptedException
 ["cpp:ice_print"]
 local exception TimeoutException
 {
-};
+}
 
 /**
  *
@@ -624,7 +631,7 @@ local exception TimeoutException
 ["cpp:ice_print"]
 local exception ConnectTimeoutException extends TimeoutException
 {
-};
+}
 
 /**
  *
@@ -634,7 +641,7 @@ local exception ConnectTimeoutException extends TimeoutException
 ["cpp:ice_print"]
 local exception CloseTimeoutException extends TimeoutException
 {
-};
+}
 
 /**
  *
@@ -645,7 +652,7 @@ local exception CloseTimeoutException extends TimeoutException
 ["cpp:ice_print"]
 local exception ConnectionTimeoutException extends TimeoutException
 {
-};
+}
 
 /**
  *
@@ -656,7 +663,7 @@ local exception ConnectionTimeoutException extends TimeoutException
 ["cpp:ice_print"]
 local exception InvocationTimeoutException extends TimeoutException
 {
-};
+}
 
 /**
  *
@@ -667,7 +674,7 @@ local exception InvocationTimeoutException extends TimeoutException
 ["cpp:ice_print"]
 local exception InvocationCanceledException
 {
-};
+}
 
 /**
  *
@@ -684,7 +691,7 @@ local exception ProtocolException
      *
      **/
     string reason;
-};
+}
 
 /**
  *
@@ -701,7 +708,7 @@ local exception BadMagicException extends ProtocolException
      *
      **/
     ByteSeq badMagic;
-};
+}
 
 /**
  *
@@ -724,7 +731,7 @@ local exception UnsupportedProtocolException extends ProtocolException
      *
      **/
     ProtocolVersion supported;
-};
+}
 
 /**
  *
@@ -747,7 +754,7 @@ local exception UnsupportedEncodingException extends ProtocolException
      *
      **/
     EncodingVersion supported;
-};
+}
 
 /**
  *
@@ -757,7 +764,7 @@ local exception UnsupportedEncodingException extends ProtocolException
 ["cpp:ice_print"]
 local exception UnknownMessageException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -768,7 +775,7 @@ local exception UnknownMessageException extends ProtocolException
 ["cpp:ice_print"]
 local exception ConnectionNotValidatedException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -779,7 +786,7 @@ local exception ConnectionNotValidatedException extends ProtocolException
 ["cpp:ice_print"]
 local exception UnknownRequestIdException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -789,7 +796,7 @@ local exception UnknownRequestIdException extends ProtocolException
 ["cpp:ice_print"]
 local exception UnknownReplyStatusException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -806,20 +813,22 @@ local exception UnknownReplyStatusException extends ProtocolException
 ["cpp:ice_print"]
 local exception CloseConnectionException extends ProtocolException
 {
-};
+}
 
 /**
  *
  * This exception is raised by an operation call if the application
- * forcefully closes the connection {@link Connection#close}.
+ * closes the connection locally using {@link Connection#close}.
  *
  * @see Connection#close
  *
  **/
 ["cpp:ice_print"]
-local exception ForcedCloseConnectionException extends ProtocolException
+local exception ConnectionManuallyClosedException
 {
-};
+    /** True if the connection was closed gracefully, false otherwise. **/
+    bool graceful;
+}
 
 /**
  *
@@ -830,7 +839,7 @@ local exception ForcedCloseConnectionException extends ProtocolException
 ["cpp:ice_print"]
 local exception IllegalMessageSizeException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -840,7 +849,7 @@ local exception IllegalMessageSizeException extends ProtocolException
 ["cpp:ice_print"]
 local exception CompressionException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -853,7 +862,7 @@ local exception CompressionException extends ProtocolException
 ["cpp:ice_print"]
 local exception DatagramLimitException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -863,7 +872,7 @@ local exception DatagramLimitException extends ProtocolException
 ["cpp:ice_print"]
 local exception MarshalException extends ProtocolException
 {
-};
+}
 
 /**
  *
@@ -873,7 +882,7 @@ local exception MarshalException extends ProtocolException
 ["cpp:ice_print"]
 local exception ProxyUnmarshalException extends MarshalException
 {
-};
+}
 
 /**
  *
@@ -883,20 +892,21 @@ local exception ProxyUnmarshalException extends MarshalException
 ["cpp:ice_print"]
 local exception UnmarshalOutOfBoundsException extends MarshalException
 {
-};
+}
 
 /**
  *
- * This exception is raised if no suitable object factory was found during
+ * This exception is raised if no suitable value factory was found during
  * unmarshaling of a Slice class instance.
  *
- * @see ObjectFactory
- * @see Communicator#addObjectFactory
- * @see Communicator#findObjectFactory
+ * @see ValueFactory
+ * @see Communicator#getValueFactoryManager
+ * @see ValueFactoryManager#add
+ * @see ValueFactoryManager#find
  *
  **/
 ["cpp:ice_print"]
-local exception NoObjectFactoryException extends MarshalException
+local exception NoValueFactoryException extends MarshalException
 {
     /**
      *
@@ -905,7 +915,7 @@ local exception NoObjectFactoryException extends MarshalException
      *
      **/
     string type;
-};
+}
 
 /**
  *
@@ -934,19 +944,19 @@ local exception UnexpectedObjectException extends MarshalException
      *
      **/
     string expectedType;
-};
+}
 
 /**
  *
  * This exception is raised when Ice receives a request or reply
  * message whose size exceeds the limit specified by the
- * <tt>Ice.MessageSizeMax</tt> property.
+ * <code>Ice.MessageSizeMax</code> property.
  *
  **/
 ["cpp:ice_print"]
 local exception MemoryLimitException extends MarshalException
 {
-};
+}
 
 /**
  *
@@ -957,8 +967,7 @@ local exception MemoryLimitException extends MarshalException
 ["cpp:ice_print"]
 local exception StringConversionException extends MarshalException
 {
-};
-
+}
 
 /**
  *
@@ -968,7 +977,7 @@ local exception StringConversionException extends MarshalException
 ["cpp:ice_print"]
 local exception EncapsulationException extends MarshalException
 {
-};
+}
 
 /**
  *
@@ -986,8 +995,7 @@ local exception FeatureNotSupportedException
      *
      **/
     string unsupportedFeature;
-};
-
+}
 
 /**
  *
@@ -1004,7 +1012,7 @@ local exception SecurityException
      *
      **/
     string reason;
-};
+}
 
 /**
  *
@@ -1015,7 +1023,7 @@ local exception SecurityException
 ["cpp:ice_print"]
 local exception FixedProxyException
 {
-};
+}
 
 /**
  *
@@ -1026,8 +1034,6 @@ local exception FixedProxyException
 ["cpp:ice_print"]
 local exception ResponseSentException
 {
-};
-
-
-};
+}
 
+}