Htsp » History » Version 8
Andreas Smas, 2009-02-28 16:30
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 | 7 | Andreas Smas | Request a 32 byte challenge used to generate a authentication digest. |
14 | |||
15 | Request message fields: |
||
16 | {{{ |
||
17 | None |
||
18 | }}} |
||
19 | |||
20 | Reply message fields: |
||
21 | {{{ |
||
22 | 8 | Andreas Smas | challenge bin required 32 bytes of random challenge. Should be used in next authenticate message. |
23 | 7 | Andreas Smas | }}} |
24 | |||
25 | |||
26 | 5 | Andreas Smas | ---- |
27 | 1 | Andreas Smas | === authenticate === |
28 | |||
29 | 7 | Andreas Smas | Request message fields: |
30 | {{{ |
||
31 | 8 | Andreas Smas | username str required Username. |
32 | digest bin required SHA-1 hash of [password (not including terminating NUL)] + [challenge] |
||
33 | 7 | Andreas Smas | }}} |
34 | |||
35 | Reply message fields: |
||
36 | {{{ |
||
37 | 8 | Andreas Smas | noaccess int optional Set to '1' if access was denied. |
38 | 7 | Andreas Smas | }}} |
39 | |||
40 | |||
41 | 5 | Andreas Smas | ---- |
42 | 1 | Andreas Smas | === setMode === |
43 | |||
44 | 5 | Andreas Smas | ---- |
45 | 1 | Andreas Smas | === getEvent === |
46 | 6 | Andreas Smas | |
47 | ---- |
||
48 | 1 | Andreas Smas | === subscribe === |
49 | 6 | Andreas Smas | |
50 | Request subscription to the given channel. A request for a subscription is always successful. |
||
51 | When the server is ready to transmit data it will first send a 'subscriptionStart' message. |
||
52 | 4 | Andreas Smas | |
53 | |||
54 | 1 | Andreas Smas | |
55 | Request message fields: |
||
56 | {{{ |
||
57 | 8 | Andreas Smas | channelId int required ID for channel. |
58 | subscriptionId int required Subscription ID. Selected by client. This value is not interpreted by the server in any form. |
||
59 | The value is used from now on in all messages related to the subscription. |
||
60 | 1 | Andreas Smas | }}} |
61 | 6 | Andreas Smas | |
62 | Reply message fields: |
||
63 | {{{ |
||
64 | None. |
||
65 | 4 | Andreas Smas | }}} |
66 | 6 | Andreas Smas | |
67 | 5 | Andreas Smas | |
68 | 1 | Andreas Smas | ---- |
69 | 5 | Andreas Smas | === unsubscribe === |
70 | 1 | Andreas Smas | |
71 | 5 | Andreas Smas | Stop a subscription. |
72 | Attributes |
||
73 | {{{ |
||
74 | 8 | Andreas Smas | subscriptionId int required Subscription ID. |
75 | 1 | Andreas Smas | }}} |
76 | |||
77 | 6 | Andreas Smas | Reply message fields: |
78 | {{{ |
||
79 | None. |
||
80 | }}} |
||
81 | 2 | Andreas Smas | |
82 | |||
83 | ---- |
||
84 | |||
85 | = Server to Client methods = |
||
86 | |||
87 | === channelAdd === |
||
88 | |||
89 | 3 | Andreas Smas | Only sent if session is in async mode. |
90 | |||
91 | 2 | Andreas Smas | === channelUpdate === |
92 | |||
93 | 3 | Andreas Smas | Only sent if session is in async mode. |
94 | |||
95 | 2 | Andreas Smas | === channelDelete === |
96 | |||
97 | 3 | Andreas Smas | Only sent if session is in async mode. |
98 | |||
99 | 2 | Andreas Smas | === tagAdd === |
100 | |||
101 | 3 | Andreas Smas | Only sent if session is in async mode. |
102 | |||
103 | 2 | Andreas Smas | === tagUpdate === |
104 | |||
105 | 3 | Andreas Smas | Only sent if session is in async mode. |
106 | |||
107 | 2 | Andreas Smas | === tagDelete === |
108 | 3 | Andreas Smas | |
109 | Only sent if session is in async mode. |
||
110 | 2 | Andreas Smas | |
111 | === subscriptionStart === |
||
112 | |||
113 | === subscriptionStop === |
||
114 | |||
115 | === subscriptionStatus === |
||
116 | |||
117 | === queueStatus === |