Object.h

Go to the documentation of this file.

//
// Copyright (c) ZeroC, Inc. All rights reserved.
//
 
#ifndef ICE_OBJECT_H
#define ICE_OBJECT_H
 
#include <IceUtil/Mutex.h>
#include <IceUtil/Shared.h>
#include <Ice/ObjectF.h>
#include <Ice/ProxyF.h>
#include <Ice/IncomingAsyncF.h>
#include <Ice/SlicedDataF.h>
#include <Ice/Current.h>
#include <Ice/Format.h>
 
namespace Ice
{
 
class OutputStream;
class InputStream;
 
}
 
namespace IceInternal
{
 
class Incoming;
class Direct;
class GCVisitor;
 
}
 
namespace Ice
{

ICE_API extern const Current emptyCurrent;
 
#ifndef ICE_CPP11_MAPPING
class ICE_API DispatchInterceptorAsyncCallback : public virtual IceUtil::Shared
{
public:
 
    virtual ~DispatchInterceptorAsyncCallback();

    virtual bool response() = 0;

    virtual bool exception(const std::exception& ex) = 0;

    virtual bool exception() = 0;
};
ICE_DEFINE_PTR(DispatchInterceptorAsyncCallbackPtr, DispatchInterceptorAsyncCallback);
#endif

class ICE_API Request
{
public:
 
    virtual ~Request();

    virtual const Current& getCurrent() = 0;
};
 
#ifdef ICE_CPP11_MAPPING
class ICE_API Object
{
public:
 
    virtual ~Object() = default;

    virtual bool ice_isA(std::string s, const Current& current) const;
    bool _iceD_ice_isA(IceInternal::Incoming&, const Current&);

    virtual void ice_ping(const Current& current) const;
    bool _iceD_ice_ping(IceInternal::Incoming&, const Current&);

    virtual std::vector< std::string> ice_ids(const Current& current) const;
    bool _iceD_ice_ids(IceInternal::Incoming&, const Current&);

    virtual std::string ice_id(const Current& current) const;
    bool _iceD_ice_id(IceInternal::Incoming&, const Current&);

    static const std::string& ice_staticId();

    virtual bool ice_dispatch(Ice::Request& request,
                              std::function<bool()> response = nullptr,
                              std::function<bool(std::exception_ptr)> error = nullptr);

    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);

    struct Ice_invokeResult
    {
        bool returnValue;

        std::vector<::Ice::Byte> outParams;
    };
 
protected:

    static void _iceCheckMode(OperationMode, OperationMode);
};
#else
class ICE_API Object  : public virtual IceUtil::Shared
{
public:
 
    virtual bool operator==(const Object&) const;
    virtual bool operator<(const Object&) const;

    virtual bool ice_isA(const std::string& s, const Current& current = Ice::emptyCurrent) const;
    bool _iceD_ice_isA(IceInternal::Incoming&, const Current&);

    virtual void ice_ping(const Current& current = Ice::emptyCurrent) const;
    bool _iceD_ice_ping(IceInternal::Incoming&, const Current&);

    virtual std::vector< std::string> ice_ids(const Current& current = Ice::emptyCurrent) const;
    bool _iceD_ice_ids(IceInternal::Incoming&, const Current&);

    virtual const std::string& ice_id(const Current& current = Ice::emptyCurrent) const;
    bool _iceD_ice_id(IceInternal::Incoming&, const Current&);

    virtual Int ice_operationAttributes(const std::string& operation) const;

    virtual void _iceWrite(Ice::OutputStream*) const;
    virtual void _iceRead(Ice::InputStream*);

    virtual bool _iceGcVisit(IceInternal::GCVisitor&) { return false; }

    virtual void ice_collectable(bool b);

    virtual void ice_preMarshal();

    virtual void ice_postUnmarshal();

    static const std::string& ice_staticId();

    virtual ObjectPtr ice_clone() const;

    virtual SlicedDataPtr ice_getSlicedData() const;

    virtual bool ice_dispatch(Ice::Request& request, const DispatchInterceptorAsyncCallbackPtr& cb = 0);
    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
 
protected:
 
    Object() {} // This class is abstract.
#if defined(__clang__)
#   pragma clang diagnostic push
#   pragma clang diagnostic ignored "-Wdeprecated-copy-dtor"
#endif
    virtual ~Object() {}
#if defined(__clang__)
#   pragma clang diagnostic pop
#endif
 
protected:

    virtual void _iceWriteImpl(Ice::OutputStream*) const {}
    virtual void _iceReadImpl(Ice::InputStream*) {}

    static void _iceCheckMode(OperationMode, OperationMode);
};
#endif

class ICE_API Blobject : public virtual Object
{
public:

    virtual bool ice_invoke(ICE_IN(std::vector<Byte>) inEncaps, std::vector<Byte>& outEncaps,
                            const Current& current) = 0;

    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
};

class ICE_API BlobjectArray : public virtual Object
{
public:

    virtual bool ice_invoke(ICE_IN(std::pair<const Byte*, const Byte*>) inEncaps, std::vector<Byte>& outEncaps,
                            const Current& current) = 0;

    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
};

class ICE_API BlobjectAsync : public virtual Object
{
public:
 
#ifdef ICE_CPP11_MAPPING
    virtual void ice_invokeAsync(std::vector<Byte> inEncaps,
                                 std::function<void(bool, const std::vector<Byte>&)> response,
                                 std::function<void(std::exception_ptr)> error,
                                 const Current& current) = 0;
#else
    virtual void ice_invoke_async(const AMD_Object_ice_invokePtr& cb, const std::vector<Byte>& inEncaps,
                                  const Current& current) = 0;
#endif

    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
};

class ICE_API BlobjectArrayAsync : public virtual Object
{
public:
 
#ifdef ICE_CPP11_MAPPING
    virtual void ice_invokeAsync(std::pair<const Byte*, const Byte*> inEncaps,
                                 std::function<void(bool, const std::pair<const Byte*, const Byte*>&)> response,
                                 std::function<void(std::exception_ptr)> error,
                                 const Current& current) = 0;
#else
    virtual void ice_invoke_async(const AMD_Object_ice_invokePtr& cb,
                                  const std::pair<const Byte*, const Byte*>& inEncaps,
                                  const Current& current) = 0;
#endif

    virtual bool _iceDispatch(IceInternal::Incoming&, const Current&);
};
 
}
 
#endif