Ice 3.7 C++98 API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Ice::Blobject Class Referenceabstract

Base class for dynamic dispatch servants. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::Blobject:
Inheritance graph
[legend]
Collaboration diagram for Ice::Blobject:
Collaboration graph
[legend]

Public Member Functions

virtual bool ice_invoke (const std::vector< Byte > &inEncaps, std::vector< Byte > &outEncaps, const Current &current)=0
 Dispatch an incoming request. More...
 
- Public Member Functions inherited from Ice::Object
virtual ObjectPtr ice_clone () const
 Returns a shallow copy of the object. More...
 
virtual void ice_collectable (bool b)
 Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released. More...
 
virtual bool ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
 Dispatches an invocation to a servant. More...
 
virtual SlicedDataPtr ice_getSlicedData () const
 Obtains the sliced data associated with this instance. More...
 
virtual const std::string & ice_id (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type ID of the most-derived interface supported by this object. More...
 
virtual std::vector< std::string > ice_ids (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual Int ice_operationAttributes (const std::string &operation) const
 Returns the Freeze metadata attributes for an operation. More...
 
virtual void ice_ping (const Current &current=Ice::emptyCurrent) const
 Tests whether this object can be reached. More...
 
virtual void ice_postUnmarshal ()
 The Ice run time invokes this method vafter unmarshaling an object's data members. More...
 
virtual void ice_preMarshal ()
 The Ice run time invokes this method prior to marshaling an object's data members. More...
 
virtual bool operator< (const Object &) const
 
virtual bool operator== (const Object &) const
 
- Public Member Functions inherited from IceUtil::Shared
void __clearFlag (unsigned char flag)
 
virtual void __decRef ()
 
virtual int __getRef () const
 
bool __hasFlag (unsigned char flag)
 
virtual void __incRef ()
 
void __setFlag (unsigned char flag)
 
virtual void __setNoDelete (bool)
 
Sharedoperator= (const Shared &)
 
 Shared ()
 
 Shared (const Shared &)
 
virtual ~Shared ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type. More...
 
- Static Public Attributes inherited from IceUtil::Shared
static const unsigned char NoDelete
 
- Protected Member Functions inherited from Ice::Object
 Object ()
 
virtual ~Object ()
 
- Protected Attributes inherited from IceUtil::Shared
unsigned char _flags
 
IceUtilInternal::Atomic _ref
 

Detailed Description

Base class for dynamic dispatch servants.

A server application derives a concrete servant class from Blobject that implements the ice_invoke method.

Member Function Documentation

◆ ice_invoke()

virtual bool Ice::Blobject::ice_invoke ( const std::vector< Byte > &  inEncaps,
std::vector< Byte > &  outEncaps,
const Current current 
)
pure virtual

Dispatch an incoming request.

Parameters
inEncapsAn encapsulation containing the encoded in-parameters for the operation.
outEncapsAn encapsulation containing the encoded results for the operation.
currentThe Current object for the invocation.
Returns
True if the operation completed successfully, in which case outEncaps contains an encapsulation of the encoded results, or false if the operation raised a user exception, in which case outEncaps contains an encapsulation of the encoded user exception.
Exceptions
UserExceptionA user exception can be raised directly and the run time will marshal it.

The documentation for this class was generated from the following file: