/usr/share/Ice-3.4.2/slice/IceStorm/IceStorm.ice is in ice34-slice 3.4.2-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | // **********************************************************************
//
// Copyright (c) 2003-2011 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.
//
// **********************************************************************
#ifndef ICE_STORM_ICE
#define ICE_STORM_ICE
[["cpp:header-ext:h"]]
#include <Ice/SliceChecksumDict.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#subscribe
*
*/
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 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. If the given
* <tt>subscriber</tt> proxy has already been registered, it will be
* replaced. Note that this can cause a loss of events to the
* subscribed object.
*
* <p class="Deprecated">This operation is deprecated as of version 3.2.
*
* @param theQoS The quality of service parameters for this
* subscription.
*
* @param subscriber The subscriber's proxy.
*
* @return The per-subscriber publisher object.
*
* @see #unsubscribe
*
**/
["deprecate:subscribe is deprecated, use subscribeAndGetPublisher instead"]
void subscribe(QoS theQoS, Object* subscriber);
/**
*
* 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 BadQoS Raised if the requested quality of service
* is unavailable or invalid.
*
* @see #unsubscribe
*
**/
Object* subscribeAndGetPublisher(QoS theQoS, Object* subscriber)
throws AlreadySubscribed, BadQoS;
/**
*
* Unsubscribe the given <tt>subscriber</tt>.
*
* @param subscriber The proxy of an existing subscriber.
*
* @see #subscribe
*
**/
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();
/**
*
* 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();
};
};
#endif
|