zeroc-ice 3.6b1

data/slice/Ice/Endpoint.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
+
+#include <Ice/Version.ice>
+#include <Ice/BuiltinSequences.ice>
+#include <Ice/EndpointF.ice>
+
+[["cpp:header-ext:h"]]
+
+module Ice
+{
+
+/**
+ *
+ * Uniquely identifies TCP endpoints.
+ *
+ **/
+const short TCPEndpointType = 1;
+
+/**
+ *
+ * Uniquely identifies UDP endpoints.
+ *
+ **/
+const short UDPEndpointType = 3;
+
+/**
+ *
+ * Uniquely identifies TCP-based WebSocket endpoints.
+ *
+ **/
+const short WSEndpointType = 4;
+
+/**
+ *
+ * Uniquely identifies SSL-based WebSocket endpoints.
+ *
+ **/
+const short WSSEndpointType = 5;
+
+/**
+ *
+ * Base class providing access to the endpoint details.
+ *
+ **/
+local class EndpointInfo
+{
+    /**
+     *
+     * The timeout for the endpoint in milliseconds. 0 means
+     * non-blocking, -1 means no timeout.
+     *
+     **/
+    int timeout;
+
+    /**
+     *
+     * Specifies whether or not compression should be used if
+     * available when using this endpoint.
+     *
+     */
+    bool compress;
+
+    /**
+     *
+     * Returns the type of the endpoint.
+     *
+     **/
+    ["cpp:const"] short type();
+
+    /**
+     *
+     * Returns true if this endpoint is a datagram endpoint.
+     *
+     **/
+    ["cpp:const"] bool datagram();
+
+    /**
+     *
+     * Returns true if this endpoint is a secure endpoint.
+     *
+     **/
+    ["cpp:const"] bool secure();
+};
+
+/**
+ *
+ * The user-level interface to an endpoint.
+ *
+ **/
+local interface Endpoint
+{
+    /**
+     *
+     * Return a string representation of the endpoint.
+     *
+     * @return The string representation of the endpoint.
+     *
+     **/
+    ["cpp:const"] string toString();
+
+    /**
+     *
+     * Returns the endpoint information.
+     *
+     * @return The endpoint information class.
+     *
+     **/
+    ["cpp:const"] EndpointInfo getInfo();
+};
+
+/**
+ *
+ * Provides access to the address details of a IP endpoint.
+ *
+ * @see Endpoint
+ *
+ **/
+local class IPEndpointInfo extends EndpointInfo
+{
+    /**
+     *
+     * The host or address configured with the endpoint.
+     *
+     **/
+    string host;
+
+    /**
+     *
+     * The port number.
+     *
+     **/
+    int port;
+
+    /**
+     *
+     * The source IP address.
+     *
+     */
+    string sourceAddress;
+};
+
+/**
+ *
+ * Provides access to a TCP endpoint information.
+ *
+ * @see Endpoint
+ *
+ **/
+local class TCPEndpointInfo extends IPEndpointInfo
+{
+};
+
+/**
+ *
+ * Provides access to an UDP endpoint information.
+ *
+ * @see Endpoint
+ *
+ **/
+local class UDPEndpointInfo extends IPEndpointInfo
+{
+    /**
+     *
+     * The multicast interface.
+     *
+     **/
+    string mcastInterface;
+
+    /**
+     *
+     * The multicast time-to-live (or hops).
+     *
+     **/
+     int mcastTtl;
+};
+
+/**
+ *
+ * Provides access to a WebSocket endpoint information.
+ *
+ **/
+local class WSEndpointInfo extends IPEndpointInfo
+{
+    /**
+     *
+     * The URI configured with the endpoint.
+     *
+     **/
+    string resource;
+};
+
+/**
+ *
+ * Provides access to the details of an opaque endpoint.
+ *
+ * @see Endpoint
+ *
+ **/
+local class OpaqueEndpointInfo extends EndpointInfo
+{
+    /**
+     *
+     * The encoding version of the opaque endpoint (to decode or
+     * encode the rawBytes).
+     *
+     **/
+    Ice::EncodingVersion rawEncoding;
+
+    /**
+     *
+     * The raw encoding of the opaque endpoint.
+     *
+     **/
+    Ice::ByteSeq rawBytes;
+};
+
+};
+

data/slice/Ice/EndpointF.ice

@@ -0,0 +1,32 @@
+// **********************************************************************
+//
+// 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 class EndpointInfo;
+local class IPEndpointInfo;
+local class TCPEndpointInfo;
+local class UDPEndpointInfo;
+local class WSEndpointInfo;
+local interface Endpoint;
+
+/**
+ *
+ * A sequence of endpoints.
+ *
+ **/
+local sequence<Endpoint> EndpointSeq;
+
+};
+

data/slice/Ice/EndpointTypes.ice

