ObjectAdapter.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/CommunicatorF.ice>
#include <Ice/ServantLocatorF.ice>
#include <Ice/Locator.ice>
#include <Ice/Identity.ice>
#include <Ice/FacetMap.ice>
#include <Ice/Endpoint.ice>
 
#ifndef __SLICE2JAVA_COMPAT__
[["java:package:com.zeroc"]]
#endif
 
["objc:prefix:ICE"]
module Ice
{
 
local interface ObjectAdapter
{
    ["cpp:const", "cpp:noexcept", "swift:noexcept"] string getName();
 
    ["cpp:const", "cpp:noexcept", "swift:noexcept", "swift:nonnull"] Communicator getCommunicator();
 
    ["js:async"] void activate();
 
    ["swift:noexcept"] void hold();
 
    ["swift:noexcept", "js:async"] void waitForHold();
 
    ["cpp:noexcept", "swift:noexcept", "js:async"] void deactivate();
 
    ["cpp:noexcept", "swift:noexcept", "js:async"] void waitForDeactivate();
 
    ["cpp:const", "cpp:noexcept", "swift:noexcept"] bool isDeactivated();
 
    ["cpp:noexcept", "swift:noexcept", "js:async"] void destroy();
 
    ["swift:nonnull", "swift:attribute:@discardableResult"]
    Object* add(["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"]
    Object* addFacet(["swift:nonnull"] Object servant, ["objc:param:identity"] Identity id, string facet);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] Object* addWithUUID(["swift:nonnull"] Object servant);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] Object* addFacetWithUUID(["swift:nonnull"] Object servant, string facet);
 
    void addDefaultServant(["swift:nonnull"] Object servant, string category);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] Object remove(Identity id);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] Object removeFacet(Identity id, string facet);
 
    ["swift:attribute:@discardableResult"] FacetMap removeAllFacets(Identity id);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] Object removeDefaultServant(string category);
 
    ["swift:noexcept", "cpp:const"] Object find(Identity id);
 
    ["swift:noexcept", "cpp:const"] Object findFacet(Identity id, string facet);
 
    ["swift:noexcept", "cpp:const"] FacetMap findAllFacets(Identity id);
 
    ["swift:noexcept", "cpp:const"] Object findByProxy(["swift:nonnull"] Object* proxy);
 
    void addServantLocator(["swift:nonnull"] ServantLocator locator, string category);
 
    ["swift:nonnull", "swift:attribute:@discardableResult"] ServantLocator removeServantLocator(string category);
 
    ["swift:noexcept", "cpp:const"] ServantLocator findServantLocator(string category);
 
    ["swift:noexcept", "cpp:const"] Object findDefaultServant(string category);
 
    ["cpp:const", "swift:nonnull"] Object* createProxy(Identity id);
 
    ["cpp:const", "swift:nonnull"] Object* createDirectProxy(Identity id);
 
    ["cpp:const", "swift:nonnull"] Object* createIndirectProxy(Identity id);
 
    void setLocator(Locator* loc);
 
    ["cpp:const", "cpp:noexcept", "swift:noexcept"] Locator* getLocator();
 
    ["cpp:const", "cpp:noexcept", "swift:noexcept"] EndpointSeq getEndpoints();
 
    ["js:async"] void refreshPublishedEndpoints();
 
    ["cpp:const", "cpp:noexcept", "swift:noexcept"] EndpointSeq getPublishedEndpoints();
 
    void setPublishedEndpoints(EndpointSeq newEndpoints);
 
#if defined(__SLICE2SWIFT__) || defined(ICE_SWIFT)
    /*
     * Returns the dispatch queue.
     *
     * @return The dispatch queue associated wih this Object Adapter.
     **/
    ["cpp:const", "swift:nonnull", "cpp:type:dispatch_queue_t", "swift:type:Dispatch.DispatchQueue"]
    LocalObject getDispatchQueue();
#endif
}
 
}