3.7/slice/Glacier2_2Router_8ice_source.html

//

// Copyright (c) ZeroC, Inc. All rights reserved.

//


#pragma once


[["cpp:dll-export:GLACIER2_API"]]

[["cpp:doxygen:include:Glacier2/Glacier2.h"]]

[["cpp:header-ext:h"]]

[["cpp:include:Glacier2/Config.h"]]


[["js:module:ice"]]

[["js:cjs-module"]]


[["objc:dll-export:GLACIER2_API"]]

[["objc:header-dir:objc"]]


[["python:pkgdir:Glacier2"]]


#include <Ice/Router.ice>

#include <Glacier2/Session.ice>

#include <Glacier2/PermissionsVerifier.ice>


#ifndef __SLICE2JAVA_COMPAT__

[["java:package:com.zeroc"]]

#endif


["objc:prefix:GLACIER2"]

module Glacier2

{


exception SessionNotExistException

{

}


interface Router extends Ice::Router

{

    ["nonmutating", "cpp:const"] idempotent string getCategoryForClient();


    ["amd", "format:sliced"] Session* createSession(string userId, string password)

        throws PermissionDeniedException, CannotCreateSessionException;


    ["amd", "format:sliced"] Session* createSessionFromSecureConnection()

        throws PermissionDeniedException, CannotCreateSessionException;


    ["amd"] void refreshSession()

        throws SessionNotExistException;


    void destroySession()

        throws SessionNotExistException;


    ["nonmutating", "cpp:const"] idempotent long getSessionTimeout();


    ["nonmutating", "cpp:const"] idempotent int getACMTimeout();

}


}

Session.ice

Router.ice

PermissionsVerifier.ice

Glacier2::CannotCreateSessionException
This exception is raised if an attempt to create a new session failed.
Definition Session.ice:39

Glacier2::PermissionDeniedException
This exception is raised if a client is denied the ability to create a session with the router.
Definition PermissionsVerifier.ice:38

Glacier2::SessionNotExistException
This exception is raised if a client tries to destroy a session with a router, but no session exists ...
Definition Router.ice:49

Glacier2::Router
The Glacier2 specialization of the Ice::Router interface.
Definition Router.ice:58

Glacier2::Router::getACMTimeout
idempotent int getACMTimeout()
Get the value of the ACM timeout.

Glacier2::Router::refreshSession
void refreshSession()
Keep the calling client's session with this router alive.

Glacier2::Router::getSessionTimeout
idempotent long getSessionTimeout()
Get the value of the session timeout.

Glacier2::Router::createSessionFromSecureConnection
Session * createSessionFromSecureConnection()
Create a per-client session with the router.

Glacier2::Router::getCategoryForClient
idempotent string getCategoryForClient()
This category must be used in the identities of all of the client's callback objects.

Glacier2::Router::createSession
Session * createSession(string userId, string password)
Create a per-client session with the router.

Glacier2::Router::destroySession
void destroySession()
Destroy the calling client's session with this router.

Glacier2::Session
A client-visible session object, which is tied to the lifecycle of a Router.
Definition Session.ice:57

Ice::Router
The Ice router interface.
Definition Router.ice:39

Glacier2
Glacier2 is a firewall solution for Ice.
Definition PermissionsVerifier.ice:28