Ice 3.7 C++11 API Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for Glacier2::IdentitySet:
Collaboration graph
[legend]

Public Types

using ProxyType = IdentitySetPrx
 

Public Member Functions

virtual void add (::Ice::IdentitySeq additions, const ::Ice::Current &current)=0
 Add a sequence of Ice identities to this set of constraints. More...
 
virtual ::Ice::IdentitySeq get (const ::Ice::Current &current)=0
 Returns a sequence of identities describing the constraints in this set. More...
 
virtual ::std::string ice_id (const ::Ice::Current &current) const override
 Obtains a Slice type ID representing the most-derived interface supported by this object. More...
 
virtual ::std::vector<::std::string > ice_ids (const ::Ice::Current &current) const override
 Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
 
virtual bool ice_isA (::std::string id, const ::Ice::Current &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
virtual void remove (::Ice::IdentitySeq deletions, const ::Ice::Current &current)=0
 Remove a sequence of identities from this set of constraints. More...
 
- Public Member Functions inherited from Ice::Object
virtual bool ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
 Dispatches an invocation to a servant. More...
 
virtual std::string ice_id (const Current &current) 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) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) const
 Tests whether this object can be reached. More...
 
virtual ~Object ()=default
 

Static Public Member Functions

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

Detailed Description

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

See also
Session
SessionControl

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ add()

virtual void Glacier2::IdentitySet::add ( ::Ice::IdentitySeq  additions,
const ::Ice::Current current 
)
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)
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 ::std::string Glacier2::IdentitySet::ice_id ( const ::Ice::Current current) const
override

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) const
override

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 ( ::std::string  id,
const ::Ice::Current current 
) const
overridevirtual

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()

static 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 ( ::Ice::IdentitySeq  deletions,
const ::Ice::Current current 
)
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: