UAPubSubCaptureTypes Enumeration

The types of captures (and their groupings) that are emitted by the OPC UA PubSub sniffer.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ComVisibleAttribute(False)>
<DisplayName2Attribute("OPC-UA PubSub Capture Types")>
<FlagsAttribute()>
Public Enum UAPubSubCaptureTypes 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

'Usage
 
Dim instance As UAPubSubCaptureTypes

[ComVisible(false)]
[DisplayName2("OPC-UA PubSub Capture Types")]
[Flags()]
public enum UAPubSubCaptureTypes : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

[ComVisible(false)]
[DisplayName2("OPC-UA PubSub Capture Types")]
[Flags()]
public enum class UAPubSubCaptureTypes : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Member	Value	Description
All	2097151	A grouping of capture types. Contains all message types (non-terminal and terminal). Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `2097151`.
AllDataSetMessages	124	A grouping of capture types. Contains all dataset messages (parsed and unparsed). Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This grouping contains: UnparsedDataSet, DataSetKeyFrame, DataSetDeltaFrame, DataSetEvent, DataSetKeepAlive. The value of this enum member is `124`.
AllDiscoveryAnnouncements	1865728	A grouping of capture types. Contains all (parsed and unparsed) discovery announcement messages. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `1865728`.
AllDiscoveryMessages	2097024	A grouping of capture types. Contains all discovery messages (probes and announcements). Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This grouping contains: AllDiscoveryProbes, AllDiscoveryAnnouncements. The value of this enum member is `2097024`.
AllDiscoveryProbes	231296	A grouping of capture types. Contains all (parsed and unparsed) discovery probe messages. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `231296`.
AllPubSubMessages	2097148	A grouping of capture types. Contains all OPC UA PubSub (terminal) messages. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This grouping is an opposite of NetworkTraffic. It is useful when you are not interested in the physical characteristics of the messages, but only in their logical meaning with regard to OPC UA PubSub. This grouping contains: AllDataSetMessages, AllDiscoveryMessages. The value of this enum member is `2097148`.
AnnouncementApplicationDescription	524288	A terminal message. Represents an application description announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.01 (Mantis 5038). The value of this enum member is `524288`.
AnnouncementDataSetMetaData	8192	A terminal message. Represents a (parsed) dataset metadata announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `8192`.
AnnouncementDataSetWriter	16384	A terminal message. Represents a (parsed) dataset writer configuration message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `16384`.
AnnouncementPubSubConnection	262144	A terminal message. Represents a (parsed) PubSub connection configuration announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.01 (Mantis 5038). The value of this enum member is `262144`.
AnnouncementServerEndpoints	4096	A terminal message. Represents a (parsed) publisher endpoints announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `4096`.
AnnouncementStatus	1048576	A terminal message. Represents a status announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.03. The value of this enum member is `1048576`.
DataSetDeltaFrame	16	A terminal message. Represents a dataset delta frame. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `16`.
DataSetEvent	32	A terminal message. Represents a dataset message carrying an event. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `32`.
DataSetKeepAlive	64	A terminal message. Represents a dataset keep-alive message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `64`.
DataSetKeyFrame	8	A terminal message. Represents a dataset key frame. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `8`.
NetworkMessage	2	A non-terminal message. Represents a data or discovery message defined by OPC UA PubSub. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. If the transport message cannot be parsed as an OPC UA PubSub message, the TransportMessage is the only capture emitted for the message. Otherwise, there is a NetworkMessage capture emitted following the TransportMessage, containing the network message header information specific to OPC UA PubSub. In special cases (such as with non-standard OPC UA PubSub extensions), there can even be more NetworkMessage captures for one TransportMessage. The value of this enum member is `2`.
NetworkTraffic	3	A grouping of capture types. Contains all network traffic messages. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This grouping is an opposite of AllPubSubMessages. It is useful when you are interested in the basic physical characteristics of the messages, such as which network traffic is actually present, whether it is actually an OPC UA PubSub traffic, and eventually "who is publishing (or discovering)". This grouping contains: TransportMessage, NetworkMessage. The value of this enum member is `3`.
None	0	No message. Used to indicate a successful connection by the transport mechanism. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `0`.
ProbeFindApplications	131072	A terminal message. Represents a (parsed) find applications probe message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.01 (Mantis 5038). The value of this enum member is `131072`.
ProbePublisherDataSetMetaData	512	A terminal message. Represents a publisher information probe for dataset metadata. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `512`.
ProbePublisherDataSetWriter	1024	A terminal message. Represents a publisher information probe for dataset writer configuration. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `1024`.
ProbePublisherPubSubConnections	65536	A terminal message. Represents a publisher information probe for PubSub connections configuration. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.01 (Mantis 5038). The value of this enum member is `65536`.
ProbePublisherServerEndpoints	256	A terminal message. Represents a publisher information probe for publisher server endpoints. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `256`.
ProbePublisherWriterGroup	32768	A terminal message. Represents a publisher information probe for writer group configuration. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. This message is new in OPC UA 1.05.01 (Mantis 5038). The value of this enum member is `32768`.
TransportMessage	1	A non-terminal message. Represents a full original message, as received by the transport mechanism. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. If the transport message cannot be parsed as an OPC UA PubSub message, the TransportMessage is the only capture emitted for the message. Otherwise, there is a NetworkMessage capture emitted following the TransportMessage, containing the network message header information specific to OPC UA PubSub. In special cases (such as with non-standard OPC UA PubSub extensions), there can even be more NetworkMessage captures for one TransportMessage. The value of this enum member is `1`.
UnparsedDataSet	4	A terminal message. Represents an unparsed dataset message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `4`.
UnparsedDiscoveryAnnouncement	2048	A terminal message. Represents an unparsed discovery announcement message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `2048`.
UnparsedDiscoveryProbe	128	A terminal message. Represents an unparsed discovery probe message. Remarks: See Capture types in OPC UA PubSub Sniffing concepts. The value of this enum member is `128`.

Remarks

See Capture types in OPC UA PubSub Sniffing concepts.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         OpcLabs.EasyOpc.UA.PubSub.Services.UAPubSubCaptureTypes

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

OpcLabs.EasyOpc.UA.PubSub.Services Namespace

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.