Glacier2::Session Class Reference

A client-visible session object, which is tied to the lifecycle of a Router. More...

#include <Glacier2/Glacier2.h>

Inheritance diagram for Glacier2::Session:

Collaboration diagram for Glacier2::Session:

Public Types
typedef SessionPtr	PointerType
typedef SessionPrx	ProxyType

Public Member Functions
virtual void	destroy (const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Destroy the session.
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	~Session ()
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)
Shared &	operator= (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

A client-visible session object, which is tied to the lifecycle of a Router.

See also

Router

SessionManager

Member Typedef Documentation

PointerType

typedef SessionPtr Glacier2::Session::PointerType

ProxyType

typedef SessionPrx Glacier2::Session::ProxyType

Constructor & Destructor Documentation

~Session()

virtual Glacier2::Session::~Session ( )

virtual

Reimplemented in IceGrid::Session.

Member Function Documentation

destroy()

virtual void Glacier2::Session::destroy ( const ::Ice::Current & current = ::Ice::emptyCurrent )

pure virtual

Destroy the session.

This is called automatically when the router is destroyed.

Parameters

current

The Current object for the invocation.

ice_id()

virtual const ::std::string & Glacier2::Session::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

current

The Current object for the invocation.

Returns

A fully-scoped type ID.

Reimplemented in IceGrid::AdminSession, and IceGrid::Session.

ice_ids()

virtual ::std::vector< ::std::string > Glacier2::Session::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

current

The Current object for the invocation.

Returns

A list of fully-scoped type IDs.

ice_isA()

virtual bool Glacier2::Session::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

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns

True if this object supports the interface, false, otherwise.

Reimplemented in IceGrid::AdminSession, and IceGrid::Session.

ice_staticId()

const ::std::string & Glacier2::Session::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns

A fully-scoped type ID.

---

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

• generated/cpp98/x64/Release/Glacier2/Session.h