zeroc-ice 3.6b1

data/slice/Ice/ObjectAdapterF.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 ObjectAdapter;
+
+};
+

data/slice/Ice/ObjectFactory.ice

@@ -0,0 +1,60 @@
+// **********************************************************************
+//
+// 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
+{
+
+/**
+ *
+ * A factory for objects. Object factories are used in several
+ * places, for example, when receiving "objects by value" and
+ * when Freeze restores a persistent object. Object factories
+ * must be implemented by the application writer, and registered
+ * with the communicator.
+ *
+ * @see Freeze
+ *
+ **/
+local interface ObjectFactory
+{
+    /**
+     *
+     * Create a new object for a given object type. The type is the
+     * absolute Slice type id, i.e., the id relative to the
+     * unnamed top-level Slice module. For example, the absolute
+     * Slice type id for interfaces of type <tt>Bar</tt> in the module
+     * <tt>Foo</tt> is <tt>::Foo::Bar</tt>.
+     *
+     * <p class="Note">The leading "<tt>::</tt>" is required.
+     *
+     * @param type The object type.
+     *
+     * @return The object created for the given type, or nil if the
+     * factory is unable to create the object.
+     *
+     **/
+    Object create(string type);
+
+    /**
+     *
+     * Called when the factory is removed from the communicator, or if
+     * the communicator is destroyed.
+     *
+     * @see Communicator#destroy
+     *
+     **/
+    void destroy();
+};
+
+};
+

data/slice/Ice/ObjectFactoryF.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 ObjectFactory;
+
+};
+

data/slice/Ice/Plugin.ice

@@ -0,0 +1,117 @@
+
+// **********************************************************************
+//
+// 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/LoggerF.ice>
+#include <Ice/BuiltinSequences.ice>
+
+module Ice
+{
+
+/**
+ *
+ * A communicator plug-in. A plug-in generally adds a feature to a
+ * communicator, such as support for a protocol.
+ *
+ * The communicator loads its plug-ins in two stages: the first stage
+ * creates the plug-ins, and the second stage invokes {@link Plugin.initialize} on
+ * each one.
+ *
+ **/
+local interface Plugin
+{
+    /**
+     *
+     * Perform any necessary initialization steps.
+     *
+     **/
+    void initialize();
+
+    /**
+     *
+     * Called when the communicator is being destroyed.
+     *
+     **/
+    void destroy();
+};
+
+/**
+ *
+ * Each communicator has a plug-in manager to administer the set of
+ * plug-ins.
+ *
+ **/
+local interface PluginManager
+{
+    /**
+     *
+     * Initialize the configured plug-ins. The communicator automatically initializes
+     * the plug-ins by default, but an application may need to interact directly with
+     * a plug-in prior to initialization. In this case, the application must set
+     * <tt>Ice.InitPlugins=0</tt> and then invoke {@link #initializePlugins}
+     * manually. The plug-ins are initialized in the order in which they are loaded.
+     * If a plug-in raises an exception during initialization, the communicator
+     * invokes destroy on the plug-ins that have already been initialized.
+     *
+     * @throws InitializationException Raised if the plug-ins have already been initialized.
+     *
+     **/
+    void initializePlugins();
+
+    /**
+     *
+     * Get a list of plugins installed.
+     *
+     * @return The names of the plugins installed.
+     *
+     * @see #getPlugin
+     *
+     **/
+    StringSeq getPlugins();
+
+    /**
+     *
+     * Obtain a plug-in by name.
+     *
+     * @param name The plug-in's name.
+     *
+     * @return The plug-in.
+     *
+     * @throws NotRegisteredException Raised if no plug-in is found with the given name.
+     *
+     **/
+    Plugin getPlugin(string name);
+
+    /**
+     *
+     * Install a new plug-in.
+     *
+     * @param name The plug-in's name.
+     *
+     * @param pi The plug-in.
+     *
+     * @throws AlreadyRegisteredException Raised if a plug-in already exists with the given name.
+     *
+     **/
+    void addPlugin(string name, Plugin pi);
+
+    /**
+     *
+     * Called when the communicator is being destroyed.
+     *
+     **/
+    void destroy();
+};
+
+};
+

data/slice/Ice/PluginF.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
+{
+    
+local interface Plugin;
+local interface PluginManager;
+
+};
+

data/slice/Ice/Process.ice

@@ -0,0 +1,54 @@
+// **********************************************************************
+//
+// 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
+{
+
+/**
+ *
+ * An administrative interface for process management. Managed servers must
+ * implement this interface.
+ *
+ * <p class="Note">A servant implementing this interface is a potential target
+ * for denial-of-service attacks, therefore proper security precautions
+ * should be taken. For example, the servant can use a UUID to make its
+ * identity harder to guess, and be registered in an object adapter with
+ * a secured endpoint.
+ *
+ **/
+interface Process
+{
+    /**
+     *
+     * Initiate a graceful shut-down.
+     *
+     * @see Communicator#shutdown
+     *
+     **/
+    void shutdown();
+
+
+    /**
+     *
+     * Write a message on the process' stdout or stderr.
+     *
+     * @param message The message.
+     *
+     * @param fd 1 for stdout, 2 for stderr.
+     *
+     **/
+    void writeMessage(string message, int fd);
+};
+
+};
+

data/slice/Ice/ProcessF.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
+{
+
+interface Process;
+
+};
+

