Communicator.h

Go to the documentation of this file.

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
//
// Ice version 3.7.11
//
// <auto-generated>
//
// Generated from file `Communicator.ice'
//
// Warning: do not edit this file.
//
// </auto-generated>
//
 
#ifndef __Ice_Communicator_h__
#define __Ice_Communicator_h__
 
#include <IceUtil/PushDisableWarnings.h>
#include <Ice/ProxyF.h>
#include <Ice/ObjectF.h>
#include <Ice/ValueF.h>
#include <Ice/Exception.h>
#include <Ice/LocalObject.h>
#include <Ice/StreamHelpers.h>
#include <Ice/Comparable.h>
#include <Ice/Proxy.h>
#include <Ice/Object.h>
#include <Ice/GCObject.h>
#include <Ice/Value.h>
#include <Ice/Incoming.h>
#include <Ice/IncomingAsync.h>
#include <Ice/FactoryTableInit.h>
#include <IceUtil/ScopedArray.h>
#include <Ice/Optional.h>
#include <Ice/ExceptionHelpers.h>
#include <Ice/LoggerF.h>
#include <Ice/InstrumentationF.h>
#include <Ice/ObjectAdapterF.h>
#include <Ice/ObjectFactory.h>
#include <Ice/ValueFactory.h>
#include <Ice/Router.h>
#include <Ice/Locator.h>
#include <Ice/PluginF.h>
#include <Ice/ImplicitContextF.h>
#include <Ice/Current.h>
#include <Ice/Properties.h>
#include <Ice/FacetMap.h>
#include <Ice/Connection.h>
#include <IceUtil/UndefSysMacros.h>
 
#ifndef ICE_IGNORE_VERSION
#   if ICE_INT_VERSION / 100 != 307
#       error Ice version mismatch!
#   endif
#   if ICE_INT_VERSION % 100 >= 50
#       error Beta header file detected
#   endif
#   if ICE_INT_VERSION % 100 < 11
#       error Ice patch level mismatch!
#   endif
#endif
 
#ifndef ICE_API
#   if defined(ICE_STATIC_LIBS)
#       define ICE_API /**/
#   elif defined(ICE_API_EXPORTS)
#       define ICE_API ICE_DECLSPEC_EXPORT
#   else
#       define ICE_API ICE_DECLSPEC_IMPORT
#   endif
#endif
 
#ifdef ICE_CPP11_MAPPING // C++11 mapping
 
namespace Ice
{
 
class Communicator;
 
}
 
namespace Ice
{

enum class ToStringMode : unsigned char
{
    Unicode,
    ASCII,
    Compat
};
 
}
 
namespace Ice
{

class ICE_CLASS(ICE_API) Communicator
{
public:
 
    ICE_MEMBER(ICE_API) virtual ~Communicator();

    virtual void destroy() noexcept = 0;

    virtual void shutdown() noexcept = 0;

    virtual void waitForShutdown() noexcept = 0;

    virtual bool isShutdown() const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::ObjectPrx> stringToProxy(const ::std::string& str) const = 0;

    virtual ::std::string proxyToString(const ::std::shared_ptr<ObjectPrx>& obj) const = 0;

    virtual ::std::shared_ptr<::Ice::ObjectPrx> propertyToProxy(const ::std::string& property) const = 0;

    virtual ::Ice::PropertyDict proxyToProperty(const ::std::shared_ptr<ObjectPrx>& proxy, const ::std::string& property) const = 0;

    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual ::Ice::Identity stringToIdentity(const ::std::string& str) const = 0;

    virtual ::std::string identityToString(const Identity& ident) const = 0;

    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapter(const ::std::string& name) = 0;

    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithEndpoints(const ::std::string& name, const ::std::string& endpoints) = 0;

