|
70
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
2 |
<html>
|
|
|
3 |
<head>
|
|
|
4 |
<title>Target Communication Framework Services - Streams</title>
|
|
|
5 |
</head>
|
|
|
6 |
|
|
|
7 |
<body lang='EN-US'>
|
|
|
8 |
|
|
|
9 |
<h1>Target Communication Framework Services - Streams</h1>
|
|
|
10 |
|
|
|
11 |
<ul>
|
|
|
12 |
<li><a href='#VersionHistory'>Version History</a>
|
|
|
13 |
<li><a href='#Overview'>Overview</a>
|
|
|
14 |
<li><a href='#Cmds'>Commands</a>
|
|
|
15 |
<ul>
|
|
|
16 |
<li><a href='#CmdSubscribe'>Subscribe</a>
|
|
|
17 |
<li><a href='#CmdUnsubscribe'>Unsubscribe</a>
|
|
|
18 |
<li><a href='#CmdRead'>Read</a>
|
|
|
19 |
<li><a href='#CmdWrite'>Write</a>
|
|
|
20 |
<li><a href='#CmdEOS'>End of Stream</a>
|
|
|
21 |
<li><a href='#CmdConnect'>Connect</a>
|
|
|
22 |
<li><a href='#CmdDisconnect'>Disconnect</a>
|
|
|
23 |
</ul>
|
|
|
24 |
<li><a href='#Events'>Events</a>
|
|
|
25 |
<li><a href='#API'>API</a>
|
|
|
26 |
</ul>
|
|
|
27 |
|
|
|
28 |
<h1>Streams Service</h1>
|
|
|
29 |
|
|
|
30 |
<h2><a name='VersionHistory'>Version History</a></h2>
|
|
|
31 |
|
|
|
32 |
<table border=1 cellpadding=8>
|
|
|
33 |
<tr>
|
|
|
34 |
<th>Version
|
|
|
35 |
<th>Date
|
|
|
36 |
<th>Change
|
|
|
37 |
<tr>
|
|
|
38 |
<td>0.1
|
|
|
39 |
<td>2009-03-17
|
|
|
40 |
<td>Initial contribution
|
|
|
41 |
<tr>
|
|
|
42 |
<td>0.2
|
|
|
43 |
<td>2009-05-18
|
|
|
44 |
<td>Added connect command
|
|
|
45 |
<tr>
|
|
|
46 |
<td>0.3
|
|
|
47 |
<td>2009-08-13
|
|
|
48 |
<td>Added "context ID" argument in "created" event
|
|
|
49 |
</table>
|
|
|
50 |
|
|
|
51 |
<h2><a name='Overview'>Overview</a></h2>
|
|
|
52 |
|
|
|
53 |
<p>Streams service is a generic interface to support streaming of data between host and remote agents.
|
|
|
54 |
|
|
|
55 |
<p>The service supports:
|
|
|
56 |
<ul>
|
|
|
57 |
<li> Asynchronous overlapped data streaming: multiple 'read' or 'write' command can be issued at same time, both peers
|
|
|
58 |
can continue data processing concurrently with data transmission.
|
|
|
59 |
<li> Multicast: multiple clients can receive data from same stream.
|
|
|
60 |
<li> Subscription model: clients are required to expressed interest in particular streams by subscribing for the service.
|
|
|
61 |
<li> Flow control: peers can throttle data flow of individual streams by delaying 'read' and 'write' commands.
|
|
|
62 |
</ul>
|
|
|
63 |
|
|
|
64 |
<p> Command and event parameters are encoded as zero terminated <a href='TCF Specification.html#JSON'>JSON</a> strings.</p>
|
|
|
65 |
|
|
|
66 |
<p>The service uses standard format for error reports,
|
|
|
67 |
see <a href='TCF Services.html#ErrorFormat'>Error Report Format</a>.</p>
|
|
|
68 |
|
|
|
69 |
<h2><a name='Cmds'>Commands</a></h2>
|
|
|
70 |
|
|
|
71 |
<h3><a name='CmdSubscribe'>Subscribe</a></h3>
|
|
|
72 |
|
|
|
73 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
74 |
C • <i><token></i> • Streams • subscribe • <i><string: stream source type></i> •
|
|
|
75 |
</font></b></pre>
|
|
|
76 |
|
|
|
77 |
<p>Clients must subscribe for one or more stream source types to be able to send or receive stream data.
|
|
|
78 |
Stream source type name are defined by other services that use streams to transfer data.
|
|
|
79 |
For example, <a href='TCF Service - Processes.html'>Processes Service</a> defines
|
|
|
80 |
"Processes" strem source that represents standard input/output streams.
|
|
|
81 |
Subscribers receive notifications when a stream of given type is created or disposed.
|
|
|
82 |
Subscribers are required to respond with 'read' or 'disconnect' commands as necessary.</p>
|
|
|
83 |
|
|
|
84 |
<p>Reply:</p>
|
|
|
85 |
|
|
|
86 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
87 |
R • <i><token></i> • <i><error report></i> •
|
|
|
88 |
</font></b></pre>
|
|
|
89 |
|
|
|
90 |
<p>If no error is reported, the client becomes a subscriber of streams of the given type - until channel is closed or
|
|
|
91 |
the subscribtion is canceled by <b>unsubscribe</b> command.
|
|
|
92 |
When new stream is created, each subscriber must decide if it is interested in that particular stream instance.
|
|
|
93 |
If not interested, subscriber should send 'disconnect' command to allow remote peer to free resources and bandwidth allocated for the stream.
|
|
|
94 |
If not disconnected, subscriber is required to send 'read' commands as necessary to pump stream data and prevent stream buffer overflow.
|
|
|
95 |
</p>
|
|
|
96 |
|
|
|
97 |
<h3><a name='CmdUnsubscribe'>Unsubscribe</a></h3>
|
|
|
98 |
|
|
|
99 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
100 |
C • <i><token></i> • Streams • unsubscribe • <i><string: stream source type></i> •
|
|
|
101 |
</font></b></pre>
|
|
|
102 |
|
|
|
103 |
<p>Unsubscribe the client from given stream source type.</p>
|
|
|
104 |
|
|
|
105 |
<p>Reply:</p>
|
|
|
106 |
|
|
|
107 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
108 |
R • <i><token></i> • <i><error report></i> •
|
|
|
109 |
</font></b></pre>
|
|
|
110 |
|
|
|
111 |
<h3><a name='CmdRead'>Read</a></h3>
|
|
|
112 |
|
|
|
113 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
114 |
C • <i><token></i> • Streams • read • <i><string: stream ID></i> • <i><int: size></i> •
|
|
|
115 |
</font></b></pre>
|
|
|
116 |
|
|
|
117 |
<ul>
|
|
|
118 |
<li><dt><code><b>stream ID</b></code> <dd>ID of stream that will be read.
|
|
|
119 |
<li><dt><code><b>size</b></code> <dd>Maximum number of bytes to read.
|
|
|
120 |
</ul>
|
|
|
121 |
|
|
|
122 |
<p>The command reads data from a stream. If stream buffer is empty, the command will wait until data is available.
|
|
|
123 |
Remote peer will continue to process other commands while 'read' command is pending.
|
|
|
124 |
Client can send more 'read' commands without waiting for the first command to complete.
|
|
|
125 |
Doing that improves communication channel bandwidth utilization.
|
|
|
126 |
Pending 'read' commands will be executed in same order as issued.
|
|
|
127 |
Client can delay sending of 'read' command if it is not ready to receive more data,
|
|
|
128 |
however, delaying for too long can cause stream buffer overflow and lost of data.
|
|
|
129 |
.</p>
|
|
|
130 |
|
|
|
131 |
<p>Reply:</p>
|
|
|
132 |
|
|
|
133 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
134 |
R • <i><token></i> • <i><string: data></i> • <i><error report></i> • <i><int: lost size></i> • <i><boolean: EOS></i> •
|
|
|
135 |
</font></b></pre>
|
|
|
136 |
|
|
|
137 |
<ul>
|
|
|
138 |
<li><dt><code><b>data</b></code> <dd>BASE64 encoded bytes that were read from the stream.
|
|
|
139 |
<li><dt><code><b>lost size</b></code> <dd>Number of bytes that were lost because of buffer overflow.
|
|
|
140 |
-1 means unknown number of bytes were lost. if both 'lost_size' and 'data.length' are non-zero then lost bytes are considered
|
|
|
141 |
located right before read bytes.
|
|
|
142 |
<li><dt><code><b>EOS</b></code> <dd>true if end of stream was reached.
|
|
|
143 |
</ul>
|
|
|
144 |
|
|
|
145 |
<h3><a name='CmdWrite'>Write</a></h3>
|
|
|
146 |
|
|
|
147 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
148 |
C • <i><token></i> • Streams • write • <i><string: stream ID></i> • <i><int: size></i> • <i><string: data></i> •
|
|
|
149 |
</font></b></pre>
|
|
|
150 |
|
|
|
151 |
<ul>
|
|
|
152 |
<li><dt><code><b>stream ID</b></code> <dd>ID of stream that will receive the data.
|
|
|
153 |
<li><dt><code><b>size</b></code> <dd>Number of bytes to write. Length of <code><b>data</b></code> must match the size.
|
|
|
154 |
<li><dt><code><b>data</b></code> <dd>BASE64 encoded bytes that will be written to the stream.
|
|
|
155 |
</ul>
|
|
|
156 |
|
|
|
157 |
<p>The command writes data to a stream. If stream buffer is full, the command will wait until space is available.
|
|
|
158 |
Remote peer will continue to process other commands while 'write' command is pending.
|
|
|
159 |
Client can send more 'write' commands without waiting for the first command to complete.
|
|
|
160 |
Doing that improves communication channel bandwidth utilization.
|
|
|
161 |
Pending 'write' commands will be executed in same order as issued.</p>
|
|
|
162 |
|
|
|
163 |
<p>Reply:</p>
|
|
|
164 |
|
|
|
165 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
166 |
R • <i><token></i> • <i><error report></i> •
|
|
|
167 |
</font></b></pre>
|
|
|
168 |
|
|
|
169 |
<h3><a name='CmdEOS'>End of Stream</a></h3>
|
|
|
170 |
|
|
|
171 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
172 |
C • <i><token></i> • Streams • eos • <i><string: stream ID></i> •
|
|
|
173 |
</font></b></pre>
|
|
|
174 |
|
|
|
175 |
<p>The command sends End Of Stream marker to a stream. No more writing to the stream is allowed after that.</p>
|
|
|
176 |
|
|
|
177 |
<p>Reply:</p>
|
|
|
178 |
|
|
|
179 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
180 |
R • <i><token></i> • <i><error report></i> •
|
|
|
181 |
</font></b></pre>
|
|
|
182 |
|
|
|
183 |
<h3><a name='CmdConnect'>Connect</a></h3>
|
|
|
184 |
|
|
|
185 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
186 |
C • <i><token></i> • Streams • connect • <i><string: stream ID></i> •
|
|
|
187 |
</font></b></pre>
|
|
|
188 |
|
|
|
189 |
<p>The command connects client to a stream. Some data might be dropped from the stream by the time "connect" command is executed.
|
|
|
190 |
Client should be able to re-sync with stream data if it wants to read from such stream.
|
|
|
191 |
If a client wants to read a stream from the beginning it should use "subscribe" command instead of "connect"</p>
|
|
|
192 |
|
|
|
193 |
<p>Reply:</p>
|
|
|
194 |
|
|
|
195 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
196 |
R • <i><token></i> • <i><error report></i> •
|
|
|
197 |
</font></b></pre>
|
|
|
198 |
|
|
|
199 |
<h3><a name='CmdDisconnect'>Disconnect</a></h3>
|
|
|
200 |
|
|
|
201 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
202 |
C • <i><token></i> • Streams • disconnect • <i><string: stream ID></i> •
|
|
|
203 |
</font></b></pre>
|
|
|
204 |
|
|
|
205 |
<p>The command disconnects client from a stream. Note that disconnect does not destroy the stream, client on other channels can
|
|
|
206 |
continue reading or writing the stream.</p>
|
|
|
207 |
|
|
|
208 |
<p>Reply:</p>
|
|
|
209 |
|
|
|
210 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
211 |
R • <i><token></i> • <i><error report></i> •
|
|
|
212 |
</font></b></pre>
|
|
|
213 |
|
|
|
214 |
<h2><a name='Events'>Events</a></h2>
|
|
|
215 |
|
|
|
216 |
<p>Streams service sends events when a stream is created or disposed. Only clients with active subscribtion will recceive the events.
|
|
|
217 |
Clients can change their subscription with <b>subscribe</b> and <b>unsubscribe</b> commands.</p>
|
|
|
218 |
|
|
|
219 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
220 |
E • Streams • created • <i><string: stream type></i> • <i><string: stream ID></i> • <i><string: context ID></i> •
|
|
|
221 |
</font></b></pre>
|
|
|
222 |
<p>
|
|
|
223 |
Sent when a new stream is created.
|
|
|
224 |
"stream type" - source type of the stream.
|
|
|
225 |
"stream ID" - ID of the stream.
|
|
|
226 |
"context ID" - a context ID that is associated with the stream, or null.
|
|
|
227 |
</p>
|
|
|
228 |
<p>
|
|
|
229 |
Exact meaning of the context ID depends on stream type.
|
|
|
230 |
Stream types and context IDs are defined by services that use Streams service to transmit data.
|
|
|
231 |
</p>
|
|
|
232 |
|
|
|
233 |
<pre><b><font face="Courier New" size=2 color=#333399>
|
|
|
234 |
E • Streams • disposed • <i><string: stream type></i> • <i><string: stream ID></i> •
|
|
|
235 |
</font></b></pre>
|
|
|
236 |
<p>
|
|
|
237 |
Sent when a stream is disposed.
|
|
|
238 |
"stream type" - source type of the stream.
|
|
|
239 |
"stream ID" - ID of the stream.
|
|
|
240 |
</p>
|
|
|
241 |
|
|
|
242 |
<h2><a name='API'>API</a></h2>
|
|
|
243 |
|
|
|
244 |
<pre>
|
|
|
245 |
<font color=#7F0055>public interface</font> IStreams extends IService {
|
|
|
246 |
|
|
|
247 |
<font color=#3F5FBF>/**
|
|
|
248 |
* Service name.
|
|
|
249 |
*/</font>
|
|
|
250 |
<font color=#7F0055>static final</font> String NAME = "Streams";
|
|
|
251 |
|
|
|
252 |
<font color=#3F5FBF>/**
|
|
|
253 |
* Clients can implement StreamsListener interface to be notified
|
|
|
254 |
* when a stream is created or disposed. The interface is registered with 'subscribe' command.
|
|
|
255 |
*
|
|
|
256 |
* When new stream is created, client must decide if it is interested in that particular stream instance.
|
|
|
257 |
* If not interested, client should send 'disconnect' command to allow remote peer to free resources and bandwidth.
|
|
|
258 |
* If not disconnected, client is required to send 'read' commands as necessary to prevent stream buffer overflow.
|
|
|
259 |
*/</font>
|
|
|
260 |
<font color=#7F0055>interface</font> StreamsListener {
|
|
|
261 |
|
|
|
262 |
<font color=#3F5FBF>/**
|
|
|
263 |
* Called when a new stream is created.
|
|
|
264 |
* <font color=#7F9FBF>@param</font> stream_type - source type of the stream.
|
|
|
265 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
266 |
* <font color=#7F9FBF>@param</font> context_id - a context ID that is associated with the stream, or null.
|
|
|
267 |
* Exact meaning of the context ID depends on stream type.
|
|
|
268 |
* Stream types and context IDs are defined by services that use Streams service to transmit data.
|
|
|
269 |
*/</font>
|
|
|
270 |
<font color=#7F0055>void</font> created(String stream_type, String stream_id, String context_id);
|
|
|
271 |
|
|
|
272 |
<font color=#3F5FBF>/**
|
|
|
273 |
* Called when a stream is disposed.
|
|
|
274 |
* <font color=#7F9FBF>@param</font> stream_type - source type of the stream.
|
|
|
275 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
276 |
*/</font>
|
|
|
277 |
<font color=#7F0055>void</font> disposed(String stream_type, String stream_id);
|
|
|
278 |
}
|
|
|
279 |
|
|
|
280 |
<font color=#3F5FBF>/**
|
|
|
281 |
* Clients must subscribe for one or more stream types to be able to send or receive stream data.
|
|
|
282 |
* Subscribers receive notifications when a stream of given type is created or disposed.
|
|
|
283 |
* Subscribers are required to respond with 'read' or 'disconnect' commands as necessary.
|
|
|
284 |
* <font color=#7F9FBF>@param</font> stream_type - the stream source type.
|
|
|
285 |
* <font color=#7F9FBF>@param</font> listener - client implementation of StreamsListener interface.
|
|
|
286 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
287 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
288 |
*/</font>
|
|
|
289 |
IToken subscribe(String stream_type, StreamsListener listener, DoneSubscribe done);
|
|
|
290 |
|
|
|
291 |
<font color=#3F5FBF>/**
|
|
|
292 |
* Call back interface for 'subscribe' command.
|
|
|
293 |
*/</font>
|
|
|
294 |
<font color=#7F0055>interface</font> DoneSubscribe {
|
|
|
295 |
<font color=#7F0055>void</font> doneSubscribe(IToken token, Exception error);
|
|
|
296 |
}
|
|
|
297 |
|
|
|
298 |
<font color=#3F5FBF>/**
|
|
|
299 |
* Unsubscribe the client from given stream source type.
|
|
|
300 |
* <font color=#7F9FBF>@param</font> stream_type - the stream source type.
|
|
|
301 |
* <font color=#7F9FBF>@param</font> listener - client implementation of StreamsListener interface.
|
|
|
302 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
303 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
304 |
*/</font>
|
|
|
305 |
IToken unsubscribe(String stream_type, StreamsListener listener, DoneUnsubscribe done);
|
|
|
306 |
|
|
|
307 |
<font color=#3F5FBF>/**
|
|
|
308 |
* Call back interface for 'unsubscribe' command.
|
|
|
309 |
*/</font>
|
|
|
310 |
<font color=#7F0055>interface</font> DoneUnsubscribe {
|
|
|
311 |
<font color=#7F0055>void</font> doneUnsubscribe(IToken token, Exception error);
|
|
|
312 |
}
|
|
|
313 |
|
|
|
314 |
<font color=#3F5FBF>/**
|
|
|
315 |
* Read data from a stream. If stream buffer is empty, the command will wait until data is available.
|
|
|
316 |
* Remote peer will continue to process other commands while 'read' command is pending.
|
|
|
317 |
* Client can send more 'read' commands without waiting for the first command to complete.
|
|
|
318 |
* Doing that improves communication channel bandwidth utilization.
|
|
|
319 |
* Pending 'read' commands will be executed in same order as issued.
|
|
|
320 |
* Client can delay sending of 'read' command if it is not ready to receive more data,
|
|
|
321 |
* however, delaying for too long can cause stream buffer overflow and lost of data.
|
|
|
322 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
323 |
* <font color=#7F9FBF>@param</font> size - max number of bytes to read.
|
|
|
324 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
325 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
326 |
*/</font>
|
|
|
327 |
IToken read(String stream_id, <font color=#7F0055>int</font> size, DoneRead done);
|
|
|
328 |
|
|
|
329 |
<font color=#3F5FBF>/**
|
|
|
330 |
* Call back interface for 'read' command.
|
|
|
331 |
*/</font>
|
|
|
332 |
<font color=#7F0055>interface</font> DoneRead {
|
|
|
333 |
<font color=#3F5FBF>/**
|
|
|
334 |
* Called when 'read' command is done.
|
|
|
335 |
* <font color=#7F9FBF>@param</font> token - command handle.
|
|
|
336 |
* <font color=#7F9FBF>@param</font> error - error object or null.
|
|
|
337 |
* <font color=#7F9FBF>@param</font> lost_size - number of bytes that were lost because of buffer overflow.
|
|
|
338 |
* 'lost_size' -1 means unknown number of bytes were lost.
|
|
|
339 |
* if both 'lost_size' and 'data.length' are non-zero then lost bytes are considered
|
|
|
340 |
* located right before read bytes.
|
|
|
341 |
* <font color=#7F9FBF>@param</font> data - bytes read from the stream.
|
|
|
342 |
* <font color=#7F9FBF>@param</font> eos - true if end of stream was reached.
|
|
|
343 |
*/</font>
|
|
|
344 |
<font color=#7F0055>void</font> doneRead(IToken token, Exception error, <font color=#7F0055>int</font> lost_size, <font color=#7F0055>byte</font>[] data, boolean eos);
|
|
|
345 |
}
|
|
|
346 |
|
|
|
347 |
<font color=#3F5FBF>/**
|
|
|
348 |
* Write data to a stream. If stream buffer is full, the command will wait until space is available.
|
|
|
349 |
* Remote peer will continue to process other commands while 'write' command is pending.
|
|
|
350 |
* Client can send more 'write' commands without waiting for the first command to complete.
|
|
|
351 |
* Doing that improves communication channel bandwidth utilization.
|
|
|
352 |
* Pending 'write' commands will be executed in same order as issued.
|
|
|
353 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
354 |
* <font color=#7F9FBF>@param</font> buf - buffer that contains stream data.
|
|
|
355 |
* <font color=#7F9FBF>@param</font> offset - byte offset in the buffer.
|
|
|
356 |
* <font color=#7F9FBF>@param</font> size - number of bytes to write.
|
|
|
357 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
358 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
359 |
*/</font>
|
|
|
360 |
IToken write(String stream_id, <font color=#7F0055>byte</font>[] buf, <font color=#7F0055>int</font> offset, <font color=#7F0055>int</font> size, DoneWrite done);
|
|
|
361 |
|
|
|
362 |
<font color=#3F5FBF>/**
|
|
|
363 |
* Call back interface for 'write' command.
|
|
|
364 |
*/</font>
|
|
|
365 |
<font color=#7F0055>interface</font> DoneWrite {
|
|
|
366 |
<font color=#3F5FBF>/**
|
|
|
367 |
* Called when 'write' command is done.
|
|
|
368 |
* <font color=#7F9FBF>@param</font> token - command handle.
|
|
|
369 |
* <font color=#7F9FBF>@param</font> error - error object or null.
|
|
|
370 |
*/</font>
|
|
|
371 |
<font color=#7F0055>void</font> doneWrite(IToken token, Exception error);
|
|
|
372 |
}
|
|
|
373 |
|
|
|
374 |
<font color=#3F5FBF>/**
|
|
|
375 |
* Send End Of Stream marker to a stream. No more writing to the stream is allowed after that.
|
|
|
376 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
377 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
378 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
379 |
*/</font>
|
|
|
380 |
IToken eos(String stream_id, DoneEOS done);
|
|
|
381 |
|
|
|
382 |
<font color=#3F5FBF>/**
|
|
|
383 |
* Call back interface for 'eos' command.
|
|
|
384 |
*/</font>
|
|
|
385 |
<font color=#7F0055>interface</font> DoneEOS {
|
|
|
386 |
<font color=#3F5FBF>/**
|
|
|
387 |
* Called when 'eos' command is done.
|
|
|
388 |
* <font color=#7F9FBF>@param</font> token - command handle.
|
|
|
389 |
* <font color=#7F9FBF>@param</font> error - error object or null.
|
|
|
390 |
*/</font>
|
|
|
391 |
<font color=#7F0055>void</font> doneEOS(IToken token, Exception error);
|
|
|
392 |
}
|
|
|
393 |
|
|
|
394 |
<font color=#3F5FBF>/**
|
|
|
395 |
* Disconnect client from a stream.
|
|
|
396 |
* <font color=#7F9FBF>@param</font> stream_id - ID of the stream.
|
|
|
397 |
* <font color=#7F9FBF>@param</font> done - command result call back object.
|
|
|
398 |
* <font color=#7F9FBF>@return</font> - pending command handle.
|
|
|
399 |
*/</font>
|
|
|
400 |
IToken disconnect(String stream_id, DoneDisconnect done);
|
|
|
401 |
|
|
|
402 |
<font color=#3F5FBF>/**
|
|
|
403 |
* Call back interface for 'disconnect' command.
|
|
|
404 |
*/</font>
|
|
|
405 |
<font color=#7F0055>interface</font> DoneDisconnect {
|
|
|
406 |
<font color=#3F5FBF>/**
|
|
|
407 |
* Called when 'disconnect' command is done.
|
|
|
408 |
* <font color=#7F9FBF>@param</font> token - command handle.
|
|
|
409 |
* <font color=#7F9FBF>@param</font> error - error object or null.
|
|
|
410 |
*/</font>
|
|
|
411 |
<font color=#7F0055>void</font> doneDisconnect(IToken token, Exception error);
|
|
|
412 |
}
|
|
|
413 |
}
|
|
|
414 |
</pre>
|
|
|
415 |
|
|
|
416 |
</body>
|
|
|
417 |
</html>
|