zeroc-ice 3.7.10 → 3.8.0

data/slice/IceGrid/PluginFacade.ice

@@ -1,329 +0,0 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:ICEGRID_API"]]
-[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:IceGrid/Config.h"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:IceGrid"]]
-
-#include <Ice/BuiltinSequences.ice>
-#include <Ice/Current.ice>
-
-#include <IceGrid/Admin.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICEGRID"]
-module IceGrid
-{
-
-/**
- *
- * The ReplicaGroupFilter is used by IceGrid to filter adapters
- * returned to the client when it resolves a filtered replica group.
- *
- * IceGrid provides the list of available adapters. The implementation
- * of this method can use the provided context and connection to
- * filter and return the filtered set of adapters.
- *
- **/
-local interface ReplicaGroupFilter
-{
-    /**
-     *
-     * Filter the the given set of adapters.
-     *
-     * @param replicaGroupId The replica group ID.
-     *
-     * @param adapterIds The adpater IDs to filter.
-     *
-     * @param con The connection from the Ice client which is
-     * resolving the replica group endpoints.
-     *
-     * @param ctx The context from the Ice client which is resolving
-     * the replica group endpoints.
-     *
-     * @return The filtered adapter IDs.
-     *
-     **/
-    Ice::StringSeq filter(string replicaGroupId, Ice::StringSeq adapterIds, Ice::Connection con, Ice::Context ctx);
-}
-
-/**
- *
- * The TypeFilter is used by IceGrid to filter well-known proxies
- * returned to the client when it searches a well-known object by
- * type.
- *
- * IceGrid provides the list of available proxies. The implementation
- * of this method can use the provided context and connection to
- * filter and return the filtered set of proxies.
- *
- **/
-local interface TypeFilter
-{
-    /**
-     *
-     * Filter the the given set of proxies.
-     *
-     * @param type The type.
-     *
-     * @param proxies The proxies to filter.
-     *
-     * @param con The connection from the Ice client which is
-     * looking up well-known objects by type.
-     *
-     * @param ctx The context from the Ice client which is looking up
-     * well-known objects by type.
-     *
-     * @return The filtered proxies.
-     *
-     **/
-    Ice::ObjectProxySeq filter(string type, Ice::ObjectProxySeq proxies, Ice::Connection con, Ice::Context ctx);
-}
-
-/**
- *
- * The RegistryPluginFacade is implemented by IceGrid and can be used
- * by plugins and filter implementations to retrieve information from
- * IceGrid about the well-known objects or adapters. It's also used to
- * register/unregister replica group and type filters.
- *
- **/
-local interface RegistryPluginFacade
-{
-    /**
-     *
-     * Get an application descriptor.
-     *
-     * @param name The application name.
-     *
-     * @return The application descriptor.
-     *
-     * @throws ApplicationNotExistException Raised if the application
-     * doesn't exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent ApplicationInfo getApplicationInfo(string name)
-        throws ApplicationNotExistException;
-
-    /**
-     *
-     * Get the server information for the server with the given id.
-     *
-     * @param id The server id.
-     *
-     * @throws ServerNotExistException Raised if the server doesn't exist.
-     *
-     * @return The server information.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent ServerInfo getServerInfo(string id)
-        throws ServerNotExistException;
-
-    /**
-     *
-     * Get the ID of the server to which the given adapter belongs.
-     *
-     * @param adapterId The adapter ID.
-     *
-     * @return The server ID or the empty string if the given
-     * identifier is not associated to an object adapter defined with
-     * an application descriptor.
-     *
-     * @throws AdapterNotExistException Raised if the adapter doesn't
-     * exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent string getAdapterServer(string adapterId)
-        throws AdapterNotExistException;
-
-    /**
-     *
-     * Get the name of the application to which the given adapter belongs.
-     *
-     * @param adapterId The adapter ID.
-     *
-     * @return The application name or the empty string if the given
-     * identifier is not associated to a replica group or object
-     * adapter defined with an application descriptor.
-     *
-     * @throws AdapterNotExistException Raised if the adapter doesn't
-     * exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent string getAdapterApplication(string adapterId)
-        throws AdapterNotExistException;
-
-    /**
-     *
-     * Get the name of the node to which the given adapter belongs.
-     *
-     * @param adapterId The adapter ID.
-     *
-     * @return The node name or the empty string if the given
-     * identifier is not associated to an object adapter defined with
-     * an application descriptor.
-     *
-     * @throws AdapterNotExistException Raised if the adapter doesn't
-     * exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent string getAdapterNode(string adapterId)
-        throws AdapterNotExistException;
-
-    /**
-     *
-     * Get the adapter information for the replica group or adapter
-     * with the given id.
-     *
-     * @param id The adapter id.
-     *
-     * @return A sequence of adapter information structures. If the
-     * given id refers to an adapter, this sequence will contain only
-     * one element. If the given id refers to a replica group, the
-     * sequence will contain the adapter information of each member of
-     * the replica group.
-     *
-     * @throws AdapterNotExistException Raised if the adapter or
-     * replica group doesn't exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent AdapterInfoSeq getAdapterInfo(string id)
-        throws AdapterNotExistException;
-
-    /**
-     *
-     * Get the object info for the object with the given identity.
-     *
-     * @param id The identity of the object.
-     *
-     * @return The object info.
-     *
-     * @throws ObjectNotRegisteredException Raised if the object isn't
-     * registered with the registry.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent ObjectInfo getObjectInfo(Ice::Identity id)
-        throws ObjectNotRegisteredException;
-
-    /**
-     *
-     * Get the node information for the node with the given name.
-     *
-     * @param name The node name.
-     *
-     * @return The node information.
-     *
-     * @throws NodeNotExistException Raised if the node doesn't exist.
-     *
-     * @throws NodeUnreachableException Raised if the node could not be
-     * reached.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent NodeInfo getNodeInfo(string name)
-        throws NodeNotExistException, NodeUnreachableException;
-
-    /**
-     *
-     * Get the load averages of the node.
-     *
-     * @param name The node name.
-     *
-     * @return The node load information.
-     *
-     * @throws NodeNotExistException Raised if the node doesn't exist.
-     *
-     * @throws NodeUnreachableException Raised if the node could not be
-     * reached.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent LoadInfo getNodeLoad(string name)
-        throws NodeNotExistException, NodeUnreachableException;
-
-    /**
-     *
-     * Get the property value for the given property and adapter. The
-     * property is looked up in the server or service descriptor where
-     * the adapter is defined.
-     *
-     * @param adapterId The adapter ID
-     *
-     * @param name The name of the property.
-     *
-     * @return The property value.
-     *
-     * @throws AdapterNotExistException Raised if the adapter doesn't exist.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent string getPropertyForAdapter(string adapterId, string name)
-        throws AdapterNotExistException;
-
-    /**
-     *
-     * Add a replica group filter.
-     *
-     * @param id The identifier of the filter. This identifier must
-     * match the value of the "filter" attribute specified in the
-     * replica group descriptor. To filter dynamically registered
-     * replica groups, you should use the empty filter id.
-     *
-     * @param filter The filter implementation.
-     *
-     **/
-    ["cpp:noexcept", "swift:noexcept"] void addReplicaGroupFilter(string id, ReplicaGroupFilter filter);
-
-    /**
-     *
-     * Remove a replica group filter.
-     *
-     * @param id The identifier of the filter.
-     *
-     * @param filter The filter implementation.
-     *
-     * @return True of the filter was removed, false otherwise.
-     *
-     **/
-    ["cpp:noexcept", "swift:noexcept"] bool removeReplicaGroupFilter(string id, ReplicaGroupFilter filter);
-
-    /**
-     *
-     * Add a type filter.
-     *
-     * @param type The type to register this filter with.
-     *
-     * @param filter The filter implementation.
-     *
-     **/
-    ["cpp:noexcept", "swift:noexcept"] void addTypeFilter(string type, TypeFilter filter);
-
-    /**
-     *
-     * Remove a type filter.
-     *
-     * @param type The type to register this filter with.
-     *
-     * @param filter The filter implementation.
-     *
-     * @return True of the filter was removed, false otherwise.
-     *
-     **/
-    ["cpp:noexcept", "swift:noexcept"] bool removeTypeFilter(string type, TypeFilter filter);
-}
-
-}

