Ice 3.7 Slice API Reference
Session.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICEGRID_API"]]
8 [["cpp:doxygen:include:IceGrid/IceGrid.h"]]
9 [["cpp:header-ext:h"]]
10 [["cpp:include:IceGrid/Config.h"]]
11 
12 [["ice-prefix"]]
13 
14 [["js:module:ice"]]
15 [["js:cjs-module"]]
16 
17 [["objc:dll-export:ICEGRID_API"]]
18 [["objc:header-dir:objc"]]
19 
20 [["python:pkgdir:IceGrid"]]
21 
22 #include <Glacier2/Session.ice>
23 #include <IceGrid/Exception.ice>
24 
25 #ifndef __SLICE2JAVA_COMPAT__
26 [["java:package:com.zeroc"]]
27 #endif
28 
29 ["objc:prefix:ICEGRID"]
30 module IceGrid
31 {
32 
43 interface Session extends Glacier2::Session
44 {
53  idempotent void keepAlive();
54 
75  ["amd"] Object* allocateObjectById(Ice::Identity id)
77 
94  ["amd"] Object* allocateObjectByType(string type)
95  throws AllocationException;
96 
114 
125  idempotent void setAllocationTimeout(int timeout);
126 }
127 
128 }
IceGrid::Session::releaseObject
void releaseObject(Ice::Identity id)
Release an object that was allocated using allocateObjectById or allocateObjectByType.
IceGrid::Session
A session object is used by IceGrid clients to allocate and release objects.
Definition: Session.ice:44
IceGrid::Session::keepAlive
idempotent void keepAlive()
Keep the session alive.
IceGrid::Session::setAllocationTimeout
idempotent void setAllocationTimeout(int timeout)
Set the allocation timeout.
Session.ice
IceGrid::ObjectNotRegisteredException
This exception is raised if an object is not registered.
Definition: Exception.ice:147
Glacier2::Session
A client-visible session object, which is tied to the lifecycle of a Router.
Definition: Session.ice:57
IceGrid::Session::allocateObjectById
Object * allocateObjectById(Ice::Identity id)
Allocate an object.
IceGrid
Definition: Admin.ice:36
Exception.ice
Ice::Identity
The identity of an Ice object.
Definition: Identity.ice:40
IceGrid::Session::allocateObjectByType
Object * allocateObjectByType(string type)
Allocate an object with the given type.
IceGrid::AllocationException
This exception is raised if the allocation of an object failed.
Definition: Exception.ice:320