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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// OPCUA for Rust
// SPDX-License-Identifier: MPL-2.0
// Copyright (C) 2017-2024 Adam Lock
//! Message header for requests.
use std::{
self,
io::{Read, Write},
};
use crate::{
data_types::*,
date_time::DateTime,
diagnostic_info::DiagnosticBits,
encoding::{BinaryDecodable, BinaryEncodable, EncodingResult},
extension_object::ExtensionObject,
node_id::NodeId,
string::UAString,
Error,
};
#[allow(unused)]
mod opcua {
pub(super) use crate as types;
}
/// The `RequestHeader` contains information common to every request from a client to the server.
#[derive(Debug, Clone, PartialEq, crate::UaNullable)]
#[cfg_attr(
feature = "json",
derive(opcua_macros::JsonEncodable, opcua_macros::JsonDecodable)
)]
#[cfg_attr(
feature = "xml",
derive(crate::XmlEncodable, crate::XmlDecodable, crate::XmlType)
)]
pub struct RequestHeader {
/// The secret Session identifier used to verify that the request is associated with
/// the Session. The SessionAuthenticationToken type is defined in 7.31.
pub authentication_token: NodeId,
/// The time the Client sent the request. The parameter is only used for diagnostic and logging
/// purposes in the server.
pub timestamp: UtcTime,
/// A requestHandle associated with the request. This client defined handle can be
/// used to cancel the request. It is also returned in the response.
pub request_handle: IntegerId,
/// A bit mask that identifies the types of vendor-specific diagnostics to be returned
/// in diagnosticInfo response parameters. The value of this parameter may consist of
/// zero, one or more of the following values. No value indicates that diagnostics
/// are not to be returned.
///
/// Bit Value Diagnostics to return
/// 0x0000 0001 ServiceLevel / SymbolicId
/// 0x0000 0002 ServiceLevel / LocalizedText
/// 0x0000 0004 ServiceLevel / AdditionalInfo
/// 0x0000 0008 ServiceLevel / Inner StatusCode
/// 0x0000 0010 ServiceLevel / Inner Diagnostics
/// 0x0000 0020 OperationLevel / SymbolicId
/// 0x0000 0040 OperationLevel / LocalizedText
/// 0x0000 0080 OperationLevel / AdditionalInfo
/// 0x0000 0100 OperationLevel / Inner StatusCode
/// 0x0000 0200 OperationLevel / Inner Diagnostics
///
/// Each of these values is composed of two components, level and type, as described
/// below. If none are requested, as indicated by a 0 value, or if no diagnostic
/// information was encountered in processing of the request, then diagnostics information
/// is not returned.
///
/// Level:
/// ServiceLevel return diagnostics in the diagnosticInfo of the Service.
/// OperationLevel return diagnostics in the diagnosticInfo defined for individual
/// operations requested in the Service.
///
/// Type:
/// SymbolicId return a namespace-qualified, symbolic identifier for an error
/// or condition. The maximum length of this identifier is 32 characters.
/// LocalizedText return up to 256 bytes of localized text that describes the
/// symbolic id.
/// AdditionalInfo return a byte string that contains additional diagnostic
/// information, such as a memory image. The format of this byte string is
/// vendor-specific, and may depend on the type of error or condition encountered.
/// InnerStatusCode return the inner StatusCode associated with the operation or Service.
/// InnerDiagnostics return the inner diagnostic info associated with the operation or Service.
/// The contents of the inner diagnostic info structure are determined by other bits in the
/// mask. Note that setting this bit could cause multiple levels of nested
/// diagnostic info structures to be returned.
pub return_diagnostics: DiagnosticBits,
/// An identifier that identifies the Client’s security audit log entry associated with
/// this request. An empty string value means that this parameter is not used. The AuditEntryId
/// typically contains who initiated the action and from where it was initiated.
/// The AuditEventId is included in the AuditEvent to allow human readers to correlate an Event
/// with the initiating action. More details of the Audit mechanisms are defined in 6.2
/// and in Part 3.
pub audit_entry_id: UAString,
/// This timeout in milliseconds is used in the Client side Communication Stack to set the
/// timeout on a per-call base. For a Server this timeout is only a hint and can be
/// used to cancel long running operations to free resources. If the Server detects a
/// timeout, he can cancel the operation by sending the Service result BadTimeout.
/// The Server should wait at minimum the timeout after he received the request before
/// cancelling the operation. The Server shall check the timeoutHint parameter of a
/// PublishRequest before processing a PublishResponse. If the request timed out, a
/// BadTimeout Service result is sent and another PublishRequest is used. The
/// value of 0 indicates no timeout.
pub timeout_hint: u32,
/// Reserved for future use. Applications that do not understand the header should ignore it.
pub additional_header: ExtensionObject,
}
impl Default for RequestHeader {
fn default() -> Self {
Self {
authentication_token: NodeId::default(),
timestamp: DateTime::default(),
request_handle: 0,
return_diagnostics: DiagnosticBits::empty(),
audit_entry_id: Default::default(),
timeout_hint: 0,
additional_header: Default::default(),
}
}
}
impl BinaryEncodable for RequestHeader {
fn byte_len(&self, ctx: &opcua::types::Context<'_>) -> usize {
let mut size: usize = 0;
size += self.authentication_token.byte_len(ctx);
size += self.timestamp.byte_len(ctx);
size += self.request_handle.byte_len(ctx);
size += self.return_diagnostics.bits().byte_len(ctx);
size += self.audit_entry_id.byte_len(ctx);
size += self.timeout_hint.byte_len(ctx);
size += self.additional_header.byte_len(ctx);
size
}
fn encode<S: Write + ?Sized>(
&self,
stream: &mut S,
ctx: &crate::Context<'_>,
) -> EncodingResult<()> {
self.authentication_token.encode(stream, ctx)?;
self.timestamp.encode(stream, ctx)?;
self.request_handle.encode(stream, ctx)?;
self.return_diagnostics.bits().encode(stream, ctx)?;
self.audit_entry_id.encode(stream, ctx)?;
self.timeout_hint.encode(stream, ctx)?;
self.additional_header.encode(stream, ctx)
}
}
impl BinaryDecodable for RequestHeader {
fn decode<S: Read + ?Sized>(stream: &mut S, ctx: &crate::Context<'_>) -> EncodingResult<Self> {
let authentication_token = NodeId::decode(stream, ctx)?;
let timestamp = UtcTime::decode(stream, ctx)?;
let request_handle = IntegerId::decode(stream, ctx)?;
let (return_diagnostics, audit_entry_id, timeout_hint, additional_header) = (|| {
let return_diagnostics = DiagnosticBits::from_bits_truncate(u32::decode(stream, ctx)?);
let audit_entry_id = UAString::decode(stream, ctx)?;
let timeout_hint = u32::decode(stream, ctx)?;
let additional_header = ExtensionObject::decode(stream, ctx)?;
Ok((
return_diagnostics,
audit_entry_id,
timeout_hint,
additional_header,
))
})()
.map_err(|e: Error| e.with_request_handle(request_handle))?;
Ok(RequestHeader {
authentication_token,
timestamp,
request_handle,
return_diagnostics,
audit_entry_id,
timeout_hint,
additional_header,
})
}
}
impl RequestHeader {
/// Create a new request header.
pub fn new(
authentication_token: &NodeId,
timestamp: &DateTime,
request_handle: IntegerId,
) -> RequestHeader {
RequestHeader {
authentication_token: authentication_token.clone(),
timestamp: *timestamp,
request_handle,
return_diagnostics: DiagnosticBits::empty(),
audit_entry_id: UAString::null(),
timeout_hint: 0,
additional_header: ExtensionObject::null(),
}
}
/// Create a new dummy request header.
pub fn dummy() -> RequestHeader {
RequestHeader::new(&NodeId::null(), &DateTime::now(), 1)
}
}