blob: 318ae22909d1f18bb17a189b2e67eec511aa0a8a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
// **********************************************************************
//
// Copyright (c) 2003-2017 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
#pragma once
[["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
[["cpp:include:IceGrid/Config.h"]]
#include <Glacier2/Session.ice>
#include <IceGrid/Exception.ice>
["objc:prefix:ICEGRID"]
module IceGrid
{
/**
*
* A session object is used by IceGrid clients to allocate and
* release objects. Client sessions are either created with the
* {@link Registry} object or the registry client {@link Glacier2.SessionManager}
* object.
*
* @see Registry
* @see Glacier2.SessionManager
*
**/
interface Session extends Glacier2::Session
{
/**
*
* Keep the session alive. Clients should call this operation
* regularly to prevent the server from reaping the session.
*
* @see Registry#getSessionTimeout
*
**/
idempotent void keepAlive();
/**
*
* Allocate an object. Depending on the allocation timeout, this
* operation might hang until the object is available or until the
* timeout is reached.
*
* @param id The identity of the object to allocate.
*
* @return The proxy of the allocated object.
*
* @throws ObjectNotRegisteredException Raised if the object with
* the given identity is not registered with the registry.
*
* @throws AllocationException Raised if the object can't be
* allocated.
*
* @see #setAllocationTimeout
* @see #releaseObject
*
**/
["amd"] Object* allocateObjectById(Ice::Identity id)
throws ObjectNotRegisteredException, AllocationException;
/**
*
* Allocate an object with the given type. Depending on the
* allocation timeout, this operation can block until an object
* becomes available or until the timeout is reached.
*
* @param type The type of the object.
*
* @return The proxy of the allocated object.
*
* @throws ObjectNotRegisteredException Raised if no objects with the given type can be allocated.
*
* @throws AllocationException Raised if the object could not be allocated.
*
* @see #setAllocationTimeout
* @see #releaseObject
*
**/
["amd"] Object* allocateObjectByType(string type)
throws AllocationException;
/**
*
* Release an object that was allocated using <tt>allocateObjectById</tt> or
* <tt>allocateObjectByType</tt>.
*
* @param id The identity of the object to release.
*
* @throws ObjectNotRegisteredException Raised if the object with
* the given identity is not registered with the registry.
*
* @throws AllocationException Raised if the given object can't be
* released. This might happen if the object isn't allocatable or
* isn't allocated by the session.
*
**/
void releaseObject(Ice::Identity id)
throws ObjectNotRegisteredException, AllocationException;
/**
*
* Set the allocation timeout. If no objects are available for an
* allocation request, a call to <tt>allocateObjectById</tt> or
* <tt>allocateObjectByType</tt> will block for the duration of this
* timeout.
*
* @param timeout The timeout in milliseconds.
*
**/
idempotent void setAllocationTimeout(int timeout);
};
};
|
