Common.xid.xml
6.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Copyright (c) 2017, TeleCommunication Systems, Inc.,
a wholly-owned subsidiary of Comtech Telecommunications Corp.
and/or affiliates of TeleCommunication Systems, Inc.
All rights reserved.
TeleCommunication Systems, Inc. PROPRIETARY/CONFIDENTIAL.
Use is subject to license terms included in the distribution.
-->
<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
identity="Common.xid.xml">
<title>Tensor Common Definitions</title>
<comment></comment>
<artifact></artifact>
<import ref="https://xid.location.studio/Tensor/V1.1/Definitions.xid.xml" local="Definitions.xid.xml" />
<namespace name="Tensor">
<struct name="NameValue" >
<comment>A string base name value pair entry.</comment>
<elem name="name" type="Tensor.string" ord="64"/>
<elem name="value" type="Tensor.string" ord="65"/>
</struct>
<enum name="ResultCode" type="Tensor.int8" default="undefined">
<comment>General processing result codes.</comment>
<literal name="success" value="1"/>
<literal name="undefined" value="0"/>
<literal name="failure" value="-1" />
<literal name="busy" value="-2" />
<literal name="processingError" value="-3"/>
<literal name="parsingError" value="-4"/>
<literal name="malformedRequest" value="-5"/>
<literal name="encodingError" value="-6"/>
</enum>
<struct name="VoidType">
<comment>Reserved type used in various translations to preserve translation. It has no purpose but as a placeholder. This is different from type "void" in Definitions.xid</comment>
<elem name="reserved" type="Tensor.uint16" multiplicity="1" ord="64"/>
</struct>
<enum name="WirelineFormat" type="Tensor.uint8" default="undefined">
<comment>Enum defines the wireline data format of XID interactions. These are defined to facilitate standard definitions within XID interactions independent of the
specific transport protocol or XID conduit.</comment>
<literal name ="undefined" value = "0"/>
<literal name ="raw" value = "1"/>
<literal name ="base64" value = "2"/>
<literal name ="hex" value = "3"/>
</enum>
<enum name="ContentType" type="Tensor.uint8" default="undefined">
<comment>Enum defines the content type of XID interactions. These are defined to facilitate standard definitions within XID interactions independent of the
specific transport protocol or XID conduit.</comment>
<literal name ="undefined" value = "0"/>
<literal name ="dataobject" value = "1"/>
<literal name ="xmf" value = "2"/>
<literal name ="json" value = "3"/>
</enum>
<enum name="InteractionRole" type="Tensor.uint8" default="undefined">
<comment>InteractionRole defines the role of the conduit in a XID interaction.
A Conduit port must adopt either the target or initiator role to preserve
interaction continuity and conventions.</comment>
<literal name ="undefined" value = "0"/>
<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>