The IceGrid registry allows clients create sessions directly with the registry. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Registry:

[legend]

Collaboration diagram for IceGrid::Registry:

[legend]

Public Types
typedef RegistryPtr	PointerType
typedef RegistryPrx	ProxyType

Public Member Functions
virtual AdminSessionPrx	createAdminSession (const ::std::string &userId, const ::std::string &password, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Create an administrative session.
virtual AdminSessionPrx	createAdminSessionFromSecureConnection (const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Create an administrative session from a secure connection.
virtual SessionPrx	createSession (const ::std::string &userId, const ::std::string &password, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Create a client session.
virtual SessionPrx	createSessionFromSecureConnection (const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Create a client session from a secure connection.
virtual::Ice::Int	getACMTimeout (const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Get the value of the ACM timeout.
virtual::Ice::Int	getSessionTimeout (const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Get the session timeout.
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	~Registry ()
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

The IceGrid registry allows clients create sessions directly with the registry.

See also: Session; AdminSession

Member Typedef Documentation

◆ PointerType

typedef RegistryPtr IceGrid::Registry::PointerType

◆ ProxyType

typedef RegistryPrx IceGrid::Registry::ProxyType

Constructor & Destructor Documentation

◆ ~Registry()

virtual IceGrid::Registry::~Registry ( )

virtual

Member Function Documentation

◆ createAdminSession()

virtual AdminSessionPrx IceGrid::Registry::createAdminSession	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

pure virtual

Create an administrative session.

Parameters

userId	The user id.
password	The password for the given user id.
current	The Current object for the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createAdminSessionFromSecureConnection()

virtual AdminSessionPrx IceGrid::Registry::createAdminSessionFromSecureConnection ( const ::Ice::Current & current = ::Ice::emptyCurrent )

pure virtual

Create an administrative session from a secure connection.

Parameters

current The Current object for the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createSession()

virtual SessionPrx IceGrid::Registry::createSession	(	const ::std::string &	userId,
		const ::std::string &	password,
		const ::Ice::Current &	current = ::Ice::emptyCurrent )

pure virtual

Create a client session.

Parameters

userId	The user id.
password	The password for the given user id.
current	The Current object for the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ createSessionFromSecureConnection()

virtual SessionPrx IceGrid::Registry::createSessionFromSecureConnection ( const ::Ice::Current & current = ::Ice::emptyCurrent )

pure virtual

Create a client session from a secure connection.

Parameters

current The Current object for the invocation.

Returns: A proxy for the newly created session.

Exceptions

IceGrid::PermissionDeniedException Raised if the password for the given user id is not correct, or if the user is not allowed access.

◆ getACMTimeout()

virtual::Ice::Int IceGrid::Registry::getACMTimeout ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

pure virtual

Get the value of the ACM timeout.

Clients supporting ACM connection heartbeats can enable them instead of explicitly sending keep alives requests.

NOTE: This method is only available since Ice 3.6.

Parameters

current The Current object for the invocation.

Returns: The timeout (in seconds).

◆ getSessionTimeout()

virtual::Ice::Int IceGrid::Registry::getSessionTimeout ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

pure virtual

Get the session timeout.

If a client or administrative client doesn't call the session keepAlive method in the time interval defined by this timeout, IceGrid might reap the session.

Parameters

current The Current object for the invocation.

Returns: The timeout (in seconds).

See also: Session::keepAlive; AdminSession::keepAlive

◆ ice_id()

virtual const ::std::string & IceGrid::Registry::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.

◆ ice_ids()

virtual ::std::vector< ::std::string > IceGrid::Registry::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 IceGrid::Registry::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.

◆ ice_staticId()

const ::std::string & IceGrid::Registry::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/IceGrid/Registry.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~Registry()

Member Function Documentation

◆ createAdminSession()

◆ createAdminSessionFromSecureConnection()

◆ createSession()

◆ createSessionFromSecureConnection()

◆ getACMTimeout()

◆ getSessionTimeout()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()