zeroc-ice 3.7.9.1 → 3.8.0

data/slice/Ice/LocalException.ice

@@ -1,1040 +0,0 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:ICE_API"]]
-[["cpp:doxygen:include:Ice/Ice.h"]]
-[["cpp:header-ext:h"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["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
-{
-
-/**
- *
- * This exception is raised when a failure occurs during initialization.
- *
- **/
-["cpp:ice_print"]
-local exception InitializationException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception indicates that a failure occurred while initializing
- * a plug-in.
- *
- **/
-["cpp:ice_print"]
-local exception PluginInitializationException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception is raised if a feature is requested that is not
- * supported with collocation optimization.
- *
- **/
-["cpp:ice_print", "deprecate:This exception is no longer used by the Ice run time"]
-local exception CollocationOptimizationException
-{
-}
-
-/**
- *
- * An attempt was made to register something more than once with
- * the Ice run time.
- *
- * This exception is raised if an attempt is made to register a
- * servant, servant locator, facet, value factory, plug-in, object
- * adapter, object, or user exception factory more than once for the
- * same ID.
- *
- **/
-["cpp:ice_print"]
-local exception AlreadyRegisteredException
-{
-    /**
-     *
-     * 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;
-
-    /**
-     *
-     * The ID (or name) of the object that is registered already.
-     *
-     **/
-    string id;
-}
-
-/**
- *
- * An attempt was made to find or deregister something that is not
- * 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, 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
- * adapter when resolving an indirect proxy or when an object adapter
- * is activated.
- *
- **/
-["cpp:ice_print"]
-local exception NotRegisteredException
-{
-    /**
-     *
-     * 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;
-
-    /**
-     *
-     * The ID (or name) of the object that could not be removed.
-     *
-     **/
-    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 <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.
- *
- **/
-["cpp:ice_print"]
-local exception TwowayOnlyException
-{
-    /**
-     *
-     * The name of the operation that was invoked.
-     *
-     **/
-    string operation;
-}
-
-/**
- *
- * An attempt was made to clone a class that does not support
- * cloning.
- *
- * 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 <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 <code>Ice::LocalException</code> or
- * <code>Ice::UserException</code>.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownException
-{
-    /**
-     *
-     * This field is set to the textual representation of the unknown
-     * exception if available.
-     *
-     **/
-    string unknown;
-}
-
-/**
- *
- * This exception is raised if an operation call on a server raises a
- * local exception. Because local exceptions are not transmitted by
- * the Ice protocol, the client receives all local exceptions raised
- * 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 <code>local</code>.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownLocalException extends UnknownException
-{
-}
-
-/**
- *
- * An operation raised an incorrect user exception.
- *
- * This exception is raised if an operation raises a
- * user exception that is not declared in the exception's
- * <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
- * <code>throws</code> clause can be raised.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownUserException extends UnknownException
-{
-}
-
-/**
- *
- * This exception is raised if the Ice library version does not match
- * the version in the Ice header files.
- *
- **/
-["cpp:ice_print"]
-local exception VersionMismatchException
-{
-}
-
-/**
- *
- * This exception is raised if the {@link Communicator} has been destroyed.
- *
- * @see Communicator#destroy
- *
- **/
-["cpp:ice_print"]
-local exception CommunicatorDestroyedException
-{
-}
-
-/**
- *
- * This exception is raised if an attempt is made to use a deactivated
- * {@link ObjectAdapter}.
- *
- * @see ObjectAdapter#deactivate
- * @see Communicator#shutdown
- *
- **/
-["cpp:ice_print"]
-local exception ObjectAdapterDeactivatedException
-{
-    /**
-     *
-     * Name of the adapter.
-     *
-     **/
-    string name;
-}
-
-/**
- *
- * This exception is raised if an {@link ObjectAdapter} cannot be activated.
- *
- * This happens if the {@link Locator} detects another active {@link ObjectAdapter} with
- * the same adapter id.
- *
- **/
-["cpp:ice_print"]
-local exception ObjectAdapterIdInUseException
-{
-    /**
-     *
-     * Adapter ID.
-     *
-     **/
-    string id;
-}
-
-/**
- *
- * This exception is raised if no suitable endpoint is available.
- *
- **/
-["cpp:ice_print"]
-local exception NoEndpointException
-{
-    /**
-     *
-     * The stringified proxy for which no suitable endpoint is
-     * available.
-     *
-     **/
-    string proxy;
-}
-
-/**
- *
- * This exception is raised if there was an error while parsing an
- * endpoint.
- *
- **/
-["cpp:ice_print"]
-local exception EndpointParseException
-{
-    /**
-     *
-     * Describes the failure and includes the string that could not be parsed.
-     *
-     **/
-    string str;
-}
-
-/**
- *
- * This exception is raised if there was an error while parsing an
- * endpoint selection type.
- *
- **/
-["cpp:ice_print"]
-local exception EndpointSelectionTypeParseException
-{
-    /**
-     *
-     * Describes the failure and includes the string that could not be parsed.
-     *
-     **/
-    string str;
-}
-
-/**
- *
- * This exception is raised if there was an error while parsing a
- * version.
- *
- **/
-["cpp:ice_print"]
-local exception VersionParseException
-{
-    /**
-     *
-     * Describes the failure and includes the string that could not be parsed.
-     *
-     **/
-    string str;
-}
-
-/**
- *
- * This exception is raised if there was an error while parsing a
- * stringified identity.
- *
- **/
-["cpp:ice_print"]
-local exception IdentityParseException
-{
-    /**
-     *
-     * Describes the failure and includes the string that could not be parsed.
-     *
-     **/
-    string str;
-}
-
-/**
- *
- * This exception is raised if there was an error while parsing a
- * stringified proxy.
- *
- **/
-["cpp:ice_print"]
-local exception ProxyParseException
-{
-    /**
-     *
-     * Describes the failure and includes the string that could not be parsed.
-     *
-     **/
-    string str;
-}
-
-/**
- *
- * This exception is raised if an illegal identity is encountered.
- *
- **/
-["cpp:ice_print"]
-local exception IllegalIdentityException
-{
-    /**
-     *
-     * The illegal identity.
-     *
-     **/
-    Identity id;
-}
-
-/**
- *
- * This exception is raised to reject an illegal servant (typically
- * a null servant)
- *
- **/
-["cpp:ice_print"]
-local exception IllegalServantException
-{
-    /**
-     *
-     * Describes why this servant is illegal.
-     *
-     **/
-    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
- * <code>local</code>.
- *
- **/
-["cpp:ice_print"]
-local exception RequestFailedException
-{
-    /** The identity of the Ice Object to which the request was sent. */
-    Identity id;
-
-    /** The facet to which the request was sent. */
-    string facet;
-
-    /** The operation name of the request. */
-    string operation;
-}
-
-/**
- *
- * This exception is raised if an object does not exist on the server,
- * that is, if no facets with the given identity exist.
- *
- **/
-["cpp:ice_print"]
-local exception ObjectNotExistException extends RequestFailedException
-{
-}
-
-/**
- *
- * This exception is raised if no facet with the given name exists,
- * but at least one facet with the given identity exists.
- *
- **/
-["cpp:ice_print"]
-local exception FacetNotExistException extends RequestFailedException
-{
-}
-
-/**
- *
- * This exception is raised if an operation for a given object does
- * not exist on the server. Typically this is caused by either the
- * client or the server using an outdated Slice specification.
- *
- **/
-["cpp:ice_print"]
-local exception OperationNotExistException extends RequestFailedException
-{
-}
-
-/**
- *
- * This exception is raised if a system error occurred in the server
- * or client process. There are many possible causes for such a system
- * exception. For details on the cause, {@link SyscallException#error}
- * should be inspected.
- *
- **/
-["cpp:ice_print"]
-local exception SyscallException
-{
-    /**
-     *
-     * The error number describing the system exception. For C++ and
-     * Unix, this is equivalent to <code>errno</code>. For C++
-     * and Windows, this is the value returned by
-     * <code>GetLastError()</code> or
-     * <code>WSAGetLastError()</code>.
-     *
-     **/
-    int error = 0; // Don't use errno, as errno is usually a macro.
-}
-
-/**
- *
- * This exception indicates socket errors.
- *
- **/
-["cpp:ice_print"]
-local exception SocketException extends SyscallException
-{
-}
-
-/**
- *
- * This exception indicates CFNetwork errors.
- *
- **/
-["cpp:ice_print"]
-local exception CFNetworkException extends SocketException
-{
-    /**
-     *
-     * The domain of the error.
-     *
-     **/
-    string domain;
-}
-
-/**
- *
- * This exception indicates file errors.
- *
- **/
-["cpp:ice_print"]
-local exception FileException extends SyscallException
-{
-    /** The path of the file responsible for the error. */
-    string path;
-}
-
-/**
- *
- * This exception indicates connection failures.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectFailedException extends SocketException
-{
-}
-
-/**
- *
- * This exception indicates a connection failure for which
- * the server host actively refuses a connection.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectionRefusedException extends ConnectFailedException
-{
-}
-
-/**
- *
- * This exception indicates a lost connection.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectionLostException extends SocketException
-{
-}
-
-/**
- *
- * This exception indicates a DNS problem. For details on the cause,
- * {@link DNSException#error} should be inspected.
- *
- **/
-["cpp:ice_print"]
-local exception DNSException
-{
-    /**
-     *
-     * The error number describing the DNS problem. For C++ and Unix,
-     * this is equivalent to <code>h_errno</code>. For C++ and
-     * Windows, this is the value returned by
-     * <code>WSAGetLastError()</code>.
-     *
-     **/
-    int error = 0; // Don't use h_errno, as h_errno is usually a macro.
-
-    /**
-     *
-     * The host name that could not be resolved.
-     *
-     **/
-    string host;
-}
-
-/**
- *
- * This exception indicates a request was interrupted.
- *
- **/
-["cpp:ice_print"]
-local exception OperationInterruptedException
-{
-}
-
-/**
- *
- * This exception indicates a timeout condition.
- *
- **/
-["cpp:ice_print"]
-local exception TimeoutException
-{
-}
-
-/**
- *
- * This exception indicates a connection establishment timeout condition.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectTimeoutException extends TimeoutException
-{
-}
-
-/**
- *
- * This exception indicates a connection closure timeout condition.
- *
- **/
-["cpp:ice_print"]
-local exception CloseTimeoutException extends TimeoutException
-{
-}
-
-/**
- *
- * This exception indicates that a connection has been shut down because it has been
- * idle for some time.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectionTimeoutException extends TimeoutException
-{
-}
-
-/**
- *
- * This exception indicates that an invocation failed because it timed
- * out.
- *
- **/
-["cpp:ice_print"]
-local exception InvocationTimeoutException extends TimeoutException
-{
-}
-
-/**
- *
- * This exception indicates that an asynchronous invocation failed
- * because it was canceled explicitly by the user.
- *
- **/
-["cpp:ice_print"]
-local exception InvocationCanceledException
-{
-}
-
-/**
- *
- * A generic exception base for all kinds of protocol error
- * conditions.
- *
- **/
-["cpp:ice_print"]
-local exception ProtocolException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception indicates that a message did not start with the expected
- * magic number ('I', 'c', 'e', 'P').
- *
- **/
-["cpp:ice_print"]
-local exception BadMagicException extends ProtocolException
-{
-    /**
-     *
-     * A sequence containing the first four bytes of the incorrect message.
-     *
-     **/
-    ByteSeq badMagic;
-}
-
-/**
- *
- * This exception indicates an unsupported protocol version.
- *
- **/
-["cpp:ice_print"]
-local exception UnsupportedProtocolException extends ProtocolException
-{
-    /**
-     *
-     * The version of the unsupported protocol.
-     *
-     **/
-    ProtocolVersion bad;
-
-    /**
-     *
-     * The version of the protocol that is supported.
-     *
-     **/
-    ProtocolVersion supported;
-}
-
-/**
- *
- * This exception indicates an unsupported data encoding version.
- *
- **/
-["cpp:ice_print"]
-local exception UnsupportedEncodingException extends ProtocolException
-{
-    /**
-     *
-     * The version of the unsupported encoding.
-     *
-     **/
-    EncodingVersion bad;
-
-    /**
-     *
-     * The version of the encoding that is supported.
-     *
-     **/
-    EncodingVersion supported;
-}
-
-/**
- *
- * This exception indicates that an unknown protocol message has been received.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownMessageException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception is raised if a message is received over a connection
- * that is not yet validated.
- *
- **/
-["cpp:ice_print"]
-local exception ConnectionNotValidatedException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception indicates that a response for an unknown request ID has been
- * received.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownRequestIdException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception indicates that an unknown reply status has been received.
- *
- **/
-["cpp:ice_print"]
-local exception UnknownReplyStatusException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception indicates that the connection has been gracefully shut down by the
- * server. The operation call that caused this exception has not been
- * executed by the server. In most cases you will not get this
- * exception, because the client will automatically retry the
- * operation call in case the server shut down the connection. However,
- * if upon retry the server shuts down the connection again, and the
- * retry limit has been reached, then this exception is propagated to
- * the application code.
- *
- **/
-["cpp:ice_print"]
-local exception CloseConnectionException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception is raised by an operation call if the application
- * closes the connection locally using {@link Connection#close}.
- *
- * @see Connection#close
- *
- **/
-["cpp:ice_print"]
-local exception ConnectionManuallyClosedException
-{
-    /** True if the connection was closed gracefully, false otherwise. **/
-    bool graceful;
-}
-
-/**
- *
- * This exception indicates that a message size is less
- * than the minimum required size.
- *
- **/
-["cpp:ice_print"]
-local exception IllegalMessageSizeException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception indicates a problem with compressing or uncompressing data.
- *
- **/
-["cpp:ice_print"]
-local exception CompressionException extends ProtocolException
-{
-}
-
-/**
- *
- * A datagram exceeds the configured size.
- *
- * This exception is raised if a datagram exceeds the configured send or receive buffer
- * size, or exceeds the maximum payload size of a UDP packet (65507 bytes).
- *
- **/
-["cpp:ice_print"]
-local exception DatagramLimitException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception is raised for errors during marshaling or unmarshaling data.
- *
- **/
-["cpp:ice_print"]
-local exception MarshalException extends ProtocolException
-{
-}
-
-/**
- *
- * This exception is raised if inconsistent data is received while unmarshaling a proxy.
- *
- **/
-["cpp:ice_print"]
-local exception ProxyUnmarshalException extends MarshalException
-{
-}
-
-/**
- *
- * This exception is raised if an out-of-bounds condition occurs during unmarshaling.
- *
- **/
-["cpp:ice_print"]
-local exception UnmarshalOutOfBoundsException extends MarshalException
-{
-}
-
-/**
- *
- * This exception is raised if no suitable value factory was found during
- * unmarshaling of a Slice class instance.
- *
- * @see ValueFactory
- * @see Communicator#getValueFactoryManager
- * @see ValueFactoryManager#add
- * @see ValueFactoryManager#find
- *
- **/
-["cpp:ice_print"]
-local exception NoValueFactoryException extends MarshalException
-{
-    /**
-     *
-     * The Slice type ID of the class instance for which no
-     * no factory could be found.
-     *
-     **/
-    string type;
-}
-
-/**
- *
- * This exception is raised if the type of an unmarshaled Slice class instance does
- * not match its expected type.
- * This can happen if client and server are compiled with mismatched Slice
- * definitions or if a class of the wrong type is passed as a parameter
- * or return value using dynamic invocation. This exception can also be
- * raised if IceStorm is used to send Slice class instances and
- * an operation is subscribed to the wrong topic.
- *
- **/
-["cpp:ice_print"]
-local exception UnexpectedObjectException extends MarshalException
-{
-    /**
-     *
-     * The Slice type ID of the class instance that was unmarshaled.
-     *
-     **/
-    string type;
-
-    /**
-     *
-     * The Slice type ID that was expected by the receiving operation.
-     *
-     **/
-    string expectedType;
-}
-
-/**
- *
- * This exception is raised when Ice receives a request or reply
- * message whose size exceeds the limit specified by the
- * <code>Ice.MessageSizeMax</code> property.
- *
- **/
-["cpp:ice_print"]
-local exception MemoryLimitException extends MarshalException
-{
-}
-
-/**
- *
- * This exception is raised when a string conversion to or from UTF-8
- * fails during marshaling or unmarshaling.
- *
- **/
-["cpp:ice_print"]
-local exception StringConversionException extends MarshalException
-{
-}
-
-/**
- *
- * This exception indicates a malformed data encapsulation.
- *
- **/
-["cpp:ice_print"]
-local exception EncapsulationException extends MarshalException
-{
-}
-
-/**
- *
- * This exception is raised if an unsupported feature is used. The
- * unsupported feature string contains the name of the unsupported
- * feature
- *
- **/
-["cpp:ice_print"]
-local exception FeatureNotSupportedException
-{
-    /**
-     *
-     * The name of the unsupported feature.
-     *
-     **/
-    string unsupportedFeature;
-}
-
-/**
- *
- * This exception indicates a failure in a security subsystem,
- * such as the IceSSL plug-in.
- *
- **/
-["cpp:ice_print"]
-local exception SecurityException
-{
-    /**
-     *
-     * The reason for the failure.
-     *
-     **/
-    string reason;
-}
-
-/**
- *
- * This exception indicates that an attempt has been made to
- * change the connection properties of a fixed proxy.
- *
- **/
-["cpp:ice_print"]
-local exception FixedProxyException
-{
-}
-
-/**
- *
- * Indicates that the response to a request has already been sent;
- * re-dispatching such a request is not possible.
- *
- **/
-["cpp:ice_print"]
-local exception ResponseSentException
-{
-}
-
-}