@@ -0,0 +1,38 @@
+// **********************************************************************
+//
+// 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
+{
+
+/**
+ *
+ * Determines the order in which the Ice run time uses the endpoints
+ * in a proxy when establishing a connection.
+ *
+ **/
+enum EndpointSelectionType
+{
+    /**
+     * <tt>Random</tt> causes the endpoints to be arranged in a random order.
+     */
+    Random,
+    /**
+     * <tt>Ordered</tt> forces the Ice run time to use the endpoints in the
+     * order they appeared in the proxy.
+     */
+    Ordered
+};
+
+};
+

data/slice/Ice/FacetMap.ice

@@ -0,0 +1,25 @@
+// **********************************************************************
+//
+// 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 mapping from facet name to servant.
+ *
+ **/
+local dictionary<string, Object> FacetMap;
+
+};
+

data/slice/Ice/Identity.ice

@@ -0,0 +1,59 @@
+// **********************************************************************
+//
+// 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 identity of an Ice object. In a proxy, an empty {@link Identity#name} denotes a nil
+ * proxy. An identity with an empty {@link Identity#name} and a non-empty {@link Identity#category}
+ * is illegal. You cannot add a servant with an empty name to the Active Servant Map.
+ *
+ * @see ServantLocator
+ * @see ObjectAdapter#addServantLocator
+ *
+ **/
+struct Identity
+{
+    /**
+     *
+     * The name of the Ice object.
+     *
+     **/
+    string name;
+
+    /**
+     *
+     * The Ice object category.
+     *
+     **/
+    string category;
+};
+
+/**
+ *
+ * A mapping between identities and Ice objects.
+ *
+ **/
+local dictionary<Identity, Object> ObjectDict;
+
+/**
+ *
+ * A sequence of identities.
+ *
+ **/
+sequence<Identity> IdentitySeq;
+
+};
+

data/slice/Ice/ImplicitContext.ice

@@ -0,0 +1,109 @@
+// **********************************************************************
+//
+// 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/LocalException.ice>
+#include <Ice/Current.ice>
+
+module Ice
+{
+
+/**
+ *
+ * An interface to associate implict contexts with communicators.
+ *
+ * When you make a remote invocation without an explicit {@link Context} parameter,
+ * Ice uses the per-proxy {@link Context} (if any) combined with the <tt>ImplicitContext</tt>
+ * associated with the communicator.</p>
+ * <p>Ice provides several implementations of <tt>ImplicitContext</tt>. The implementation
+ * used depends on the value of the <tt>Ice.ImplicitContext</tt> property.
+ * <dl>
+ * <dt><tt>None</tt> (default)</dt>
+ * <dd>No implicit context at all.</dd>
+ * <dt><tt>PerThread</tt></dt>
+ * <dd>The implementation maintains a {@link Context} per thread.</dd>
+ * <dt><tt>Shared</tt></dt>
+ * <dd>The implementation maintains a single {@link Context} shared 
+ * by all threads.</dd>
+ * </dl><p>
+ *  
+ * <tt>ImplicitContext</tt> also provides a number of operations to create, update or retrieve
+ * an entry in the underlying context without first retrieving a copy of the entire
+ * context. These operations correspond to a subset of the <tt>java.util.Map</tt> methods,
+ * with <tt>java.lang.Object</tt> replaced by <tt>string</tt> and null replaced by the empty-string.
+ * 
+ **/
+
+local interface ImplicitContext
+{
+    /**
+     * Get a copy of the underlying context.
+     * @return A copy of the underlying context.
+     *
+     **/
+    ["cpp:const"] Context getContext();
+    
+    /**
+     * Set the underlying context.
+     *
+     * @param newContext The new context.
+     * 
+     **/
+    void setContext(Context newContext);
+
+    /**
+     * Check if this key has an associated value in the underlying context. 
+     *
+     * @param key The key.
+     *
+     * @return True if the key has an associated value, False otherwise.
+     *
+     **/
+    ["cpp:const"] bool containsKey(string key);
+ 
+    /**
+     * Get the value associated with the given key in the underlying context.
+     * Returns an empty string if no value is associated with the key.
+     * {@link #containsKey} allows you to distinguish between an empty-string value and 
+     * no value at all.
+     *
+     * @param key The key.
+     *
+     * @return The value associated with the key.
+     *
+     **/
+    ["cpp:const"] string get(string key);
+
+    /**
+     * Create or update a key/value entry in the underlying context.
+     *
+     * @param key The key.
+     *
+     * @param value The value.
+     *
+     * @return The previous value associated with the key, if any.
+     *
+     **/
+    string put(string key, string value);
+
+    /**
+     * Remove the entry for the given key in the underlying context.
+     *
+     * @param key The key.
+     *
+     * @return The value associated with the key, if any.
+     *
+     **/
+    string remove(string key);
+};
+};
+