zeroc-ice 3.6b1

data/slice/IceGrid/Session.ice

@@ -0,0 +1,124 @@
+// **********************************************************************
+//
+// 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"]]
+[["cpp:include:IceGrid/Config.h"]]
+
+#include <Glacier2/Session.ice>
+#include <IceGrid/Exception.ice>
+
+module IceGrid
+{
+
+/**
+ *
+ * A session object is used by IceGrid clients to allocate and
+ * release objects. Client sessions are either created with the
+ * {@link Registry} object or the registry client {@link Glacier2.SessionManager}
+ * object.
+ *
+ * @see Registry
+ * @see Glacier2.SessionManager
+ * 
+ **/
+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 ObjectNotRegisteredException Raised if no objects with the given type can be allocated.
+     *
+     * @throws AllocationException Raised if the object could not be allocated.
+     *
+     * @see #setAllocationTimeout
+     * @see #releaseObject
+     *
+     **/
+    ["amd"] Object* allocateObjectByType(string type)
+        throws AllocationException;
+    
+    /**
+     *
+     * Release an object.
+     *
+     * @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.
+     *
+     * @see #allocateObjectById
+     * @see #allocateObjectByType
+     *
+     **/
+    void releaseObject(Ice::Identity id)
+        throws ObjectNotRegisteredException, AllocationException;
+    
+    /**
+     *
+     * Set the allocation timeout. If no objects are available for an
+     * allocation request, the request will hang for the duration of 
+     * this timeout.
+     *
+     * @param timeout The timeout in milliseconds.
+     *
+     * @see #allocateObjectById
+     * @see #allocateObjectByType
+     *
+     **/
+    idempotent void setAllocationTimeout(int timeout);
+};
+
+};
+

data/slice/IceGrid/UserAccountMapper.ice

@@ -0,0 +1,58 @@
+// **********************************************************************
+//
+// 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"]]
+[["cpp:include:IceGrid/Config.h"]]
+
+module IceGrid
+{
+
+/**
+ *
+ * This exception is raised if a user account for a given session
+ * identifier can't be found.
+ *
+ **/
+exception UserAccountNotFoundException
+{
+};
+
+/**
+ *
+ * A user account mapper object is used by IceGrid nodes to map
+ * session identifiers to user accounts.
+ *
+ **/
+interface UserAccountMapper
+{
+    /**
+     *
+     * Get the name of the user account for the given user. This is
+     * used by IceGrid nodes to figure out the user account to use
+     * to run servers.
+     *
+     * @param user The value of the server descriptor's <tt>user</tt>
+     * attribute. If this attribute is not defined, and the server's
+     * activation mode is <tt>session</tt>, the default value of
+     * <tt>user</tt> is the session identifier.
+     *
+     * @return The user account name.
+     *
+     * @throws UserAccountNotFoundException Raised if no user account
+     * is found for the given user.
+     * 
+     **/
+    string getUserAccount(string user)
+        throws UserAccountNotFoundException;
+};
+
+};
+

data/slice/IcePatch2/FileInfo.ice

@@ -0,0 +1,49 @@
+// **********************************************************************
+//
+// 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"]]
+[["cpp:include:IcePatch2/Config.h"]]
+
+#include <Ice/BuiltinSequences.ice>
+
+module IcePatch2
+{
+
+/**
+ *
+ * Basic information about a single file.
+ *
+ **/
+struct FileInfo
+{
+    /** The pathname. **/
+    string path;
+
+    /** The SHA-1 checksum of the file. **/
+    Ice::ByteSeq checksum;
+
+    /** The size of the compressed file in number of bytes. **/
+    int size;
+
+    /** The executable flag. */
+    bool executable;
+};
+
+/**
+ *
+ * A sequence with information about many files.
+ *
+ **/
+sequence<FileInfo> FileInfoSeq;
+
+};
+
+

data/slice/IcePatch2/FileServer.ice

