IceStorm.ice

Go to the documentation of this file.

// **********************************************************************
//
// Copyright (c) 2003-2018 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", "objc:header-dir:objc", "js:ice-build"]]
[["cpp:include:IceStorm/Config.h"]]

#include <Ice/Identity.ice>
#include <Ice/SliceChecksumDict.ice>

#include <IceStorm/Metrics.ice>

["objc:prefix:ICESTORM"]
module IceStorm
{

interface Topic;

struct LinkInfo
{
    Topic* theTopic;

    string name;

    int cost;
};

sequence<LinkInfo> LinkInfoSeq;

dictionary<string, string> QoS;

exception LinkExists
{
    string name;
};

exception NoSuchLink
{
    string name;
};

exception AlreadySubscribed
{
};

exception InvalidSubscriber
{
    string reason;
};

exception BadQoS
{
    string reason;
};

interface Topic
{
    ["nonmutating", "cpp:const"] idempotent string getName();

    ["nonmutating", "cpp:const"] idempotent Object* getPublisher();

    ["nonmutating", "cpp:const"] idempotent Object* getNonReplicatedPublisher();

    Object* subscribeAndGetPublisher(QoS theQoS, Object* subscriber)
        throws AlreadySubscribed, InvalidSubscriber, BadQoS;

    idempotent void unsubscribe(Object* subscriber);

    void link(Topic* linkTo, int cost) throws LinkExists;

    void unlink(Topic* linkTo) throws NoSuchLink;

    ["nonmutating", "cpp:const"] idempotent LinkInfoSeq getLinkInfoSeq();

    ["nonmutating", "cpp:const"] Ice::IdentitySeq getSubscribers();

    void destroy();
};

dictionary<string, Topic*> TopicDict;

exception TopicExists
{
    string name;
};

exception NoSuchTopic
{
    string name;
};

interface TopicManager
{
    Topic* create(string name) throws TopicExists;

    ["nonmutating", "cpp:const"] idempotent Topic* retrieve(string name) throws NoSuchTopic;

    ["nonmutating", "cpp:const"] idempotent TopicDict retrieveAll();

    ["nonmutating", "cpp:const"] idempotent Ice::SliceChecksumDict getSliceChecksums();
};

interface Finder
{
    TopicManager* getTopicManager();
};

};