report_domain

report_domain — registers points and requests information on a whole domain.

Synopsis

(report_domain domain flags)
    

Arguments

domain

The desired domain.

flags

Any bitwise-or combination of:

DH_REG_ALL 0x01 Register all points on this domain.
DH_REG_FUTURE 0x02 Register any new points created on this domain subsequent to this call.
DH_REG_QUALIFY 0x04 Tell the DataHub instance to emit all point names with the domain prepended, as in domain:point_name.
DH_REG_ONCEONLY 0x08 Tell the DataHub instance to send each point value exactly once.
DH_REG_MODEL 0x10 Tell the DataHub instance to send the data model as well as the point values.
DH_REG_SYNC 0x20 Reserved.
DH_REG_UNREG 0x40 Unregister all registered points in this domain. All other flags are ignored if this is specified. Setting this flag has the same effect as sending the unreport_domain command.
DH_REG_METAINFO 0x80 Available in DataHub version 10 only. Request metadata (engineering units, range, description) for registered points.

Returns

One or more messages, depending on the flag(s) chosen. Each message contains the complete definition of the point.

Description

This command lets TCP client connections decide on a per-domain basis whether to informed of the data model for the domain, and whether to get future updates, fully-qualified domain names, or new points.