data/slice/IceGrid/Registry.ice

@@ -1,269 +0,0 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:ICEGRID_API"]]
-[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:IceGrid/Config.h"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:IceGrid"]]
-
-#include <IceGrid/Exception.ice>
-#include <IceGrid/Session.ice>
-#include <IceGrid/Admin.ice>
-#include <Ice/Locator.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICEGRID"]
-module IceGrid
-{
-
-/**
- *
- * Determines which load sampling interval to use.
- *
- **/
-enum LoadSample
-{
-    /**
-     * Sample every minute.
-     **/
-    LoadSample1,
-
-    /**
-     * Sample every five minutes.
-     **/
-    LoadSample5,
-
-    /**
-     * Sample every fifteen minutes.
-     **/
-    LoadSample15
-}
-
-/**
- *
- * The IceGrid query interface. This interface is accessible to
- * Ice clients who wish to look up well-known objects.
- *
- **/
-interface Query
-{
-    /**
-     *
-     * Find a well-known object by identity.
-     *
-     * @param id The identity.
-     *
-     * @return The proxy or null if no such object has been found.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent Object* findObjectById(Ice::Identity id);
-
-    /**
-     *
-     * Find a well-known object by type. If there are several objects
-     * registered for the given type, the object is randomly
-     * selected.
-     *
-     * @param type The object type.
-     *
-     * @return The proxy or null, if no such object has been found.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent Object* findObjectByType(string type);
-
-    /**
-     *
-     * Find a well-known object by type on the least-loaded node. If
-     * the registry does not know which node hosts the object
-     * (for example, because the object was registered with a direct proxy), the
-     * registry assumes the object is hosted on a node that has a load
-     * average of 1.0.
-     *
-     * @param type The object type.
-     *
-     * @param sample The sampling interval.
-     *
-     * @return The proxy or null, if no such object has been found.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent Object* findObjectByTypeOnLeastLoadedNode(string type, LoadSample sample);
-
-    /**
-     *
-     * Find all the well-known objects with the given type.
-     *
-     * @param type The object type.
-     *
-     * @return The proxies or an empty sequence, if no such objects
-     * have been found.
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent Ice::ObjectProxySeq findAllObjectsByType(string type);
-
-    /**
-     *
-     * Find all the object replicas associated with the given
-     * proxy. If the given proxy is not an indirect proxy from a
-     * replica group, an empty sequence is returned.
-     *
-     * @param proxy The object proxy.
-     *
-     * @return The proxies of each object replica or an empty sequence,
-     * if the given proxy is not from a replica group.
-     *
-     **/
-    ["cpp:const"] idempotent Ice::ObjectProxySeq findAllReplicas(Object* proxy);
-}
-
-/**
- *
- * The IceGrid registry allows clients create sessions
- * directly with the registry.
- *
- * @see Session
- * @see AdminSession
- *
- **/
-interface Registry
-{
-    /**
-     *
-     * Create a client session.
-     *
-     * @return A proxy for the newly created session.
-     *
-     * @param userId The user id.
-     *
-     * @param password The password for the given user id.
-     *
-     * @throws PermissionDeniedException Raised if the password for
-     * the given user id is not correct, or if the user is not allowed
-     * access.
-     *
-     **/
-    Session* createSession(string userId, string password)
-        throws PermissionDeniedException;
-
-    /**
-     *
-     * Create an administrative session.
-     *
-     * @return A proxy for the newly created session.
-     *
-     * @param userId The user id.
-     *
-     * @param password The password for the given user id.
-     *
-     * @throws PermissionDeniedException Raised if the password for
-     * the given user id is not correct, or if the user is not allowed
-     * access.
-     *
-     **/
-    AdminSession* createAdminSession(string userId, string password)
-        throws PermissionDeniedException;
-
-    /**
-     *
-     * Create a client session from a secure connection.
-     *
-     * @return A proxy for the newly created session.
-     *
-     * @throws PermissionDeniedException Raised if the password for
-     * the given user id is not correct, or if the user is not allowed
-     * access.
-     *
-     **/
-    Session* createSessionFromSecureConnection()
-        throws PermissionDeniedException;
-
-    /**
-     *
-     * Create an administrative session from a secure connection.
-     *
-     * @return A proxy for the newly created session.
-     *
-     * @throws PermissionDeniedException Raised if the password for
-     * the given user id is not correct, or if the user is not allowed
-     * access.
-     *
-     **/
-    AdminSession* createAdminSessionFromSecureConnection()
-        throws PermissionDeniedException;
-
-    /**
-     *
-     * Get the session timeout. If a client or administrative client
-     * doesn't call the session keepAlive method in the time interval
-     * defined by this timeout, IceGrid might reap the session.
-     *
-     * @see Session#keepAlive
-     * @see AdminSession#keepAlive
-     *
-     * @return The timeout (in seconds).
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent int getSessionTimeout();
-
-    /**
-     *
-     * Get the value of the ACM timeout. Clients supporting ACM
-     * connection heartbeats can enable them instead of explicitly
-     * sending keep alives requests.
-     *
-     * NOTE: This method is only available since Ice 3.6.
-     *
-     * @return The timeout (in seconds).
-     *
-     **/
-    ["nonmutating", "cpp:const"] idempotent int getACMTimeout();
-}
-
-/**
- *
- * The IceGrid locator interface provides access to the {@link Query}
- * and {@link Registry} object of the IceGrid registry.
- *
- * @see Query
- * @see Registry
- *
- **/
-interface Locator extends Ice::Locator
-{
-    /**
-     *
-     * Get the proxy of the registry object hosted by this IceGrid
-     * registry.
-     *
-     * @return The proxy of the registry object.
-     *
-     **/
-    ["cpp:const"] idempotent Registry* getLocalRegistry();
-
-    /**
-     *
-     * Get the proxy of the query object hosted by this IceGrid
-     * registry.
-     *
-     * @return The proxy of the query object.
-     *
-     **/
-    ["cpp:const"] idempotent Query* getLocalQuery();
-}
-
-}