    virtual ::std::shared_ptr<::Ice::ObjectAdapter> createObjectAdapterWithRouter(const ::std::string& name, const ::std::shared_ptr<RouterPrx>& rtr) = 0;

    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ::std::shared_ptr<ObjectFactory>& factory, const ::std::string& id) = 0;

    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ::std::shared_ptr<::Ice::ObjectFactory> findObjectFactory(const ::std::string& id) const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::ImplicitContext> getImplicitContext() const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::Properties> getProperties() const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::Logger> getLogger() const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::Instrumentation::CommunicatorObserver> getObserver() const noexcept = 0;

    virtual ::std::shared_ptr<::Ice::RouterPrx> getDefaultRouter() const = 0;

    virtual void setDefaultRouter(const ::std::shared_ptr<RouterPrx>& rtr) = 0;

    virtual ::std::shared_ptr<::Ice::LocatorPrx> getDefaultLocator() const = 0;

    virtual void setDefaultLocator(const ::std::shared_ptr<LocatorPrx>& loc) = 0;

    virtual ::std::shared_ptr<::Ice::PluginManager> getPluginManager() const = 0;

    virtual ::std::shared_ptr<::Ice::ValueFactoryManager> getValueFactoryManager() const noexcept = 0;

    virtual void flushBatchRequests(CompressBatch compress)
    {
        flushBatchRequestsAsync(compress).get();
    }

    virtual ::std::function<void()>
    flushBatchRequestsAsync(CompressBatch compress,
                            ::std::function<void(::std::exception_ptr)> exception,
                            ::std::function<void(bool)> sent = nullptr) = 0;

    template<template<typename> class P = ::std::promise>
    auto flushBatchRequestsAsync(CompressBatch compress)
        -> decltype(::std::declval<P<void>>().get_future())
    {
        using Promise = P<void>;
        auto promise = ::std::make_shared<Promise>();
        flushBatchRequestsAsync(compress,
                                [promise](::std::exception_ptr ex)
                                {
                                    promise->set_exception(::std::move(ex));
                                },
                                [promise](bool)
                                {
                                    promise->set_value();
                                });
        return promise->get_future();
    }

    virtual ::std::shared_ptr<::Ice::ObjectPrx> createAdmin(const ::std::shared_ptr<ObjectAdapter>& adminAdapter, const Identity& adminId) = 0;

    virtual ::std::shared_ptr<::Ice::ObjectPrx> getAdmin() const = 0;

    virtual void addAdminFacet(const ::std::shared_ptr<Object>& servant, const ::std::string& facet) = 0;

    virtual ::std::shared_ptr<::Ice::Object> removeAdminFacet(const ::std::string& facet) = 0;

    virtual ::std::shared_ptr<::Ice::Object> findAdminFacet(const ::std::string& facet) = 0;

    virtual ::Ice::FacetMap findAllAdminFacets() = 0;
};
 
}

namespace Ice
{
 
}

namespace Ice
{
 
using CommunicatorPtr = ::std::shared_ptr<Communicator>;
 
}
 
#else // C++98 mapping
 
namespace IceProxy
{
 
}
 
namespace Ice
{
 
class Communicator;
ICE_API LocalObject* upCast(Communicator*);
typedef ::IceInternal::Handle< Communicator> CommunicatorPtr;
 
}
 
namespace Ice
{

enum ToStringMode
{
    Unicode,
    ASCII,
    Compat
};
 
}

namespace IceAsync
{
 
}
 
namespace Ice
{

class Callback_Communicator_flushBatchRequests_Base : public virtual ::IceInternal::CallbackBase { };
typedef ::IceUtil::Handle< Callback_Communicator_flushBatchRequests_Base> Callback_Communicator_flushBatchRequestsPtr;
 
}
 
namespace IceProxy
{
 
}
 
namespace Ice
{

class ICE_API Communicator : public virtual LocalObject
{
public:
 
    typedef CommunicatorPtr PointerType;
 
    virtual ~Communicator();
 
#ifdef ICE_CPP11_COMPILER
    Communicator() = default;
    Communicator(const Communicator&) = default;
    Communicator& operator=(const Communicator&) = default;
#endif

    virtual void destroy() ICE_NOEXCEPT = 0;

    virtual void shutdown() ICE_NOEXCEPT = 0;

