zeroc-ice 3.6b1

data/slice/Ice/Locator.ice

@@ -0,0 +1,227 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 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"]]
+
+#include <Ice/Identity.ice>
+#include <Ice/ProcessF.ice>
+
+module Ice
+{
+
+/**
+ *
+ * This exception is raised if an adapter cannot be found.
+ *
+ **/
+exception AdapterNotFoundException
+{
+};
+
+/**
+ *
+ * This exception is raised if the replica group provided by the
+ * server is invalid.
+ *
+ **/
+exception InvalidReplicaGroupIdException
+{
+};
+
+/**
+ *
+ * This exception is raised if a server tries to set endpoints for
+ * an adapter that is already active.
+ *
+ **/
+exception AdapterAlreadyActiveException
+{
+};
+
+/**
+ *
+ * This exception is raised if an object cannot be found.
+ *
+ **/
+exception ObjectNotFoundException
+{
+};
+
+/**
+ *
+ * This exception is raised if a server cannot be found.
+ *
+ **/
+exception ServerNotFoundException
+{
+};
+
+interface LocatorRegistry;
+
+/**
+ *
+ * The Ice locator interface. This interface is used by clients to
+ * lookup adapters and objects. It is also used by servers to get the
+ * locator registry proxy.
+ *
+ * <p class="Note">The {@link Locator} interface is intended to be used by
+ * Ice internals and by locator implementations. Regular user code
+ * should not attempt to use any functionality of this interface
+ * directly.
+ *
+ **/
+interface Locator
+{
+    /**
+     *
+     * Find an object by identity and return its proxy.
+     *
+     * @param id The identity.
+     *
+     * @return The proxy, or null if the object is not active.
+     *
+     * @throws ObjectNotFoundException Raised if the object cannot
+     * be found.
+     *
+     **/
+    ["amd", "nonmutating", "cpp:const"] idempotent Object* findObjectById(Ice::Identity id)
+        throws ObjectNotFoundException;
+
+    /**
+     *
+     * Find an adapter by id and return its proxy (a dummy direct
+     * proxy created by the adapter).
+     *
+     * @param id The adapter id.
+     *
+     * @return The adapter proxy, or null if the adapter is not active.
+     * 
+     * @throws AdapterNotFoundException Raised if the adapter cannot be
+     * found.
+     *
+     **/
+    ["amd", "nonmutating", "cpp:const"] idempotent Object* findAdapterById(string id)
+        throws AdapterNotFoundException;
+
+    /**
+     *
+     * Get the locator registry.
+     *
+     * @return The locator registry.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent LocatorRegistry* getRegistry();
+};
+
+/**
+ *
+ * The Ice locator registry interface. This interface is used by
+ * servers to register adapter endpoints with the locator.
+ *
+ * <p class="Note"> The {@link LocatorRegistry} interface is intended to be used
+ * by Ice internals and by locator implementations. Regular user
+ * code should not attempt to use any functionality of this interface
+ * directly.
+ *
+ **/
+interface LocatorRegistry
+{
+    /**
+     *
+     * Set the adapter endpoints with the locator registry.
+     *
+     * @param id The adapter id.
+     *
+     * @param proxy The adapter proxy (a dummy direct proxy created
+     * by the adapter). The direct proxy contains the adapter
+     * endpoints.
+     *
+     * @throws AdapterNotFoundException Raised if the adapter cannot
+     * be found, or if the locator only allows
+     * registered adapters to set their active proxy and the
+     * adapter is not registered with the locator.
+     *
+     * @throws AdapterAlreadyActiveException Raised if an adapter with the same
+     * id is already active.
+     *
+     **/
+    ["amd"] idempotent void setAdapterDirectProxy(string id, Object* proxy)
+        throws AdapterNotFoundException, AdapterAlreadyActiveException;
+
+    /**
+     *
+     * Set the adapter endpoints with the locator registry.
+     *
+     * @param adapterId The adapter id.
+     *
+     * @param replicaGroupId The replica group id.
+     *
+     * @param p The adapter proxy (a dummy direct proxy created
+     * by the adapter). The direct proxy contains the adapter
+     * endpoints.
+     *
+     * @throws AdapterNotFoundException Raised if the adapter cannot
+     * be found, or if the locator only allows registered adapters to
+     * set their active proxy and the adapter is not registered with
+     * the locator.
+     *
+     * @throws AdapterAlreadyActiveException Raised if an adapter with the same
+     * id is already active.
+     *
+     * @throws InvalidReplicaGroupIdException Raised if the given
+     * replica group doesn't match the one registered with the
+     * locator registry for this object adapter.
+     *
+     **/
+    ["amd"] idempotent void setReplicatedAdapterDirectProxy(string adapterId, string replicaGroupId, Object* p)
+        throws AdapterNotFoundException, AdapterAlreadyActiveException, InvalidReplicaGroupIdException;
+
+    /**
+     *
+     * Set the process proxy for a server.
+     *
+     * @param id The server id.
+     *
+     * @param proxy The process proxy.
+     *
+     * @throws ServerNotFoundException Raised if the server cannot
+     * be found.
+     *
+     **/
+    ["amd"] idempotent void setServerProcessProxy(string id, Process* proxy)
+        throws ServerNotFoundException;
+};
+
+/**
+ *
+ * This inferface should be implemented by services implementing the
+ * Ice::Locator interface. It should be advertised through an Ice
+ * object with the identity `Ice/LocatorFinder'. This allows clients
+ * to retrieve the locator proxy with just the endpoint information of
+ * the service.
+ *
+ **/
+interface LocatorFinder
+{
+    /**
+     *
+     * Get the locator proxy implemented by the process hosting this
+     * finder object. The proxy might point to several replicas.
+     *
+     * @return The locator proxy.
+     *
+     **/
+    Locator* getLocator();
+};
+
+};
+
+

data/slice/Ice/LocatorF.ice

@@ -0,0 +1,21 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 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"]]
+
+module Ice
+{
+
+interface Locator;
+interface LocatorRegistry;
+
+};
+

data/slice/Ice/Logger.ice

@@ -0,0 +1,86 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 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"]]
+
+module Ice
+{
+
+/**
+ *
+ * The Ice message logger. Applications can provide their own logger
+ * by implementing this interface and installing it in a communicator.
+ *
+ **/
+local interface Logger
+{
+    /**
+     *
+     * Print a message. The message is printed literally, without
+     * any decorations such as executable name or time stamp.
+     *
+     **/
+    void print(string message);
+
+    /**
+     *
+     * Log a trace message.
+     *
+     * @param category The trace category.
+     *
+     * @param message The trace message to log.
+     *
+     **/
+    void trace(string category, string message);
+
+    /**
+     *
+     * Log a warning message.
+     *
+     * @param message The warning message to log.
+     *
+     * @see #error
+     *
+     **/
+    void warning(string message);
+
+    /**
+     *
+     * Log an error message.
+     *
+     * @param message The error message to log.
+     *
+     * @see #warning
+     *
+     **/
+    void error(string message);
+    
+    /**
+     *
+     * Returns this logger's prefix.
+     *
+     * @return The prefix.
+     *
+     **/
+    string getPrefix();
+
+    /**
+     *
+     * Returns a clone of the logger with a new prefix.
+     *
+     * @param prefix The new prefix for the logger.
+     *
+     */
+    Logger cloneWithPrefix(string prefix);
+};
+
+};
+

data/slice/Ice/LoggerF.ice

@@ -0,0 +1,20 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 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"]]
+
+module Ice
+{
+
+local interface Logger;
+
+};
+

data/slice/Ice/Metrics.ice

@@ -0,0 +1,422 @@
+// **********************************************************************
+//
+// Copyright (c) 2003-2014 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"]]
+
+#include <Ice/BuiltinSequences.ice>
+
+/**
+ *
+ * The Ice Management eXtension facility. It provides the {@link
+ * IceMX#MetricsAdmin} interface for management clients to retrieve
+ * metrics from Ice applications.
+ * 
+ **/
+module IceMX
+{
+
+/**
+ *
+ * A dictionnary of strings to integers.
+ *
+ **/
+dictionary<string, int> StringIntDict;
+
+/**
+ *
+ * The base class for metrics. A metrics object represents a
+ * collection of measurements associated to a given a system.
+ *
+ **/ 
+class Metrics
+{
+    /**
+     *
+     * The metrics identifier.
+     *
+     **/
+    string id;
+    
+    /**
+     *
+     * The total number of objects that were observed by this metrics.
+     *
+     **/
+    long total = 0;
+    
+    /**
+     *
+     * The current number of objects observed by this metrics.
+     *
+     **/
+    int current = 0;
+
+    /**
+     *
+     * The sum of the lifetime of each observed objects. This does not
+     * include the lifetime of objects which are currently observed.
+     *
+     **/
+    long totalLifetime = 0;
+
+    /**
+     *
+     * The number of failures observed.
+     *
+     **/
+    int failures = 0;
+};
+
+/**
+ *
+ * A structure to keep track of failures associated with a given
+ * metrics.
+ *
+ **/
+struct MetricsFailures
+{
+    /**
+     *
+     * The identifier of the metrics object associated to the
+     * failures.
+     *
+     **/
+    string id;
+
+    /**
+     *
+     * The failures observed for this metrics.
+     *
+     **/
+    StringIntDict failures;
+};
+
+/**
+ *
+ * A sequence of {@link MetricsFailures}.
+ *
+ **/
+sequence<MetricsFailures> MetricsFailuresSeq;
+
+/**
+ *
+ * A metrics map is a sequence of metrics. We use a sequence here
+ * instead of a map because the ID of the metrics is already included
+ * in the Metrics class and using sequences of metrics objects is more
+ * efficient than using dictionaries since lookup is not necessary.
+ *
+ **/
+sequence<Metrics> MetricsMap;
+
+/**
+ *
+ * A metrics view is a dictionary of metrics map. The key of the
+ * dictionary is the name of the metrics map.
+ *
+ **/
+dictionary<string, MetricsMap> MetricsView;
+
+/**
+ *
+ * Raised if a metrics view cannot be found.
+ * 
+ **/
+exception UnknownMetricsView
+{
+};
+
+/**
+ *
+ * The metrics administrative facet interface. This interface allows
+ * remote administrative clients to access metrics of an application
+ * that enabled the Ice administrative facility and configured some
+ * metrics views.
+ *
+ **/ 
+["format:sliced"]
+interface MetricsAdmin
+{
+    /**
+     *
+     * Get the names of enabled and disabled metrics.
+     *
+     * @param disabledViews The names of the disabled views.
+     *
+     * @return The name of the enabled views.
+     *
+     **/
+    Ice::StringSeq getMetricsViewNames(out Ice::StringSeq disabledViews);
+
+    /**
+     *
+     * Enables a metrics view.
+     *
+     * @param name The metrics view name.
+     * 
+     * @throws UnknownMetricsView Raised if the metrics view cannot be
+     * found.
+     *
+     **/
+    void enableMetricsView(string name)
+        throws UnknownMetricsView;
+
+    /**
+     *
+     * Disable a metrics view.
+     *
+     * @param name The metrics view name.
+     * 
+     * @throws UnknownMetricsView Raised if the metrics view cannot be
+     * found.
+     *
+     **/
+    void disableMetricsView(string name)
+        throws UnknownMetricsView;
+
+    /**
+     *
+     * Get the metrics objects for the given metrics view. This
+     * returns a dictionnary of metric maps for each metrics class
+     * configured with the view. The timestamp allows the client to
+     * compute averages which are not dependent of the invocation
+     * latency for this operation.
+     *
+     * @param view The name of the metrics view.
+     *
+     * @param timestamp The local time of the process when the metrics
+     * object were retrieved.
+     *
+     * @return The metrics view data.
+     *
+     * @throws UnknownMetricsView Raised if the metrics view cannot be
+     * found.
+     *
+     **/
+    MetricsView getMetricsView(string view, out long timestamp)
+        throws UnknownMetricsView;
+
+    /**
+     *
+     * Get the metrics failures associated with the given view and map.
+     *
+     * @param view The name of the metrics view.
+     *
+     * @param map The name of the metrics map.
+     *
+     * @return The metrics failures associated with the map.
+     *
+     * @throws UnknownMetricsView Raised if the metrics view cannot be
+     * found.
+     *
+     **/
+    MetricsFailuresSeq getMapMetricsFailures(string view, string map)
+        throws UnknownMetricsView;
+
+    /**
+     *
+     * Get the metrics failure associated for the given metrics.
+     *
+     * @param view The name of the metrics view.
+     *
+     * @param map The name of the metrics map.
+     *
+     * @param id The ID of the metrics.
+     *
+     * @return The metrics failures associated with the metrics.
+     *
+     * @throws UnknownMetricsView Raised if the metrics view cannot be
+     * found.
+     *
+     **/
+    MetricsFailures getMetricsFailures(string view, string map, string id)
+        throws UnknownMetricsView;
+};
+
+/**
+ *
+ * Provides information on the number of threads currently in use and
+ * their activity.
+ *
+ **/
+class ThreadMetrics extends Metrics
+{
+    /**
+     *
+     * The number of threads which are currently performing socket
+     * read or writes.
+     *
+     **/
+    int inUseForIO = 0;
+
+    /**
+     *
+     * The number of threads which are currently calling user code
+     * (servant dispatch, AMI callbacks, etc).
+     *
+     **/
+    int inUseForUser = 0;
+    
+    /**
+     *
+     * The number of threads which are currently performing other
+     * activities. These are all other that are not counted with
+     * {@link inUseForUser} or {@link inUseForIO}, such as DNS
+     * lookups, garbage collection).
+     *
+     **/
+    int inUseForOther = 0;
+};
+
+/**
+ *
+ * Provides information on servant dispatch.
+ * 
+ **/
+class DispatchMetrics extends Metrics
+{
+    /**
+     *
+     * The number of dispatch that failed with a user exception.
+     *
+     **/
+    int userException = 0;
+
+    /**
+     *
+     * The size of the dispatch. This corresponds to the size of the
+     * marshalled input parameters.
+     *
+     **/
+    long size = 0;
+
+    /**
+     *
+     * The size of the dispatch reply. This corresponds to the size of
+     * the marshalled output and return parameters.
+     *
+     **/
+    long replySize = 0;
+};
+
+/**
+ *
+ * Provides information on child invocations. A child invocation is
+ * either remote (sent over an Ice connection) or collocated. An
+ * invocation can have multiple child invocation if it is
+ * retried. Child invocation metrics are embedded within {@link
+ * InvocationMetrics}.
+ *
+ **/
+class ChildInvocationMetrics extends Metrics
+{
+    /**
+     *
+     * The size of the invocation. This corresponds to the size of the
+     * marshalled input parameters.
+     *
+     **/
+    long size = 0;
+
+    /**
+     *
+     * The size of the invocation reply. This corresponds to the size
+     * of the marshalled output and return parameters.
+     * 
+     **/
+    long replySize = 0;
+};
+
+/**
+ *
+ * Provides information on invocations that are collocated. Collocated
+ * metrics are embedded within {@link InvocationMetrics}.
+ *
+ **/
+class CollocatedMetrics extends ChildInvocationMetrics
+{
+};
+
+/**
+ *
+ * Provides information on invocations that are specifically sent over
+ * Ice connections. Remote metrics are embedded within {@link
+ * InvocationMetrics}.
+ *
+ **/
+class RemoteMetrics extends ChildInvocationMetrics
+{
+};
+
+/**
+ *
+ * Provide measurements for proxy invocations. Proxy invocations can
+ * either be sent over the wire or be collocated.
+ *
+ **/
+class InvocationMetrics extends Metrics
+{
+    /**
+     *
+     * The number of retries for the invocation(s).
+     *
+     **/
+    int retry = 0;
+
+    /**
+     *
+     * The number of invocations that failed with a user exception.
+     *
+     **/
+    int userException = 0;
+
+    /**
+     *
+     * The remote invocation metrics map.
+     *
+     * @see RemoteMetrics
+     *
+     **/
+    MetricsMap remotes;
+
+    /**
+     *
+     * The collocated invocation metrics map.
+     *
+     * @see CollocatedMetrics
+     *
+     **/
+    MetricsMap collocated;
+};
+
+/**
+ *
+ * Provides information on the data sent and received over Ice
+ * connections.
+ *
+ **/
+class ConnectionMetrics extends Metrics
+{
+    /**
+     *
+     * The number of bytes received by the connection. 
+     *
+     **/
+    long receivedBytes = 0;
+
+    /**
+     *
+     * The number of bytes sent by the connection.
+     *
+     **/
+    long sentBytes = 0;
+};
+
+};