Struct NotificationMessage

pub struct NotificationMessage {
    pub sequence_number: Counter,
    pub publish_time: UtcTime,
    pub notification_data: Option<Vec<ExtensionObject>>,
}

https://reference.opcfoundation.org/v105/Core/docs/Part4/7.26

Fields

sequence_number: Counter

publish_time: UtcTime

notification_data: Option<Vec<ExtensionObject>>

Implementations

impl NotificationMessage

pub fn data_change( sequence_number: u32, publish_time: DateTime, data_change_notifications: Vec<MonitoredItemNotification>, event_notifications: Vec<EventFieldList>, ) -> NotificationMessage

Create a notification message which contains data change AND / OR events. Calling this with neither will panic. Notification data can have up to 2 elements to covers the case in table 158 where a subscription contains monitored items for events and data.

pub fn status_change( sequence_number: u32, publish_time: DateTime, status: StatusCode, ) -> NotificationMessage

Create a status change notification message

pub fn keep_alive( sequence_number: u32, publish_time: DateTime, ) -> NotificationMessage

Create a keep-alive notification message

pub fn into_notifications( self, ) -> Option<(Vec<DataChangeNotification>, Vec<EventNotificationList>)>

Extract notifications from the message. Unrecognized / unparseable notifications will be ignored. If there are no notifications, the function will return None.

Trait Implementations

impl BinaryDecodable for NotificationMessage

fn decode<S: Read + ?Sized>( stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<Self>

Decodes an instance from the read stream. The decoding options contains restrictions set by the server / client on the length of strings, arrays etc. If these limits are exceeded the implementation should return with a BadDecodingError as soon as possible.

impl BinaryEncodable for NotificationMessage

fn byte_len(&self, ctx: &Context<'_>) -> usize

Returns the exact byte length of the structure as it would be if encode were called. This may be called prior to writing to ensure the correct amount of space is available.

fn encode<S: Write + ?Sized>( &self, stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<()>

Encodes the instance to the write stream.

fn encode_to_vec(&self, ctx: &Context<'_>) -> Vec<u8>

Convenience method for encoding a message straight into an array of bytes. It is preferable to reuse buffers than to call this so it should be reserved for tests and trivial code.

impl Clone for NotificationMessage

fn clone(&self) -> NotificationMessage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NotificationMessage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NotificationMessage

fn default() -> NotificationMessage

Returns the “default value” for a type.

impl JsonDecodable for NotificationMessage

fn decode( stream: &mut JsonStreamReader<&mut dyn Read>, ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode Self from a JSON stream.

impl JsonEncodable for NotificationMessage

fn encode( &self, stream: &mut JsonStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Write the type to the provided JSON writer.

impl MessageInfo for NotificationMessage

fn type_id(&self) -> ObjectId

The binary type id associated with the message

fn json_type_id(&self) -> ObjectId

The JSON type id associated with the message.

fn xml_type_id(&self) -> ObjectId

The XML type id associated with the message.

fn data_type_id(&self) -> DataTypeId

The data type id associated with the message.

impl PartialEq for NotificationMessage

fn eq(&self, other: &NotificationMessage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UaNullable for NotificationMessage

fn is_ua_null(&self) -> bool

Return true if this value is null, meaning it can be left out when being encoded in JSON and XML encodings.

impl XmlDecodable for NotificationMessage

fn decode( stream: &mut XmlStreamReader<&mut dyn Read>, ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode a value from an XML stream.

impl XmlEncodable for NotificationMessage

fn encode( &self, stream: &mut XmlStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Encode a value to an XML stream.

impl XmlType for NotificationMessage

const TAG: &'static str = "NotificationMessage"

The static fallback tag for this type. Convenience feature, but also used in nested types.

fn tag(&self) -> &str

The XML tag name for this type.

impl StructuralPartialEq for NotificationMessage