blob: 4811a2b488254fcd08e70b3d48cc0477fec123cf (
plain)
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
|
/*
* ============LICENSE_START=======================================================
* dcaegen2-collectors-veshv
* ================================================================================
* Copyright (C) 2018 NOKIA
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.dcae.collectors.veshv.domain
sealed class WireFrameMessage
/**
* Wire frame structure is presented bellow. All fields are in network byte order (big-endian).
*
* ```
* ┌─────┬───────────────────────┬───────────────────────┬───────────────────────┐
* │octet│ 0 │ 1 │ 2 │
* ├─────┼──┬──┬──┬──┬──┬──┬──┬──┼──┬──┬──┬──┬──┬──┬──┬──┼──┬──┬──┬──┬──┬──┬──┬──┤
* │ bit │ 0│ │ │ │ │ │ │ │ 8│ │ │ │ │ │ │ │16│ │ │ │ │ │ │ │ ...
* ├─────┼──┴──┴──┴──┴──┴──┴──┴──┼──┴──┴──┴──┴──┴──┴──┴──┼──┴──┴──┴──┴──┴──┴──┴──┤
* │field│ 0xFF │ version │ payload content type │
* └─────┴───────────────────────┴───────────────────────┴───────────────────────┘
* ┌─────┬───────────────────────┬───────────────────────┬───────────────────────┬───────────────────────┐
* │octet│ 3 │ 4 │ 5 │ 6 │
* ├─────┼──┬──┬──┬──┬──┬──┬──┬──┼──┬──┬──┬──┬──┬──┬──┬──┼──┬──┬──┬──┬──┬──┬──┬──┼──┬──┬──┬──┬──┬──┬──┬──┤
* ... │ bit │24│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ...
* ├─────┼──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┴──┤
* │field│ payload size │
* └─────┴───────────────────────────────────────────────────────────────────────────────────────────────┘
* ┌─────┬───────────────────────
* │octet│ 7 ...
* ├─────┼──┬──┬──┬──┬──┬──┬──┬──
* ... │ bit │56│ │ │ │ │ │ │...
* ├─────┼──┴──┴──┴──┴──┴──┴──┴──
* │field│ protobuf payload
* └─────┴───────────────────────
* ```
*
* @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
* @since May 2018
*/
data class PayloadWireFrameMessage(val payload: ByteData,
val version: Short,
val payloadTypeRaw: Short,
val payloadSize: Int
) : WireFrameMessage() {
constructor(payload: ByteArray) : this(
ByteData(payload),
SUPPORTED_VERSION,
PayloadContentType.GOOGLE_PROTOCOL_BUFFER.hexValue,
payload.size)
fun isValid(): Boolean =
version == SUPPORTED_VERSION
&& PayloadContentType.isValidHexValue(payloadTypeRaw)
&& payload.size() == payloadSize
companion object {
const val MARKER_BYTE: Short = 0xFF
const val SUPPORTED_VERSION: Short = 1
const val HEADER_SIZE =
3 * java.lang.Byte.BYTES +
1 * java.lang.Integer.BYTES
const val MAX_PAYLOAD_SIZE = 1024 * 1024
}
}
/**
* This message type should be used by client to indicate that he has finished sending data to collector.
*
* Wire frame structure is presented bellow. All fields are in network byte order (big-endian).
*
* ```
* ┌─────┬───────────────────────┐
* │octet│ 0 │
* ├─────┼──┬──┬──┬──┬──┬──┬──┬──┤
* │ bit │ 0│ │ │ │ │ │ │ │
* ├─────┼──┴──┴──┴──┴──┴──┴──┴──┤
* │field│ 0xAA │
* └─────┴───────────────────────┘
* ```
*
* @since July 2018
*/
object EndOfTransmissionMessage : WireFrameMessage() {
const val MARKER_BYTE: Short = 0xAA
}
|
