Project

General

Profile

Htsp » History » Revision 6

Revision 5 (Andreas Smas, 2009-02-28 16:21) → Revision 6/163 (Andreas Smas, 2009-02-28 16:25)



----

= Client to Server methods =

----
=== getChallenge ===

----
=== authenticate ===

----
=== setMode ===

----
=== getEvent ===

----
=== subscribe ===

Request subscription Subscribe to the given channel. A request for a subscription is always successful.

Attributes

When the server is ready to transmit data it will first send a 'subscriptionStart' message.

Request message fields:
{{{
channelId int ID for channel.
subscriptionId int Subscription ID. Selected by client. This value is not interpreted by the server in any form.
The value is used from now on in all messages related to the subscription.
}}}

Reply message fields:
{{{
None.
}}}


----
=== unsubscribe ===

Stop a subscription.
Attributes
{{{
subscriptionId int Subscription ID.
}}}

Reply message fields:
{{{
None.
}}}



----

= Server to Client methods =

=== channelAdd ===

Only sent if session is in async mode.

=== channelUpdate ===

Only sent if session is in async mode.

=== channelDelete ===

Only sent if session is in async mode.

=== tagAdd ===

Only sent if session is in async mode.

=== tagUpdate ===

Only sent if session is in async mode.

=== tagDelete ===

Only sent if session is in async mode.

=== subscriptionStart ===

=== subscriptionStop ===

=== subscriptionStatus ===

=== queueStatus ===