Htsp » History » Version 6
Andreas Smas, 2009-02-28 16:25
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 | 6 | Andreas Smas | Request subscription to the given channel. A request for a subscription is always successful. |
26 | When the server is ready to transmit data it will first send a 'subscriptionStart' message. |
||
27 | 1 | Andreas Smas | |
28 | 6 | Andreas Smas | |
29 | |||
30 | Request message fields: |
||
31 | 4 | Andreas Smas | {{{ |
32 | channelId int ID for channel. |
||
33 | 1 | Andreas Smas | subscriptionId int Subscription ID. Selected by client. This value is not interpreted by the server in any form. |
34 | 5 | Andreas Smas | The value is used from now on in all messages related to the subscription. |
35 | 1 | Andreas Smas | }}} |
36 | |||
37 | 6 | Andreas Smas | Reply message fields: |
38 | {{{ |
||
39 | None. |
||
40 | }}} |
||
41 | 4 | Andreas Smas | |
42 | 6 | Andreas Smas | |
43 | 5 | Andreas Smas | ---- |
44 | 1 | Andreas Smas | === unsubscribe === |
45 | 5 | Andreas Smas | |
46 | Stop a subscription. |
||
47 | Attributes |
||
48 | {{{ |
||
49 | subscriptionId int Subscription ID. |
||
50 | 1 | Andreas Smas | }}} |
51 | |||
52 | 6 | Andreas Smas | Reply message fields: |
53 | {{{ |
||
54 | None. |
||
55 | }}} |
||
56 | 2 | Andreas Smas | |
57 | |||
58 | ---- |
||
59 | |||
60 | = Server to Client methods = |
||
61 | |||
62 | === channelAdd === |
||
63 | |||
64 | 3 | Andreas Smas | Only sent if session is in async mode. |
65 | |||
66 | 2 | Andreas Smas | === channelUpdate === |
67 | |||
68 | 3 | Andreas Smas | Only sent if session is in async mode. |
69 | |||
70 | 2 | Andreas Smas | === channelDelete === |
71 | |||
72 | 3 | Andreas Smas | Only sent if session is in async mode. |
73 | |||
74 | 2 | Andreas Smas | === tagAdd === |
75 | |||
76 | 3 | Andreas Smas | Only sent if session is in async mode. |
77 | |||
78 | 2 | Andreas Smas | === tagUpdate === |
79 | |||
80 | 3 | Andreas Smas | Only sent if session is in async mode. |
81 | |||
82 | 2 | Andreas Smas | === tagDelete === |
83 | 3 | Andreas Smas | |
84 | Only sent if session is in async mode. |
||
85 | 2 | Andreas Smas | |
86 | === subscriptionStart === |
||
87 | |||
88 | === subscriptionStop === |
||
89 | |||
90 | === subscriptionStatus === |
||
91 | |||
92 | === queueStatus === |