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

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Registry:

Collaboration diagram for IceGrid::Registry:

Public Types
using	ProxyType = RegistryPrx

Public Member Functions
virtual ::std::shared_ptr< AdminSessionPrx >	createAdminSession (::std::string userId, ::std::string password, const ::Ice::Current &current)=0
	Create an administrative session.
virtual ::std::shared_ptr< AdminSessionPrx >	createAdminSessionFromSecureConnection (const ::Ice::Current &current)=0
	Create an administrative session from a secure connection.
virtual ::std::shared_ptr< SessionPrx >	createSession (::std::string userId, ::std::string password, const ::Ice::Current &current)=0
	Create a client session.
virtual ::std::shared_ptr< SessionPrx >	createSessionFromSecureConnection (const ::Ice::Current &current)=0
	Create a client session from a secure connection.
virtual int	getACMTimeout (const ::Ice::Current &current) const =0
	Get the value of the ACM timeout.
virtual int	getSessionTimeout (const ::Ice::Current &current) const =0
	Get the session timeout.
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.
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.
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.
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.
virtual std::string	ice_id (const Current &current) 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) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface.
virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached.
virtual	~Object ()=default

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.

Detailed Description

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

See also: Session; AdminSession

Member Typedef Documentation

◆ ProxyType

using IceGrid::Registry::ProxyType = RegistryPrx

Member Function Documentation

◆ createAdminSession()

virtual ::std::shared_ptr< AdminSessionPrx > IceGrid::Registry::createAdminSession	(	::std::string	userId,
		::std::string	password,
		const ::Ice::Current &	current )

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 ::std::shared_ptr< AdminSessionPrx > IceGrid::Registry::createAdminSessionFromSecureConnection ( const ::Ice::Current & current )

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 ::std::shared_ptr< SessionPrx > IceGrid::Registry::createSession	(	::std::string	userId,
		::std::string	password,
		const ::Ice::Current &	current )

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 ::std::shared_ptr< SessionPrx > IceGrid::Registry::createSessionFromSecureConnection ( const ::Ice::Current & current )

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 int IceGrid::Registry::getACMTimeout ( const ::Ice::Current & current ) 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 int IceGrid::Registry::getSessionTimeout ( const ::Ice::Current & current ) 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::std::string IceGrid::Registry::ice_id ( const ::Ice::Current & current ) const

override

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

override

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

overridevirtual

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/cpp11/x64/Release/IceGrid/Registry.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ createAdminSession()

◆ createAdminSessionFromSecureConnection()

◆ createSession()

◆ createSessionFromSecureConnection()

◆ getACMTimeout()

◆ getSessionTimeout()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()