IceGrid::Registry Interface Reference

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

defined in <IceGrid/Registry.ice>

interface Registry { ... }

Operations
AdminSession *	createAdminSession (string userId, string password) throws PermissionDeniedException
	Create an administrative session. More...
AdminSession *	createAdminSessionFromSecureConnection () throws PermissionDeniedException
	Create an administrative session from a secure connection. More...
Session *	createSession (string userId, string password) throws PermissionDeniedException
	Create a client session. More...
Session *	createSessionFromSecureConnection () throws PermissionDeniedException
	Create a client session from a secure connection. More...
idempotent int	getACMTimeout ()
	Get the value of the ACM timeout. More...
idempotent int	getSessionTimeout ()
	Get the session timeout. More...

Detailed Description

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

See also

Session

AdminSession

Operation Documentation

createAdminSession()

AdminSession* createAdminSession	(	string	userId,
		string	password
	)		throws PermissionDeniedException

Create an administrative session.

Returns

A proxy for the newly created session.

Parameters

userId	The user id.
password	The password for the given user id.

Exceptions

PermissionDeniedException

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

createAdminSessionFromSecureConnection()

AdminSession* createAdminSessionFromSecureConnection

(

)

throws PermissionDeniedException

Create an administrative session from a secure connection.

Returns

A proxy for the newly created session.

Exceptions

PermissionDeniedException

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

createSession()

Session* createSession	(	string	userId,
		string	password
	)		throws PermissionDeniedException

Create a client session.

Returns

A proxy for the newly created session.

Parameters

userId	The user id.
password	The password for the given user id.

Exceptions

PermissionDeniedException

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

createSessionFromSecureConnection()

Session* createSessionFromSecureConnection

(

)

throws PermissionDeniedException

Create a client session from a secure connection.

Returns

A proxy for the newly created session.

Exceptions

PermissionDeniedException

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

getACMTimeout()

["nonmutating","cpp:const"]

idempotent int getACMTimeout

(

)

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.

Returns

The timeout (in seconds).

getSessionTimeout()

["nonmutating","cpp:const"]

idempotent int getSessionTimeout

(

)

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.

See also

Session::keepAlive

AdminSession::keepAlive

Returns

The timeout (in seconds).

---

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

• IceGrid/Registry.ice