ILP-551 : changed Java package and moved Encoding formats from Definitions to Common
Showing
2 changed files
with
57 additions
and
0 deletions
| ... | @@ -71,6 +71,63 @@ | ... | @@ -71,6 +71,63 @@ |
| 71 | <literal name ="target" value = "1"/> | 71 | <literal name ="target" value = "1"/> |
| 72 | <literal name ="initiator" value = "2"/> | 72 | <literal name ="initiator" value = "2"/> |
| 73 | </enum> | 73 | </enum> |
| 74 | |||
| 75 | <!-- Encoding format type spec.--> | ||
| 76 | <type name="EncodingFormat" size="2"> | ||
| 77 | <comment> | ||
| 78 | The encoding format determines how element data is run-time encoded within a particular element independent of the | ||
| 79 | transport encoding. | ||
| 80 | These values are specified in the "encoding" attribute for elements. Not all encoding formats | ||
| 81 | are supported by every wireline protocol implementation. Additionally, custom encodings may be | ||
| 82 | defined to support application defined encodings. Any non-standard encodings must be registered (to avoid collision) | ||
| 83 | and approved by the appropriate approving authority (e.g. Comtech). Values from 0 to 255 are reserved | ||
| 84 | for standard-encodings. Custom encodings start at 256(0x0100) and extend to 65535 (0xFFFF).\n | ||
| 85 | \n | ||
| 86 | This is not the same as defining in XID a raw datatype or json datatype which are NOT changeable are run-time. | ||
| 87 | \n | ||
| 88 | Example: \n | ||
| 89 | \t The message XMF but a field is defined to be encoded as JSON.\n | ||
| 90 | \t Likewise, the message is JSON, but a field is run-time encoded to be XMF.\n | ||
| 91 | \n | ||
| 92 | Data encoding format type. If 0, value is not encoded. See ResrvedEncodingFormats | ||
| 93 | for a list of standard format specifiers. | ||
| 94 | </comment> | ||
| 95 | <lang name="c" type="uint16_t" include="stdint.h" /> | ||
| 96 | <lang name="cpp" type="uint16_t" include="cstdint" /> | ||
| 97 | <lang name="java" type="XidShort" include="com.comtechtel.tensor.xid.XidShort" /> | ||
| 98 | <lang name="node" type="XidUShort" /> | ||
| 99 | </type> | ||
| 100 | |||
| 101 | <!-- ReservedEncodingFormats standard encoding formats.--> | ||
| 102 | <enum name="ReservedEncodingFormats" type="Tensor.uint16" default="natural"> | ||
| 103 | <comment> | ||
| 104 | Reserved encoding formats define standard additional encodings known to all implementations. | ||
| 105 | </comment> | ||
| 106 | <literal name="natural" value="0"> | ||
| 107 | <comment> | ||
| 108 | Data is not further encoded, it is in its natural wireline format.\n | ||
| 109 | This is the default value if not defined explicitly. | ||
| 110 | </comment> | ||
| 111 | </literal> | ||
| 112 | <literal name="raw" value="1"> | ||
| 113 | <comment> | ||
| 114 | Data is in an unspecified binary format. The interpretation of the data is | ||
| 115 | falls to the producer and consumer of the information. | ||
| 116 | For textual wireline encodings like JSON, the data will be valid within the representation. | ||
| 117 | </comment> | ||
| 118 | </literal> | ||
| 119 | <literal name="xmf" value="2"> | ||
| 120 | <comment> | ||
| 121 | Data is XMF binary format. The binary data is structured using atoms and atom lists. | ||
| 122 | For textual wireline encodings like JSON, this is XMF base64 encoded. | ||
| 123 | </comment> | ||
| 124 | </literal> | ||
| 125 | <literal name="json" value="3"> | ||
| 126 | <comment> | ||
| 127 | Data is formatted as JSON compliant ascii text. For binary encodings like XMF, the content will be JSON instead. | ||
| 128 | </comment> | ||
| 129 | </literal> | ||
| 130 | </enum> | ||
| 74 | 131 | ||
| 75 | </namespace> | 132 | </namespace> |
| 76 | </specification> | 133 | </specification> | ... | ... |
This diff is collapsed.
Click to expand it.
-
Please register or sign in to post a comment