Project

General

Profile

Htsp » History » Version 5

Andreas Smas, 2009-02-28 16:21

1 1 Andreas Smas
2
3
4
5
6
----
7
8
= Client to Server methods =
9
10 5 Andreas Smas
----
11 1 Andreas Smas
=== getChallenge ===
12
13 5 Andreas Smas
----
14 1 Andreas Smas
=== authenticate ===
15
16 5 Andreas Smas
----
17 1 Andreas Smas
=== setMode ===
18
19 5 Andreas Smas
----
20 1 Andreas Smas
=== getEvent ===
21
22 5 Andreas Smas
----
23 1 Andreas Smas
=== subscribe ===
24
25 4 Andreas Smas
Subscribe to the given channel.
26
27
Attributes
28
{{{
29
channelId        int  ID for channel. 
30 1 Andreas Smas
subscriptionId   int  Subscription ID. Selected by client. This value is not interpreted by the server in any form. 
31 5 Andreas Smas
                      The value is used from now on in all messages related to the subscription.
32 4 Andreas Smas
}}}
33
34 1 Andreas Smas
35 5 Andreas Smas
----
36 1 Andreas Smas
=== unsubscribe ===
37 5 Andreas Smas
38
Stop a subscription.
39
Attributes
40
{{{
41
subscriptionId   int  Subscription ID.
42
}}}
43
44 2 Andreas Smas
45
46
----
47
48
= Server to Client methods =
49
50
=== channelAdd ===
51
52 3 Andreas Smas
Only sent if session is in async mode.
53
54 2 Andreas Smas
=== channelUpdate ===
55
56 3 Andreas Smas
Only sent if session is in async mode.
57
58 2 Andreas Smas
=== channelDelete ===
59
60 3 Andreas Smas
Only sent if session is in async mode.
61
62 2 Andreas Smas
=== tagAdd ===
63
64 3 Andreas Smas
Only sent if session is in async mode.
65
66 2 Andreas Smas
=== tagUpdate ===
67
68 3 Andreas Smas
Only sent if session is in async mode.
69
70 2 Andreas Smas
=== tagDelete ===
71 3 Andreas Smas
72
Only sent if session is in async mode.
73 2 Andreas Smas
74
=== subscriptionStart ===
75
76
=== subscriptionStop ===
77
78
=== subscriptionStatus ===
79
80
=== queueStatus ===