    virtual void waitForShutdown() ICE_NOEXCEPT = 0;

    virtual bool isShutdown() const ICE_NOEXCEPT = 0;

    virtual ObjectPrx stringToProxy(const ::std::string& str) const = 0;

    virtual ::std::string proxyToString(const ObjectPrx& obj) const = 0;

    virtual ObjectPrx propertyToProxy(const ::std::string& property) const = 0;

    virtual PropertyDict proxyToProperty(const ObjectPrx& proxy, const ::std::string& property) const = 0;

    ICE_DEPRECATED_API("stringToIdentity() is deprecated, use the static stringToIdentity() method instead.") virtual Identity stringToIdentity(const ::std::string& str) const = 0;

    virtual ::std::string identityToString(const Identity& ident) const = 0;

    virtual ObjectAdapterPtr createObjectAdapter(const ::std::string& name) = 0;

    virtual ObjectAdapterPtr createObjectAdapterWithEndpoints(const ::std::string& name, const ::std::string& endpoints) = 0;

    virtual ObjectAdapterPtr createObjectAdapterWithRouter(const ::std::string& name, const RouterPrx& rtr) = 0;

    ICE_DEPRECATED_API("addObjectFactory() is deprecated, use ValueFactoryManager::add() instead.") virtual void addObjectFactory(const ObjectFactoryPtr& factory, const ::std::string& id) = 0;

    ICE_DEPRECATED_API("findObjectFactory() is deprecated, use ValueFactoryManager::find() instead.") virtual ObjectFactoryPtr findObjectFactory(const ::std::string& id) const ICE_NOEXCEPT = 0;

    virtual ImplicitContextPtr getImplicitContext() const ICE_NOEXCEPT = 0;

    virtual PropertiesPtr getProperties() const ICE_NOEXCEPT = 0;

    virtual LoggerPtr getLogger() const ICE_NOEXCEPT = 0;

    virtual ::Ice::Instrumentation::CommunicatorObserverPtr getObserver() const ICE_NOEXCEPT = 0;

    virtual RouterPrx getDefaultRouter() const = 0;

    virtual void setDefaultRouter(const RouterPrx& rtr) = 0;

    virtual LocatorPrx getDefaultLocator() const = 0;

    virtual void setDefaultLocator(const LocatorPrx& loc) = 0;

    virtual PluginManagerPtr getPluginManager() const = 0;

    virtual ValueFactoryManagerPtr getValueFactoryManager() const ICE_NOEXCEPT = 0;

    virtual void flushBatchRequests(CompressBatch compress) = 0;

    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress) = 0;

    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const CallbackPtr& cb, const LocalObjectPtr& cookie = 0) = 0;

    virtual AsyncResultPtr begin_flushBatchRequests(CompressBatch compress, const Callback_Communicator_flushBatchRequestsPtr& cb, const LocalObjectPtr& cookie = 0) = 0;

    virtual void end_flushBatchRequests(const AsyncResultPtr& result) = 0;

    virtual ObjectPrx createAdmin(const ObjectAdapterPtr& adminAdapter, const Identity& adminId) = 0;

    virtual ObjectPrx getAdmin() const = 0;

    virtual void addAdminFacet(const ObjectPtr& servant, const ::std::string& facet) = 0;

    virtual ObjectPtr removeAdminFacet(const ::std::string& facet) = 0;

    virtual ObjectPtr findAdminFacet(const ::std::string& facet) = 0;

    virtual FacetMap findAllAdminFacets() = 0;
};

inline bool operator==(const Communicator& lhs, const Communicator& rhs)
{
    return static_cast<const LocalObject&>(lhs) == static_cast<const LocalObject&>(rhs);
}
 
inline bool operator<(const Communicator& lhs, const Communicator& rhs)
{
    return static_cast<const LocalObject&>(lhs) < static_cast<const LocalObject&>(rhs);
}
 
}

namespace Ice
{
 
}
 
#endif
 
#include <IceUtil/PopDisableWarnings.h>
#endif