|
roo_transceivers
API Documentation for roo_transceivers
|
Functions | |
| roo_transceivers_ServerMessage | SrvInit () |
| Builds an init server message. | |
| roo_transceivers_ServerMessage | SrvFullUpdateBegin () |
| Begins a full update sequence. | |
| roo_transceivers_ServerMessage | SrvDeltaUpdateBegin () |
| Begins a delta update sequence. | |
| roo_transceivers_ServerMessage | SrvUpdateEnd () |
| Ends an update sequence. | |
| roo_transceivers_ServerMessage | SrvDescriptorAdded (int key, const roo_transceivers_Descriptor &descriptor) |
| Adds a descriptor in the server stream. | |
| roo_transceivers_ServerMessage | SrvDescriptorRemoved (int key) |
| Removes a descriptor from the server stream. | |
| roo_transceivers_ServerMessage | SrvDeviceAdded (const DeviceLocator &locator, int descriptor_key) |
| Adds a device with a descriptor key. | |
| roo_transceivers_ServerMessage | SrvDevicesPreserved (int first_preserved_ordinal, size_t count) |
| Marks a range of devices as preserved. | |
| roo_transceivers_ServerMessage | SrvDevicesModified (int prev_ordinal, int descriptor_key) |
| Marks a device as modified. | |
| roo_transceivers_ServerMessage | SrvDeviceRemoved (int prev_ordinal) |
| Removes a device. | |
| roo_transceivers_ServerMessage | SrvReadingsBegin () |
| Begins a readings block. | |
| roo_transceivers_ServerMessage | SrvReadingsEnd () |
| Ends a readings block. | |
| roo_transceivers_ServerMessage | SrvReading (const DeviceLocator &device) |
| Begins readings for a device. | |
| void | AddReading (roo_transceivers_ServerMessage &reading, const SensorId &sensor_id, float value, uint64_t age_ms) |
| Appends a single sensor reading to a readings message. | |
| roo_transceivers_ClientMessage | ClientRequestUpdate () |
| Builds a client update request. | |
| roo_transceivers_ClientMessage | ClientRequestState () |
| Builds a client state request. | |
| roo_transceivers_ClientMessage | ClientWrite (const ActuatorLocator &actuator, float value) |
| Builds a client write request. | |
| void roo_transceivers::proto::AddReading | ( | roo_transceivers_ServerMessage & | reading, |
| const SensorId & | sensor_id, | ||
| float | value, | ||
| uint64_t | age_ms | ||
| ) |
Appends a single sensor reading to a readings message.
Definition at line 120 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage::reading, and _roo_transceivers_ServerMessage_Reading::sensor_values.
| roo_transceivers_ClientMessage roo_transceivers::proto::ClientRequestState | ( | ) |
Builds a client state request.
Definition at line 139 of file proto.cpp.
References roo_transceivers_ClientMessage_init_zero, roo_transceivers_ClientMessage_request_state_tag, and _roo_transceivers_ClientMessage::which_contents.
Referenced by roo_transceivers::UniverseClient::begin(), and roo_transceivers::UniverseClient::UniverseClient().
| roo_transceivers_ClientMessage roo_transceivers::proto::ClientRequestUpdate | ( | ) |
Builds a client update request.
Definition at line 133 of file proto.cpp.
References roo_transceivers_ClientMessage_init_zero, roo_transceivers_ClientMessage_request_update_tag, and _roo_transceivers_ClientMessage::which_contents.
Referenced by roo_transceivers::UniverseClient::requestUpdate().
| roo_transceivers_ClientMessage roo_transceivers::proto::ClientWrite | ( | const ActuatorLocator & | actuator, |
| float | value | ||
| ) |
Builds a client write request.
Definition at line 145 of file proto.cpp.
References roo_transceivers::ActuatorLocator::actuator_id(), _roo_transceivers_ClientMessage::contents, roo_transceivers::ActuatorLocator::device_id(), roo_transceivers_ClientMessage_init_zero, roo_transceivers_ClientMessage_write_tag, roo_transceivers::ActuatorLocator::schema(), _roo_transceivers_ClientMessage::which_contents, and _roo_transceivers_ClientMessage::write.
Referenced by roo_transceivers::UniverseClient::write().
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDeltaUpdateBegin | ( | ) |
Begins a delta update sequence.
Definition at line 22 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage_UpdateBegin::delta, roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_transceiver_update_begin_tag, _roo_transceivers_ServerMessage::transceiver_update_begin, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDescriptorAdded | ( | int | key, |
| const roo_transceivers_Descriptor & | descriptor | ||
| ) |
Adds a descriptor in the server stream.
Definition at line 37 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage_DescriptorAdded::descriptor, _roo_transceivers_ServerMessage::descriptor_added, _roo_transceivers_ServerMessage_DescriptorAdded::has_descriptor, _roo_transceivers_ServerMessage_DescriptorAdded::key, roo_transceivers_ServerMessage_descriptor_added_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDescriptorRemoved | ( | int | key | ) |
Removes a descriptor from the server stream.
Definition at line 47 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage::descriptor_removed, _roo_transceivers_ServerMessage_DescriptorRemoved::key, roo_transceivers_ServerMessage_descriptor_removed_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDeviceAdded | ( | const DeviceLocator & | locator, |
| int | descriptor_key | ||
| ) |
Adds a device with a descriptor key.
Definition at line 54 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage_DeviceAdded::descriptor_key, _roo_transceivers_ServerMessage::device_added, roo_transceivers::DeviceLocator::device_id(), roo_transceivers_ServerMessage_device_added_tag, roo_transceivers_ServerMessage_init_zero, roo_transceivers::DeviceLocator::schema(), and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDeviceRemoved | ( | int | prev_ordinal | ) |
Removes a device.
Definition at line 89 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage::device_removed, _roo_transceivers_ServerMessage_DeviceRemoved::prev_index, roo_transceivers_ServerMessage_device_removed_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDevicesModified | ( | int | prev_ordinal, |
| int | descriptor_key | ||
| ) |
Marks a device as modified.
Definition at line 79 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage::device_modified, _roo_transceivers_ServerMessage_DeviceModified::prev_index, roo_transceivers_ServerMessage_device_modified_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvDevicesPreserved | ( | int | first_preserved_ordinal, |
| size_t | count | ||
| ) |
Marks a range of devices as preserved.
Definition at line 66 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage::device_preserved, _roo_transceivers_ServerMessage_DevicePreserved::prev_index, roo_transceivers_ServerMessage_device_preserved_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvFullUpdateBegin | ( | ) |
Begins a full update sequence.
Definition at line 14 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, _roo_transceivers_ServerMessage_UpdateBegin::delta, roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_transceiver_update_begin_tag, _roo_transceivers_ServerMessage::transceiver_update_begin, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvInit | ( | ) |
Builds an init server message.
Definition at line 8 of file proto.cpp.
References roo_transceivers_ServerMessage_init_tag, roo_transceivers_ServerMessage_init_zero, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvReading | ( | const DeviceLocator & | device | ) |
Begins readings for a device.
Definition at line 109 of file proto.cpp.
References _roo_transceivers_ServerMessage::contents, roo_transceivers::DeviceLocator::device_id(), _roo_transceivers_ServerMessage::reading, roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_reading_tag, roo_transceivers::DeviceLocator::schema(), and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvReadingsBegin | ( | ) |
Begins a readings block.
Definition at line 97 of file proto.cpp.
References roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_readings_begin_tag, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvReadingsEnd | ( | ) |
Ends a readings block.
Definition at line 103 of file proto.cpp.
References roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_readings_end_tag, and _roo_transceivers_ServerMessage::which_contents.
| roo_transceivers_ServerMessage roo_transceivers::proto::SrvUpdateEnd | ( | ) |
Ends an update sequence.
Definition at line 30 of file proto.cpp.
References roo_transceivers_ServerMessage_init_zero, roo_transceivers_ServerMessage_transceiver_update_end_tag, and _roo_transceivers_ServerMessage::which_contents.