tag_group_subscribe

Name

tag_group_subscribe -- Start subscribing to a tag group in a node.

Parameter Format

The following table shows how the command is encoded for network transmission:

TypeNameDescription
uint8id = 17The command byte that identifies this command.
VNodeIDnode_idThe ID of the node being accessed.
uint16group_idThe ID of the tag group to which a client wishes to subscribe.
uint8alias = 1If this field is zero (FALSE), aliasing is activated, and the command should be interpreted as a tag_group_unsubscribe instead. It is encoded as one (TRUE) to indicate tag_group_subscribe.

Description

This command is sent by a client that wishes to subscribe to a tag group.

If the request is granted by the host, it will add the client to the list of subscribers to the referenced tag group, and send a description of its current contents. The host will continue to send updates as the contents change, until the client unsubscribes or the tag group is destroyed. If the request to subscribe is denied, nothing happens.

It is only possible to subscribe once to a specific tag group, any further attempts to subscribe will have no effect.