read []
Request value data from a property. The entire value may be requested, or a subset of the value (as bytes). To request the entire value, use "0" for "start" and "-1" for "length".
start (optional)
Byte offset of desired subset (inclusive). The first byte is 0.
length (optional)
Number of bytes to return, starting at "start" field. A value of "-1" means "until the end".
update []
Notification of new property data to overwrite old data, beginning with a given byte offset. Also includes data type (in case this is the first update). Also may indicate any error that has occured.
error (optional)
The presence of this field indicates that an error occured in acting on the message referred to by the "in-reply-to" field. In this condition, no other field will be present; usually they all are. The value of this field describes the error.
data (optional)
The (new) property data.
start (optional)
The byte offset of the "data" field, within the whole property value. This field is used when only a subset of the property is being communicated (e.g. only some of the value has changed).
datatype (optional)
A data type identifier. The syntax is described in "typechain.txt". The datatype indicates the format or type of the property data.
write []
Use this message to overwrite property data, starting with a given byte offset.
start (optional)
Byte offset of the new data. The old data will be overwritten beginning with this offset (possibly increasing the length of the data).
data (optional)
The new data.
replace []
Replace whole value of property data (possibly increasing or decreasing the length of the data), and set new datatype.
data (optional)
New data.
datatype (optional)
New data type indentifier. The syntax of this identifier is described in "typechain.txt".
replace-update []
Notification that property data should be entirely replaced by new data with a new datatype.
data (optional)
New data.
datatype (optional)
New datatype. The syntax of the data type identifier is described in "typechain.txt".
get-length []
Request number of bytes in property's value.
length-update []
Notification of number of bytes in property's value. May also indicate an error.
error (optional)
The presence of this field (and it may be the only one) indicates that an error occured in acting on the message referred to by the "in-reply-to" field. The value of this field describes the error.
len (optional)
Number of bytes in property's value.
start-listening []
Start listening to this object: If the "listen" field contains the
value "property", a "property:update" or "property:replace-update" message is sent immediatly after the property changes.
listen (optional)
Must be "property" to recieve property updates.
stop-listening []
Stop listening to this object: If the "listen" field contains the value "property", updates will no longer be sent.
listen (optional)
Must be "property" to stop property updates.