@@ -0,0 +1,129 @@
+// **********************************************************************
+//
+// 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"]]
+[["cpp:include:IcePatch2/Config.h"]]
+
+#include <IcePatch2/FileInfo.ice>
+
+/**
+ *
+ * IcePatch can be used to update file hiearchies in a simple and
+ * efficient manner. Checksums ensure file integrity, and data is
+ * compressed before download.
+ *
+ **/
+module IcePatch2
+{
+
+/**
+ *
+ * A sequence of byte sequences. Each element is the checksum for a
+ * partition.
+ *
+ **/
+sequence<Ice::ByteSeq> ByteSeqSeq;
+
+/**
+ *
+ * The <tt>partition</tt> argument for
+ * {@link FileServer#getFileInfoSeq} was not in the range 0-255.
+ *
+ **/
+exception PartitionOutOfRangeException
+{
+};
+
+/**
+ *
+ * This exception is raised if {@link FileServer#getFileCompressed} cannot read the
+ * contents of a file.
+ *
+ **/
+exception FileAccessException
+{
+    /**
+     *
+     * An explanation of the reason for the failure.
+     *
+     **/
+    string reason;
+};
+
+/**
+ *
+ * The interface that provides access to files.
+ *
+ **/
+interface FileServer
+{
+    /**
+     *
+     * Return the {@link FileInfoSeq} for the specified partition. If the
+     * partion number is out of range, the operation throws
+     * {@link PartitionOutOfRangException}.
+     *
+     * @param partition The partition number in the range 0-255.
+     *
+     * @return A sequence containing the {@link FileInfo} structures for
+     * files in the specified partition.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent FileInfoSeq getFileInfoSeq(int partition)
+        throws PartitionOutOfRangeException;
+
+    /**
+     *
+     * Return the checksums for all partitions.
+     *
+     * @return A sequence containing 256 checksums. Partitions with a
+     * checksum that differs from the previous checksum for the same
+     * partition contain updated files. Partitions with a checksum
+     * that is identical to the previous checksum do not contain
+     * updated files.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent ByteSeqSeq getChecksumSeq();
+
+    /**
+     *
+     * Return the master checksum for all partitions. If this checksum is the same
+     * as for a previous run, the entire file set is up-to-date.
+     *
+     * @return The master checksum for the file set.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Ice::ByteSeq getChecksum();
+
+    /**
+     *
+     * Read the specified file. If the read operation fails, the
+     * operation throws {@link FileAccessException}. This operation may only
+     * return fewer bytes than requested in case there was an
+     * end-of-file condition.
+     *
+     * @param path The pathname (relative to the data directory) for
+     * the file to be read.
+     *
+     * @param pos The file offset at which to begin reading.
+     *
+     * @param num The number of bytes to be read.
+     *
+     * @return A sequence containing the compressed file contents.
+     *
+     **/
+    ["amd", "nonmutating", "cpp:const", "cpp:array"] 
+    idempotent Ice::ByteSeq getFileCompressed(string path, int pos, int num)
+        throws FileAccessException;
+};
+
+};
+

data/slice/IceSSL/ConnectionInfo.ice

@@ -0,0 +1,34 @@
+// **********************************************************************
+//
+// 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/Connection.ice>
+
+module IceSSL
+{
+
+/**
+ *
+ * Provides access to the connection details of an SSL connection
+ *
+ **/
+local class ConnectionInfo extends Ice::IPConnectionInfo
+{
+    /** The negotiated cipher suite. */
+    string cipher;
+
+    /** The certificate chain. */
+    Ice::StringSeq certs;
+};
+
+};
+

data/slice/IceSSL/EndpointInfo.ice

@@ -0,0 +1,41 @@
+// **********************************************************************
+//
+// 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/Endpoint.ice>
+
+/**
+ *
+ * IceSSL provides a secure transport for Ice.
+ *
+ **/
+module IceSSL
+{
+
+/**
+ *
+ * Uniquely identifies SSL endpoints.
+ *
+ **/
+const short EndpointType = 2;
+
+/**
+ *
+ * Provides access to an SSL endpoint information.
+ *
+ **/
+local class EndpointInfo extends Ice::IPEndpointInfo
+{
+};
+
+};
+

data/slice/IceStorm/IceStorm.ice

