Update API section with WTP definition
[dcaegen2.git] / docs / sections / apis / ves-hv / WTP.asn
1 -- Wire Transfer Protocol (binary, defined using ASN.1 notation)
2 -- Encoding: use "direct encoding" to the number of octets indicated in the comment [n], using network byte order.
3
4 WTP DEFINITIONS ::= BEGIN
5
6 -- Used to sent data from the data provider
7 WtpData ::= SEQUENCE {
8     magic           INTEGER (0..255),           -- [1] always 0xAA
9     versionMajor    INTEGER (0..255),           -- [1] major interface version, forward incompatible with previous major version, current value: 1
10     versionMinor    INTEGER (0..255),           -- [1] minor interface version, forward compatible with previous minor version, current value: 0
11     reserved        OCTET STRING (SIZE (3)),    -- [3] reserved for future use (ignored, but use 0)
12     payloadId       INTEGER (0..65535),         -- [2] payload type: 0x0000=undefined, 0x0001=ONAP VesEvent (protobuf)
13     payloadLength   INTEGER (0..4294967295).    -- [4] payload length in octets
14     payload         OCTET STRING                -- [length as per payloadLength]
15 }
16
17 END