Difference between revisions of "OpenIGTLink/ProtocolV2/Query"
| (3 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
=='''GET_''' prefix: Query a single message== | =='''GET_''' prefix: Query a single message== | ||
| − | "GET_<datatype>" query message is used to request for a single message with type <datatype>. The receiver of "GET_<datatype>" message must return a message with type <datatype> and the same name as the query message. If data is not available, a returned message must be null body (data size = 0). A format of "GET_<datatype>" may be defined per data type, if necessary. | + | "GET_<datatype>" query message is used to request for a single message with type <datatype>. The receiver of "GET_<datatype>" message must return a message with type <datatype> and the same name as the query message. A "GET_<datatype>" message without device name requests any available data. If data is not available, a returned message must be null body (data size = 0). A format of "GET_<datatype>" may be defined per data type, if necessary. |
=='''STT_''' and '''STP_''' prefixes: Control data flow== | =='''STT_''' and '''STP_''' prefixes: Control data flow== | ||
| − | + | "STT_<datatype>" and "STP_<datatype>" query message is used to request to start and stop sending a series of messages. The receiver of "STT_<datatype>" message must return "RTS_<datatype>" message with the same name as the query message to notify that the receiver receives the query. Formats of "STT_<datatype>", "STP_<datatype>" and "RTS_<datatype>" may be defined per data type, if necessary. | |
| − | |||
| − | |||
| − | |||
=Examples= | =Examples= | ||
Latest revision as of 05:14, 30 November 2010
Home < OpenIGTLink < ProtocolV2 < QueryContents
Simple Querying Mechanism in OpenIGTLink Protocol version 2
In OpenIGTLink version 2, special prefixes GET_, STT_, STP_, and RTS_ are used in the message type field in the header for messages to query and control data flow. Those messages with those special prefix should be defined along with primary message types (for example, STT_TDATA, STP_TDATA and RTS_TDATA should be defined with TDATA).
GET_ prefix: Query a single message
"GET_<datatype>" query message is used to request for a single message with type <datatype>. The receiver of "GET_<datatype>" message must return a message with type <datatype> and the same name as the query message. A "GET_<datatype>" message without device name requests any available data. If data is not available, a returned message must be null body (data size = 0). A format of "GET_<datatype>" may be defined per data type, if necessary.
STT_ and STP_ prefixes: Control data flow
"STT_<datatype>" and "STP_<datatype>" query message is used to request to start and stop sending a series of messages. The receiver of "STT_<datatype>" message must return "RTS_<datatype>" message with the same name as the query message to notify that the receiver receives the query. Formats of "STT_<datatype>", "STP_<datatype>" and "RTS_<datatype>" may be defined per data type, if necessary.