@@ -0,0 +1,405 @@
+// **********************************************************************
+//
+// 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"]]
+[["cpp:include:IceStorm/Config.h"]]
+
+#include <Ice/Identity.ice>
+#include <Ice/SliceChecksumDict.ice>
+
+#include <IceStorm/Metrics.ice>
+
+/**
+ *
+ * A messaging service with support for federation. In contrast to
+ * most other messaging or event services, IceStorm supports typed
+ * events, meaning that broadcasting a message over a federation is as
+ * easy as invoking a method on an interface.
+ *
+ **/
+module IceStorm
+{
+
+interface Topic;
+
+/**
+ *
+ * Information on the topic links.
+ *
+ **/
+struct LinkInfo
+{
+    /**
+     *
+     * The linked topic.
+     *
+     **/
+    Topic* theTopic;
+
+    /**
+     *
+     * The name of the linked topic.
+     *
+     **/
+    string name;
+
+    /**
+     *
+     * The cost of traversing this link.
+     *
+     **/
+    int cost;
+};
+
+/**
+ *
+ * A sequence of {@link LinkInfo} objects.
+ *
+ **/
+sequence<LinkInfo> LinkInfoSeq;
+
+/**
+ *
+ * This dictionary represents quality of service parameters.
+ *
+ * @see Topic#subscribeAndGetPublisher
+ *
+ */
+dictionary<string, string> QoS;
+
+/**
+ *
+ * This exception indicates that an attempt was made to create a link
+ * that already exists.
+ *
+ **/
+exception LinkExists
+{
+    /**
+     *
+     * The name of the linked topic.
+     *
+     */
+    string name;
+};
+
+/**
+ *
+ * This exception indicates that an attempt was made to remove a
+ * link that does not exist.
+ *
+ **/
+exception NoSuchLink
+{
+    /**
+     *
+     * The name of the link that does not exist.
+     *
+     */
+    string name;
+};
+
+/**
+ *
+ * This exception indicates that an attempt was made to subscribe
+ * a proxy for which a subscription already exists.
+ *
+ **/
+exception AlreadySubscribed
+{
+};
+
+/**
+ *
+ * This exception indicates that an attempt was made to subscribe
+ * a proxy that is null.
+ *
+ **/
+exception InvalidSubscriber
+{
+    /**
+     *
+     * The reason for the failure.
+     *
+     **/
+    string reason;
+};
+
+/**
+ *
+ * This exception indicates that a subscription failed due to an
+ * invalid QoS.
+ *
+ **/
+exception BadQoS
+{
+    /**
+     *
+     * The reason for the failure.
+     *
+     **/
+    string reason;
+};
+
+/**
+ *
+ * Publishers publish information on a particular topic. A topic
+ * logically represents a type.
+ *
+ * @see TopicManager
+ *
+ **/
+interface Topic
+{
+    /**
+     *
+     * Get the name of this topic.
+     *
+     * @return The name of the topic.
+     *
+     * @see TopicManager#create
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent string getName();
+
+    /**
+     *
+     * Get a proxy to a publisher object for this topic. To publish
+     * data to a topic, the publisher calls {@link #getPublisher} and then
+     * casts to the topic type. An unchecked cast must be used on this
+     * proxy. If a replicated IceStorm deployment is used this call
+     * may return a replicated proxy.
+     *
+     * @return A proxy to publish data on this topic.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Object* getPublisher();
+
+    /**
+     *
+     * Get a non-replicated proxy to a publisher object for this
+     * topic. To publish data to a topic, the publisher calls
+     * {@link #getPublisher} and then casts to the topic type. An unchecked
+     * cast must be used on this proxy.
+     *
+     * @return A proxy to publish data on this topic.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Object* getNonReplicatedPublisher();
+
+
+    /**
+     *
+     * Subscribe with the given <tt>qos</tt> to this topic.  A
+     * per-subscriber publisher object is returned.
+     *
+     * @param theQoS The quality of service parameters for this
+     * subscription.
+     *
+     * @param subscriber The subscriber's proxy.
+     *
+     * @return The per-subscriber publisher object.
+     *
+     * @throws AlreadySubscribed Raised if the subscriber object is
+     * already subscribed.
+     *
+     * @throws NullSubscriber Raised if the subscriber object is null.
+     *
+     * @throws BadQoS Raised if the requested quality of service
+     * is unavailable or invalid.
+     *
+     * @see #unsubscribe
+     *
+     **/
+    Object* subscribeAndGetPublisher(QoS theQoS, Object* subscriber)
+        throws AlreadySubscribed, InvalidSubscriber, BadQoS;
+
+    /**
+     *
+     * Unsubscribe the given <tt>subscriber</tt>.
+     *
+     * @param subscriber The proxy of an existing subscriber.
+     *
+     * @see #subscribeAndGetPublisher
+     *
+     **/
+    idempotent void unsubscribe(Object* subscriber);
+
+    /**
+     *
+     * Create a link to the given topic. All events originating
+     * on this topic will also be sent to <tt>linkTo</tt>.
+     *
+     * @param linkTo The topic to link to.
+     *
+     * @param cost The cost to the linked topic.
+     *
+     * @throws LinkExists Raised if a link to the same topic already
+     * exists.
+     *
+     **/
+    void link(Topic* linkTo, int cost) throws LinkExists;
+
+    /**
+     *
+     * Destroy the link from this topic to the given topic <tt>linkTo</tt>.
+     *
+     * @param linkTo The topic to destroy the link to.
+     *
+     * @throws NoSuchLink Raised if a link to the topic does not exist.
+     *
+     **/
+    void unlink(Topic* linkTo) throws NoSuchLink;
+
+    /**
+     *
+     * Retrieve information on the current links.
+     *
+     * @return A sequence of LinkInfo objects.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent LinkInfoSeq getLinkInfoSeq();
+
+    /**
+     *
+     * Retrieve the list of subscribers for this topic.
+     *
+     * @return The sequence of Ice identities for the subscriber objects.
+     *
+     **/
+    ["nonmutating", "cpp:const"] Ice::IdentitySeq getSubscribers();
+
+    /**
+     *
+     * Destroy the topic.
+     *
+     **/
+    void destroy();
+};
+
+/**
+ *
+ * Mapping of topic name to topic proxy.
+ *
+ **/
+dictionary<string, Topic*> TopicDict;
+
+/**
+ *
+ * This exception indicates that an attempt was made to create a topic
+ * that already exists.
+ *
+ **/
+exception TopicExists
+{
+    /**
+     *
+     * The name of the topic that already exists.
+     *
+     */
+    string name;
+};
+
+/**
+ *
+ * This exception indicates that an attempt was made to retrieve a
+ * topic that does not exist.
+ *
+ **/
+exception NoSuchTopic
+{
+    /**
+     *
+     * The name of the topic that does not exist.
+     *
+     */
+    string name;
+};
+
+/**
+ *
+ * A topic manager manages topics, and subscribers to topics.
+ *
+ * @see Topic
+ *
+ **/
+interface TopicManager
+{
+    /**
+     *
+     * Create a new topic. The topic name must be unique, otherwise
+     * {@link TopicExists} is raised.
+     *
+     * @param name The name of the topic.
+     *
+     * @return A proxy to the topic instance.
+     *
+     * @throws TopicExists Raised if a topic with the same name already
+     * exists.
+     *
+     **/
+    Topic* create(string name) throws TopicExists;
+
+    /**
+     *
+     * Retrieve a topic by name.
+     *
+     * @param name The name of the topic.
+     *
+     * @return A proxy to the topic instance.
+     *
+     * @throws NoSuchTopic Raised if the topic does not exist.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Topic* retrieve(string name) throws NoSuchTopic;
+
+    /**
+     *
+     * Retrieve all topics managed by this topic manager.
+     *
+     * @return A dictionary of string, topic proxy pairs.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent TopicDict retrieveAll();
+
+    /**
+     *
+     * Returns the checksums for the IceStorm Slice definitions.
+     *
+     * @return A dictionary mapping Slice type ids to their checksums.
+     *
+     **/
+    ["nonmutating", "cpp:const"] idempotent Ice::SliceChecksumDict getSliceChecksums();
+};
+
+/**
+ *
+ * This inferface is advertised by the IceStorm service through the
+ * Ice object with the identity `IceStorm/Finder'. This allows clients
+ * to retrieve the topic manager with just the endpoint information of
+ * the IceStorm service.
+ *
+ **/
+interface Finder
+{
+    /**
+     *
+     * Get the topic manager proxy. The proxy might point to several
+     * replicas.
+     *
+     * @return The topic manager proxy.
+     *
+     **/
+    TopicManager* getTopicManager();
+};
+
+};
+