Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
Glacier2::IdentitySet Class Referenceabstract

An object for managing the set of object identity constraints on a Session. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::IdentitySet:
Collaboration diagram for Glacier2::IdentitySet:

Public Types

typedef IdentitySetPtr PointerType
typedef IdentitySetPrx ProxyType

Public Member Functions

virtual void add (const ::Ice::IdentitySeq &additions, const ::Ice::Current &current=::Ice::emptyCurrent)=0
 Add a sequence of Ice identities to this set of constraints.
virtual::Ice::IdentitySeq get (const ::Ice::Current &current=::Ice::emptyCurrent)=0
 Returns a sequence of identities describing the constraints in this set.
virtual const ::std::string & ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string > ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
 Determines whether this object supports an interface with the given Slice type ID.
virtual void remove (const ::Ice::IdentitySeq &deletions, const ::Ice::Current &current=::Ice::emptyCurrent)=0
 Remove a sequence of identities from this set of constraints.
virtual ~IdentitySet ()
Public Member Functions inherited from Ice::Object
virtual ObjectPtr ice_clone () const
 Returns a shallow copy of the object.
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.
virtual bool ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
 Dispatches an invocation to a servant.
virtual SlicedDataPtr ice_getSlicedData () const
 Obtains the sliced data associated with this instance.
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.
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.
virtual bool ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
 Tests whether this object supports a specific Slice interface.
virtual Int ice_operationAttributes (const std::string &operation) const
 Returns the Freeze metadata attributes for an operation.
virtual void ice_ping (const Current &current=Ice::emptyCurrent) const
 Tests whether this object can be reached.
virtual void ice_postUnmarshal ()
 The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void ice_preMarshal ()
 The Ice run time invokes this method prior to marshaling an object's data members.
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 ()

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type.

Additional Inherited Members

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

An object for managing the set of object identity constraints on a Session.

See also
Session
SessionControl

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~IdentitySet()

virtual Glacier2::IdentitySet::~IdentitySet ( )
virtual

Member Function Documentation

◆ add()

virtual void Glacier2::IdentitySet::add ( const ::Ice::IdentitySeq & additions,
const ::Ice::Current & current = ::Ice::emptyCurrent )
pure virtual

Add a sequence of Ice identities to this set of constraints.

Order is not preserved and duplicates are implicitly removed.

Parameters
additionsThe sequence of Ice identities to be added.
currentThe Current object for the invocation.

◆ get()

virtual::Ice::IdentitySeq Glacier2::IdentitySet::get ( const ::Ice::Current & current = ::Ice::emptyCurrent)
pure virtual

Returns a sequence of identities describing the constraints in this set.

Parameters
currentThe Current object for the invocation.
Returns
The sequence of Ice identities for this set.

◆ ice_id()

virtual const ::std::string & Glacier2::IdentitySet::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent) const
virtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector< ::std::string > Glacier2::IdentitySet::ice_ids ( const ::Ice::Current & current = ::Ice::emptyCurrent) const

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool Glacier2::IdentitySet::ice_isA ( const ::std::string & id,
const ::Ice::Current & current = ::Ice::emptyCurrent ) const
virtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

◆ ice_staticId()

const ::std::string & Glacier2::IdentitySet::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ remove()

virtual void Glacier2::IdentitySet::remove ( const ::Ice::IdentitySeq & deletions,
const ::Ice::Current & current = ::Ice::emptyCurrent )
pure virtual

Remove a sequence of identities from this set of constraints.

No errors are returned if an entry is not found.

Parameters
deletionsThe sequence of Ice identities to be removed.
currentThe Current object for the invocation.

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