data/slice/IceGrid/Session.ice

@@ -1,128 +0,0 @@
-//
-// Copyright (c) ZeroC, Inc. All rights reserved.
-//
-
-#pragma once
-
-[["cpp:dll-export:ICEGRID_API"]]
-[["cpp:doxygen:include:IceGrid/IceGrid.h"]]
-[["cpp:header-ext:h"]]
-[["cpp:include:IceGrid/Config.h"]]
-
-[["ice-prefix"]]
-
-[["js:module:ice"]]
-[["js:cjs-module"]]
-
-[["objc:dll-export:ICEGRID_API"]]
-[["objc:header-dir:objc"]]
-
-[["python:pkgdir:IceGrid"]]
-
-#include <Glacier2/Session.ice>
-#include <IceGrid/Exception.ice>
-
-#ifndef __SLICE2JAVA_COMPAT__
-[["java:package:com.zeroc"]]
-#endif
-
-["objc:prefix:ICEGRID"]
-module IceGrid
-{
-
-/**
- *
- * A session object is used by IceGrid clients to allocate and
- * release objects. Client sessions are created either via the
- * {@link Registry} object or via the registry client <code>SessionManager</code>
- * object.
- *
- * @see Registry
- *
- **/
-interface Session extends Glacier2::Session
-{
-    /**
-     *
-     * Keep the session alive. Clients should call this operation
-     * regularly to prevent the server from reaping the session.
-     *
-     * @see Registry#getSessionTimeout
-     *
-     **/
-    idempotent void keepAlive();
-
-    /**
-     *
-     * Allocate an object. Depending on the allocation timeout, this
-     * operation might hang until the object is available or until the
-     * timeout is reached.
-     *
-     * @param id The identity of the object to allocate.
-     *
-     * @return The proxy of the allocated object.
-     *
-     * @throws ObjectNotRegisteredException Raised if the object with
-     * the given identity is not registered with the registry.
-     *
-     * @throws AllocationException Raised if the object can't be
-     * allocated.
-     *
-     * @see #setAllocationTimeout
-     * @see #releaseObject
-     *
-     **/
-    ["amd"] Object* allocateObjectById(Ice::Identity id)
-        throws ObjectNotRegisteredException, AllocationException;
-
-    /**
-     *
-     * Allocate an object with the given type. Depending on the
-     * allocation timeout, this operation can block until an object
-     * becomes available or until the timeout is reached.
-     *
-     * @param type The type of the object.
-     *
-     * @return The proxy of the allocated object.
-     *
-     * @throws AllocationException Raised if the object could not be allocated.
-     *
-     * @see #setAllocationTimeout
-     * @see #releaseObject
-     *
-     **/
-    ["amd"] Object* allocateObjectByType(string type)
-        throws AllocationException;
-
-    /**
-     *
-     * Release an object that was allocated using <code>allocateObjectById</code> or
-     * <code>allocateObjectByType</code>.
-     *
-     * @param id The identity of the object to release.
-     *
-     * @throws ObjectNotRegisteredException Raised if the object with
-     * the given identity is not registered with the registry.
-     *
-     * @throws AllocationException Raised if the given object can't be
-     * released. This might happen if the object isn't allocatable or
-     * isn't allocated by the session.
-     *
-     **/
-    void releaseObject(Ice::Identity id)
-        throws ObjectNotRegisteredException, AllocationException;
-
-    /**
-     *
-     * Set the allocation timeout. If no objects are available for an
-     * allocation request, a call to <code>allocateObjectById</code> or
-     * <code>allocateObjectByType</code> will block for the duration of this
-     * timeout.
-     *
-     * @param timeout The timeout in milliseconds.
-     *
-     **/
-    idempotent void setAllocationTimeout(int timeout);
-}
-
-}