Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
4642bea9 by Skip Hines
Options

ILP-551 : changed Java package and moved Encoding formats from Definitions to Common

1 parent dbec40ca
Inline Side-by-side
Showing 2 changed files with 88 additions and 94 deletions
Tensor/V1.1/Common.xid.xml
......@@ -71,6 +71,63 @@
<literal name ="target" value = "1"/>
<literal name ="initiator" value = "2"/>
</enum>
<!-- Encoding format type spec.-->
<type name="EncodingFormat" size="2">
<comment>
The encoding format determines how element data is run-time encoded within a particular element independent of the
transport encoding.
These values are specified in the "encoding" attribute for elements. Not all encoding formats
are supported by every wireline protocol implementation. Additionally, custom encodings may be
defined to support application defined encodings. Any non-standard encodings must be registered (to avoid collision)
and approved by the appropriate approving authority (e.g. Comtech). Values from 0 to 255 are reserved
for standard-encodings. Custom encodings start at 256(0x0100) and extend to 65535 (0xFFFF).\n
\n
This is not the same as defining in XID a raw datatype or json datatype which are NOT changeable are run-time.
\n
Example: \n
\t The message XMF but a field is defined to be encoded as JSON.\n
\t Likewise, the message is JSON, but a field is run-time encoded to be XMF.\n
\n
Data encoding format type. If 0, value is not encoded. See ResrvedEncodingFormats
for a list of standard format specifiers.
</comment>
<lang name="c" type="uint16_t" include="stdint.h" />
<lang name="cpp" type="uint16_t" include="cstdint" />
<lang name="java" type="XidShort" include="com.comtechtel.tensor.xid.XidShort" />
<lang name="node" type="XidUShort" />
</type>
<!-- ReservedEncodingFormats standard encoding formats.-->
<enum name="ReservedEncodingFormats" type="Tensor.uint16" default="natural">
<comment>
Reserved encoding formats define standard additional encodings known to all implementations.
</comment>
<literal name="natural" value="0">
<comment>
Data is not further encoded, it is in its natural wireline format.\n
This is the default value if not defined explicitly.
</comment>
</literal>
<literal name="raw" value="1">
<comment>
Data is in an unspecified binary format. The interpretation of the data is
falls to the producer and consumer of the information.
For textual wireline encodings like JSON, the data will be valid within the representation.
</comment>
</literal>
<literal name="xmf" value="2">
<comment>
Data is XMF binary format. The binary data is structured using atoms and atom lists.
For textual wireline encodings like JSON, this is XMF base64 encoded.
</comment>
</literal>
<literal name="json" value="3">
<comment>
Data is formatted as JSON compliant ascii text. For binary encodings like XMF, the content will be JSON instead.
</comment>
</literal>
</enum>
</namespace>
</specification>
......
Tensor/V1.1/Definitions.xid.xml
......@@ -19,7 +19,7 @@
Defines fundamental type mappings.
</comment>
<tag name="package" value="com.comtechtel"/>
<tag name="package" value="com.telecomsys"/>
<namespace name="Tensor">
<type name="void" size="0">
......@@ -33,7 +33,7 @@
<comment>represents true/false</comment>
<lang name="c" type="bool" include="stdbool.h"/>
<lang name="cpp" type="bool"/>
<lang name="java" type="XidBool" include="com.comtechtel.tensor.xid.XidBool">
<lang name="java" type="XidBool" include="com.telecomsys.tensor.xid.XidBool">
<tag name="native" value="boolean"/>
</lang>
<lang name="node" type="XidBool"/>
......@@ -43,7 +43,7 @@
<comment>8-bit, unsigned value</comment>
<lang name="c" type="uint8_t" include="stdint.h"/>
<lang name="cpp" type="uint8_t" include="cstdint"/>
<lang name="java" type="XidByte" include="com.comtechtel.tensor.xid.XidByte">
<lang name="java" type="XidByte" include="com.telecomsys.tensor.xid.XidByte">
<tag name="native" value="byte"/>
</lang>
<lang name="node" type="XidUInt8"/>
......@@ -52,7 +52,7 @@
<comment>16-bit, unsigned value</comment>
<lang name="c" type="uint16_t" include="stdint.h"/>
<lang name="cpp" type="uint16_t" include="cstdint"/>
<lang name="java" type="XidShort" include="com.comtechtel.tensor.xid.XidShort">
<lang name="java" type="XidShort" include="com.telecomsys.tensor.xid.XidShort">
<tag name="native" value="short"/>
</lang>
<lang name="node" type="XidUShort"/>
......@@ -61,14 +61,14 @@
<comment>24-bit, unsigned value</comment>
<lang name="c" type="uint24_t" include="Tensor/CXMF/int24.h"/>
<lang name="cpp" type="uint24_t" include="Tensor/Types/int24.h"/>
<lang name="java" type="XidInt24" include="com.comtechtel.tensor.xid.XidInt24"/>
<lang name="java" type="XidInt24" include="com.telecomsys.tensor.xid.XidInt24"/>
<lang name="node" type="XidUInt24"/>
</type>
<type name="uint32" size="4">
<comment>32-bit, unsigned value</comment>
<lang name="c" type="uint32_t" include="stdint.h"/>
<lang name="cpp" type="uint32_t" include="cstdint"/>
<lang name="java" type="XidInt" include="com.comtechtel.tensor.xid.XidInt">
<lang name="java" type="XidInt" include="com.telecomsys.tensor.xid.XidInt">
<tag name="native" value="int"/>
</lang>
<lang name="node" type="XidUInt"/>
......@@ -77,7 +77,7 @@
<comment>64-bit, unsigned value</comment>
<lang name="c" type="uint64_t" include="stdint.h"/>
<lang name="cpp" type="uint64_t" include="cstdint"/>
<lang name="java" type="XidLong" include="com.comtechtel.tensor.xid.XidLong">
<lang name="java" type="XidLong" include="com.telecomsys.tensor.xid.XidLong">
<tag name="native" value="long"/>
</lang>
<lang name="node" type="XidULong"/>
......@@ -87,7 +87,7 @@
<comment>8-bit, signed value</comment>
<lang name="c" type="int8_t" include="stdint.h"/>
<lang name="cpp" type="int8_t" include="cstdint"/>
<lang name="java" type="XidByte" include="com.comtechtel.tensor.xid.XidByte">
<lang name="java" type="XidByte" include="com.telecomsys.tensor.xid.XidByte">
<tag name="native" value="byte"/>
</lang>
<lang name="node" type="XidInt8"/>
......@@ -96,7 +96,7 @@
<comment>16-bit, signed value</comment>
<lang name="c" type="int16_t" include="stdint.h"/>
<lang name="cpp" type="int16_t" include="cstdint"/>
<lang name="java" type="XidShort" include="com.comtechtel.tensor.xid.XidShort">
<lang name="java" type="XidShort" include="com.telecomsys.tensor.xid.XidShort">
<tag name="native" value="short"/>
</lang>
<lang name="node" type="XidShort"/>
......@@ -105,14 +105,14 @@
<comment>24-bit, unsigned value</comment>
<lang name="c" type="int24_t" include="Tensor/CXMF/int24.h"/>
<lang name="cpp" type="int24_t" include="Tensor/Types/int24.h"/>
<lang name="java" type="XidInt24" include="com.comtechtel.tensor.xid.XidInt24"/>
<lang name="java" type="XidInt24" include="com.telecomsys.tensor.xid.XidInt24"/>
<lang name="node" type="XidInt24"/>
</type>
<type name="int32" size="4">
<comment>32-bit, signed value</comment>
<lang name="c" type="int32_t" include="stdint.h"/>
<lang name="cpp" type="int32_t" include="cstdint"/>
<lang name="java" type="XidInt" include="com.comtechtel.tensor.xid.XidInt">
<lang name="java" type="XidInt" include="com.telecomsys.tensor.xid.XidInt">
<tag name="native" value="int"/>
</lang>
<lang name="node" type="XidInt"/>
......@@ -121,7 +121,7 @@
<comment>64-bit, signed value</comment>
<lang name="c" type="int64_t" include="stdint.h"/>
<lang name="cpp" type="int64_t" include="cstdint"/>
<lang name="java" type="XidLong" include="com.comtechtel.tensor.xid.XidLong">
<lang name="java" type="XidLong" include="com.telecomsys.tensor.xid.XidLong">
<tag name="native" value="long"/>
</lang>
<lang name="node" type="XidLong"/>
......@@ -140,7 +140,7 @@
<artifact>https://wikipedia.org/wiki/Single-precision_floating-point_format</artifact>
<lang name="c" type="float"/>
<lang name="cpp" type="float"/>
<lang name="java" type="XidFloat" include="com.comtechtel.tensor.xid.XidFloat">
<lang name="java" type="XidFloat" include="com.telecomsys.tensor.xid.XidFloat">
<tag name="native" value="float"/>
</lang>
<lang name="node" type="XidFloat"/>
......@@ -150,7 +150,7 @@
<artifact>https://wikipedia.org/wiki/Double-precision_floating-point_format</artifact>
<lang name="c" type="double"/>
<lang name="cpp" type="double"/>
<lang name="java" type="XidDouble" include="com.comtechtel.tensor.xid.XidDouble">
<lang name="java" type="XidDouble" include="com.telecomsys.tensor.xid.XidDouble">
<tag name="native" value="double"/>
</lang>
<lang name="node" type="XidDouble"/>
......@@ -167,7 +167,7 @@
<comment>A single byte</comment>
<lang name="c" type="uint8_t" include="stdint.h"/>
<lang name="cpp" type="uint8_t" include="cstdint"/>
<lang name="java" type="XidByte" include="com.comtechtel.tensor.xid.XidByte">
<lang name="java" type="XidByte" include="com.telecomsys.tensor.xid.XidByte">
<tag name="native" value="byte"/>
</lang>
<lang name="node" type="XidUInt8"/>
......@@ -177,7 +177,7 @@
<!-- may change this type -->
<lang name="c" type="CXMFString" include="Tensor/CXMF/CXMFString.h"/>
<lang name="cpp" type="::Tensor::XMF::Atom" include="Tensor/XMF/Atom.h"/>
<lang name="java" type="XidRaw" include="com.comtechtel.tensor.xid.XidRaw"/>
<lang name="java" type="XidRaw" include="com.telecomsys.tensor.xid.XidRaw"/>
<lang name="node" type="Atom"/>
</type>
......@@ -185,7 +185,7 @@
<comment>Variable sized collection of characters</comment>
<lang name="c" type="CXMFString" include="Tensor/CXMF/CXMFString.h"/>
<lang name="cpp" type="std::string" include="string"/>
<lang name="java" type="XidString" include="com.comtechtel.tensor.xid.XidString">
<lang name="java" type="XidString" include="com.telecomsys.tensor.xid.XidString">
<tag name="native" value="String"/>
</lang>
<lang name="node" type="XidString"/>
......@@ -201,7 +201,7 @@
<artifact>https://xkcd.com/1179</artifact>
<lang name="c" type="uint64_t" include="stdint.h"/>
<lang name="cpp" type="::Tensor::Types::DateTime" include="Tensor/Types/DateTime.h"/>
<lang name="java" type="XidDateTime" include="com.comtechtel.tensor.xid.XidDateTime"/>
<lang name="java" type="XidDateTime" include="com.telecomsys.tensor.xid.XidDateTime"/>
<lang name="node" type="XidDateTime"/>
</type>
......@@ -210,7 +210,7 @@
<artifact>https://wikipedia.org/wiki/Universally_unique_identifier</artifact>
<lang name="c" type="UUID" include="Tensor/CXMF/uuid.h"/>
<lang name="cpp" type="::Tensor::Types::UUID" include="Tensor/Types/uuid.h"/>
<lang name="java" type="XidUuid" include="com.comtechtel.tensor.xid.XidUuid"/>
<lang name="java" type="XidUuid" include="com.telecomsys.tensor.xid.XidUuid"/>
<lang name="node" type="XidUuid"/>
</type>
......@@ -219,7 +219,7 @@
<tag name="TODO" value="Define uri as a custom type. Use string for now."/>
<lang name="c" type="CXMFString" include="Tensor/CXMF/CXMFString.h"/>
<lang name="cpp" type="std::string" include="string"/>
<lang name="java" type="XidString" include="com.comtechtel.tensor.xid.XidString"/>
<lang name="java" type="XidString" include="com.telecomsys.tensor.xid.XidString"/>
<lang name="node" type="XidString"/>
</type>
......@@ -227,7 +227,7 @@
<comment>JSON formatted/encoded string</comment>
<lang name="c" type="CXMFString" include="Tensor/CXMF/CXMFString.h"/>
<lang name="cpp" type="::Tensor::JSON::JSONObj" include="Tensor/JSON/TensorJSON.h"/>
<lang name="java" type="XidJSON" include="com.comtechtel.tensor.xid.XidJSON"/>
<lang name="java" type="XidJSON" include="com.telecomsys.tensor.xid.XidJSON"/>
<lang name="node" type="XidString"/>
</type>
......@@ -235,7 +235,7 @@
<comment>XMF formatted/encoded data, this is straight XMF in XMF formatted data, and base64 encoded binary XMF in JSON formatted data. </comment>
<lang name="c" type="CAtom" include="Tensor/CXMF/CXMF.h"/>
<lang name="cpp" type="::Tensor::XMF::Atom" include="Tensor/XMF/Atom.h"/>
<lang name="java" type="Atom" include="com.comtechtel.tensor.xmf.Atom"/>
<lang name="java" type="Atom" include="com.telecomsys.tensor.xmf.Atom"/>
<lang name="node" type="Atom"/>
</type>
......@@ -244,72 +244,9 @@
<comment>6 byte IEEE MAC-48</comment>
<lang name="c" type="MacAddress48" include="Tensor/CXMF/MacAddress48.h"/>
<lang name="cpp" type="::Tensor::Types::MacAddress48" include="Tensor/Types/MacAddress48.h"/>
<lang name="java" type="XidMacAddress48" include="com.comtechtel.tensor.xid.XidMacAddress48"/>
<lang name="java" type="XidMacAddress48" include="com.telecomsys.tensor.xid.XidMacAddress48"/>
<lang name="node" type="XidMacAddress48"/>
</type>
<!--
*******************************************************
Encoding Data Types
*******************************************************
-->
<!-- Encoding format type spec.-->
<type name="EncodingFormat" size="2">
<comment>
The encoding format determines how element data is run-time encoded within a particular element independent of the
transport encoding.
These values are specified in the "encoding" attribute for elements. Not all encoding formats
are supported by every wireline protocol implementation. Additionally, custom encodings may be
defined to support application defined encodings. Any non-standard encodings must be registered (to avoid collision)
and approved by the appropriate approving authority (e.g. Comtech). Values from 0 to 255 are reserved
for standard-encodings. Custom encodings start at 256(0x0100) and extend to 65535 (0xFFFF).\n
\n
This is not the same as defining in XID a raw datatype or json datatype which are NOT changeable are run-time.
\n
Example: \n
\t The message XMF but a field is defined to be encoded as JSON.\n
\t Likewise, the message is JSON, but a field is run-time encoded to be XMF.\n
\n
Data encoding format type. If 0, value is not encoded. See ResrvedEncodingFormats
for a list of standard format specifiers.
</comment>
<lang name="c" type="uint16_t" include="stdint.h" />
<lang name="cpp" type="uint16_t" include="cstdint" />
<lang name="java" type="XidShort" include="com.comtechtel.tensor.xid.XidShort" />
<lang name="node" type="XidUShort" />
</type>
<!-- ReservedEncodingFormats standard encoding formats.-->
<enum name="ReservedEncodingFormats" type="Tensor.uint16" default="natural">
<comment>
Reserved encoding formats define standard additional encodings known to all implementations.
</comment>
<literal name="natural" value="0">
<comment>
Data is not further encoded, it is in its natural wireline format.\n
This is the default value if not defined explicitly.
</comment>
</literal>
<literal name="raw" value="1">
<comment>
Data is in an unspecified binary format. The interpretation of the data is
falls to the producer and consumer of the information.
For textual wireline encodings like JSON, the data will be valid within the representation.
</comment>
</literal>
<literal name="xmf" value="2">
<comment>
Data is XMF binary format. The binary data is structured using atoms and atom lists.
For textual wireline encodings like JSON, this is XMF base64 encoded.
</comment>
</literal>
<literal name="json" value="3">
<comment>
Data is formatted as JSON compliant ascii text. For binary encodings like XMF, the content will be JSON instead.
</comment>
</literal>
</enum>
</namespace>
<namespace name="XIDCG">
......@@ -331,56 +268,56 @@
<comment>Atom type XIDCG uses </comment>
<lang name="c" type="CAtom" include="Tensor/CXMF/CXMF.h"/>
<lang name="cpp" type="::Tensor::XMF::Atom" include="Tensor/XMF/Atom.h"/>
<lang name="java" type="Atom" include="com.comtechtel.tensor.xmf.Atom"/>
<lang name="java" type="Atom" include="com.telecomsys.tensor.xmf.Atom"/>
<lang name="node" type="Atom"/>
</type>
<type name="AtomListIF">
<comment>AtomList type XIDCG uses </comment>
<lang name="c" type="CAtomListBase" include="Tensor/CXMF/CXMF.h"/>
<!-- <lang name="cpp" type="::Tensor::XMF::AtomList" include="Tensor/XMF/AtomList.h"/> -->
<lang name="java" type="AtomListIF" include="com.comtechtel.tensor.xmf.AtomListIF"/>
<lang name="java" type="AtomListIF" include="com.telecomsys.tensor.xmf.AtomListIF"/>
<!-- <lang name="node" type="AtomList"/> -->
</type>
<type name="AtomList">
<comment>AtomList type XIDCG uses </comment>
<lang name="c" type="CAtomList" include="Tensor/CXMF/CXMF.h"/>
<lang name="cpp" type="::Tensor::XMF::AtomList" include="Tensor/XMF/AtomList.h"/>
<lang name="java" type="AtomList" include="com.comtechtel.tensor.xmf.AtomList"/>
<lang name="java" type="AtomList" include="com.telecomsys.tensor.xmf.AtomList"/>
<lang name="node" type="AtomList"/>
</type>
<type name="PackedAtomList">
<comment>PackedAtomList type XIDCG uses </comment>
<lang name="c" type="CPackedAtomList" include="Tensor/CXMF/CXMF.h"/>
<lang name="cpp" type="::Tensor::XMF::PackedAtomList" include="Tensor/XMF/PackedAtomList.h"/>
<lang name="java" type="PackedAtomList" include="com.comtechtel.tensor.xmf.PackedAtomList"/>
<lang name="java" type="PackedAtomList" include="com.telecomsys.tensor.xmf.PackedAtomList"/>
<lang name="node" type="PackedAtomList"/>
</type>
<type name="AtomListIterator">
<comment>AtomList type XIDCG uses </comment>
<lang name="c" type="CAtomListIterator" include="Tensor/CXMF/CXMF.h"/>
<lang name="cpp" type="::Tensor::XMF::AtomListIterator" include="Tensor/XMF/AtomList.h"/>
<lang name="java" type="AtomListIterator" include="com.comtechtel.tensor.xmf.AtomListIterator"/>
<lang name="java" type="AtomListIterator" include="com.telecomsys.tensor.xmf.AtomListIterator"/>
<lang name="node" type="AtomListIterator"/>
</type>
<type name="JSONObject">
<comment>JSONObject type XIDCG uses </comment>
<!-- <lang name="c" type="" include=""/> -->
<lang name="cpp" type="::Tensor::JSON::JSONObj" include="Tensor/JSON/TensorJSON.h"/>
<lang name="java" type="JSONObject" include="com.comtechtel.tensor.json.JSONObject"/>
<lang name="java" type="JSONObject" include="com.telecomsys.tensor.json.JSONObject"/>
<!-- <lang name="node" type=""/> -->
</type>
<type name="JSONArray">
<comment>JSONArray type XIDCG uses </comment>
<!-- <lang name="c" type="" include=""/> -->
<!-- <lang name="cpp" type="::Tensor::JSON::JSONObj" include="Tensor/JSON/TensorJSON.h"/> -->
<lang name="java" type="JSONArray" include="com.comtechtel.tensor.json.JSONArray"/>
<lang name="java" type="JSONArray" include="com.telecomsys.tensor.json.JSONArray"/>
<!-- <lang name="node" type=""/> -->
</type>
<type name="JSONException">
<comment>JSONException type XIDCG uses </comment>
<!-- <lang name="c" type="" include=""/> -->
<!-- <lang name="cpp" type="::Tensor::JSON::JSONObj" include="Tensor/JSON/TensorJSON.h"/> -->
<lang name="java" type="JSONException" include="com.comtechtel.tensor.json.JSONException"/>
<lang name="java" type="JSONException" include="com.telecomsys.tensor.json.JSONException"/>
<!-- <lang name="node" type=""/> -->
</type>
</namespace>
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!