data/slice/Ice/Properties.ice

@@ -0,0 +1,228 @@
+// **********************************************************************
+//
+// 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/PropertiesAdmin.ice>
+
+module Ice
+{
+
+/**
+ *
+ * A property set used to configure Ice and Ice applications.
+ * Properties are key/value pairs, with both keys and values
+ * being strings. By convention, property keys should have the form
+ * <em>application-name</em>\[.<em>category</em>\[.<em>sub-category</em>]].<em>name</em>.
+ *
+ **/
+local interface Properties
+{
+    /**
+     *
+     * Get a property by key. If the property is not set, an empty
+     * string is returned.
+     *
+     * @param key The property key.
+     *
+     * @return The property value.
+     *
+     * @see #setProperty
+     *
+     **/
+    string getProperty(string key);
+
+    /**
+     *
+     * Get a property by key. If the property is not set, the
+     * given default value is returned.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property does not
+     * exist.
+     *
+     * @return The property value or the default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    string getPropertyWithDefault(string key, string value);
+
+    /**
+     *
+     * Get a property as an integer. If the property is not set, 0
+     * is returned.
+     *
+     * @param key The property key.
+     *
+     * @return The property value interpreted as an integer.
+     *
+     * @see #setProperty
+     *
+     **/
+    int getPropertyAsInt(string key);
+
+    /**
+     *
+     * Get a property as an integer. If the property is not set, the
+     * given default value is returned.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property does not
+     * exist.
+     *
+     * @return The property value interpreted as an integer, or the
+     * default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    int getPropertyAsIntWithDefault(string key, int value);
+
+
+     /**
+     *
+     * Get a property as a list of strings. The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * an empty list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double 
+     * quotes. If quotes are mismatched, an empty list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     *
+     * @param key The property key.
+     *
+     * @return The property value interpreted as a list of strings.
+     *
+     * @see #setProperty
+     *
+     **/
+    StringSeq getPropertyAsList(string key);
+
+    /**
+     *
+     * Get a property as a list of strings.  The strings must be
+     * separated by whitespace or comma. If the property is not set,
+     * the default list is returned. The strings in the list can contain
+     * whitespace and commas if they are enclosed in single or double 
+     * quotes. If quotes are mismatched, the default list is returned.
+     * Within single quotes or double quotes, you can escape the
+     * quote in question with \, e.g. O'Reilly can be written as
+     * O'Reilly, "O'Reilly" or 'O\'Reilly'.
+     *
+     * @param key The property key.
+     *
+     * @param value The default value to use if the property is not set.
+     *
+     * @return The property value interpreted as list of strings, or the
+     * default value.
+     *
+     * @see #setProperty
+     *
+     **/
+    StringSeq getPropertyAsListWithDefault(string key, StringSeq value);
+
+    /**
+     *
+     * Get all properties whose keys begins with
+     * <em>prefix</em>. If
+     * <em>prefix</em> is an empty string,
+     * then all properties are returned.
+     *
+     * @param prefix The prefix to search for (empty string if none).
+     * @return The matching property set.
+     *
+     **/
+    PropertyDict getPropertiesForPrefix(string prefix);
+
+    /**
+     *
+     * Set a property. To unset a property, set it to
+     * the empty string.
+     *
+     * @param key The property key.
+     * @param value The property value.
+     *
+     * @see #getProperty
+     *
+     **/
+    void setProperty(string key, string value);
+
+    /**
+     *
+     * Get a sequence of command-line options that is equivalent to
+     * this property set. Each element of the returned sequence is
+     * a command-line option of the form
+     * <tt>--<em>key</em>=<em>value</em></tt>.
+     *
+     * @return The command line options for this property set.
+     *
+     **/
+    StringSeq getCommandLineOptions();
+
+    /**
+     *
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with
+     * <tt>--<em>prefix</em>.</tt> are
+     * converted into properties. If the prefix is empty, all options
+     * that begin with <tt>--</tt> are converted to properties.
+     *
+     * @param prefix The property prefix, or an empty string to
+     * convert all options starting with <tt>--</tt>.
+     *
+     * @param options The command-line options.
+     *
+     * @return The command-line options that do not start with the specified
+     * prefix, in their original order.
+     *
+     **/
+    StringSeq parseCommandLineOptions(string prefix, StringSeq options);
+
+    /**
+     *
+     * Convert a sequence of command-line options into properties.
+     * All options that begin with one of the following prefixes
+     * are converted into properties: <tt>--Ice</tt>, <tt>--IceBox</tt>, <tt>--IceGrid</tt>,
+     * <tt>--IcePatch2</tt>, <tt>--IceSSL</tt>, <tt>--IceStorm</tt>, <tt>--Freeze</tt>, and <tt>--Glacier2</tt>.
+     *
+     * @param options The command-line options.
+     *
+     * @return The command-line options that do not start with one of
+     * the listed prefixes, in their original order.
+     *
+     **/
+    StringSeq parseIceCommandLineOptions(StringSeq options);
+
+    /**
+     *
+     * Load properties from a file.
+     *
+     * @param file The property file.
+     *
+     **/
+    void load(string file);
+
+    /**
+     *
+     * Create a copy of this property set.
+     *
+     * @return A copy of this property set.
+     *
+     **/
+    Properties clone();
+};
+
+};
+