Communicator.ice

Go to the documentation of this file.

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
 
#pragma once
 
[["cpp:dll-export:ICE_API"]]
[["cpp:doxygen:include:Ice/Ice.h"]]
[["cpp:header-ext:h"]]
 
[["ice-prefix"]]
 
[["js:module:ice"]]
[["js:cjs-module"]]
 
[["objc:dll-export:ICE_API"]]
[["objc:header-dir:objc"]]
 
[["python:pkgdir:Ice"]]
 
#include <Ice/LoggerF.ice>
#include <Ice/InstrumentationF.ice>
#include <Ice/ObjectAdapterF.ice>
#include <Ice/ObjectFactory.ice>
#include <Ice/ValueFactory.ice>
#include <Ice/Router.ice>
#include <Ice/Locator.ice>
#include <Ice/PluginF.ice>
#include <Ice/ImplicitContextF.ice>
#include <Ice/Current.ice>
#include <Ice/Properties.ice>
#include <Ice/FacetMap.ice>
#include <Ice/Connection.ice>

#ifndef __SLICE2JAVA_COMPAT__
[["java:package:com.zeroc"]]
#endif
 
["objc:prefix:ICE"]
module Ice
{

["clr:implements:global::System.IDisposable", "java:implements:java.lang.AutoCloseable"]
 
#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
local interface Communicator
{
 
#ifdef __SLICE2JAVA__
    void close();
#endif

    ["cpp:noexcept", "swift:noexcept", "js:async"] void destroy();

    ["cpp:noexcept", "swift:noexcept", "js:async"] void shutdown();

    ["cpp:noexcept", "swift:noexcept", "js:async"] void waitForShutdown();

    ["cpp:const", "cpp:noexcept", "swift:noexcept"] bool isShutdown();

    ["cpp:const"] Object* stringToProxy(string str);

    ["cpp:const", "swift:noexcept"] string proxyToString(Object* obj);

    ["cpp:const"] Object* propertyToProxy(string property);

    ["cpp:const", "swift:noexcept"] PropertyDict proxyToProperty(["swift:nonnull"] Object* proxy, string property);
 
#ifndef __SLICE2SWIFT__
    ["cpp:const", "deprecate:stringToIdentity() is deprecated, use the static stringToIdentity() method instead."]
    Identity stringToIdentity(string str);
#endif

    ["cpp:const", "swift:noexcept"] string identityToString(Identity ident);

    ["js:async", "swift:nonnull"] ObjectAdapter createObjectAdapter(string name);

    ["js:async", "swift:nonnull"] ObjectAdapter createObjectAdapterWithEndpoints(string name, string endpoints);

    ["js:async", "swift:nonnull"] ObjectAdapter
    createObjectAdapterWithRouter(string name, ["objc:param:router", "swift:nonnull"] Router* rtr);
 
#if !defined(__SLICE2SWIFT__)
    ["deprecate:addObjectFactory() is deprecated, use ValueFactoryManager::add() instead."]
    void addObjectFactory(ObjectFactory factory, ["objc:param:sliceId"] string id);

    ["cpp:const", "cpp:noexcept", "deprecate:findObjectFactory() is deprecated, use ValueFactoryManager::find() instead."]
    ObjectFactory findObjectFactory(string id);
 
#endif

    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"]
    ImplicitContext getImplicitContext();

    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Properties getProperties();

    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Logger getLogger();
 
#if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
    ["cpp:const", "cpp:noexcept"] Instrumentation::CommunicatorObserver getObserver();
#endif

    ["cpp:const", "swift:noexcept"] Router* getDefaultRouter();

    ["swift:noexcept"] void setDefaultRouter(Router* rtr);

    ["cpp:const", "swift:noexcept"] Locator* getDefaultLocator();

    ["swift:noexcept"] void setDefaultLocator(Locator* loc);
 
#if !defined(__SLICE2SWIFT__) && !defined(__SLICE2JS__)
    ["cpp:const"] PluginManager getPluginManager();
#endif

    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"]
    ValueFactoryManager getValueFactoryManager();

    ["async-oneway"] void flushBatchRequests(CompressBatch compress);
 
#ifndef __SLICE2JS__
    ["swift:nonnull"] Object* createAdmin(ObjectAdapter adminAdapter, Identity adminId);

    ["cpp:const"] Object* getAdmin();

    void addAdminFacet(["swift:nonnull"] Object servant, string facet);

    ["swift:nonnull", "swift:attribute:@discardableResult"] Object removeAdminFacet(string facet);

    ["swift:noexcept"] Object findAdminFacet(string facet);

    ["swift:noexcept"] FacetMap findAllAdminFacets();
#endif
 
#if defined(__SLICE2SWIFT__) || defined(ICE_SWIFT)
    ["cpp:const", "swift:nonnull", "cpp:type:dispatch_queue_t", "swift:type:Dispatch.DispatchQueue"]
    LocalObject getClientDispatchQueue();

    ["cpp:const", "swift:nonnull", "cpp:type:dispatch_queue_t", "swift:type:Dispatch.DispatchQueue"]
    LocalObject getServerDispatchQueue();
#endif
}
 
#endif

local enum ToStringMode
{
    Unicode,

    ASCII,

    Compat
}
 
}