EasySparkplugHostApplication Class Members

Connectivity Software User's Guide and Reference

EasySparkplugHostApplication Class Members

Fields Properties Methods Events Collapse All

OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.System Namespace : EasySparkplugHostApplication Class

The following tables list the members exposed by EasySparkplugHostApplication.

Public Fields

	Name	Description
	DefaultAutoStartStop	The default value of the AutoStartStop property. This is a constant, and its value is `True`.
	DefaultIsAnnounced	The default value of the IsAnnounced property. This is a constant, and its value is `True`.
	DefaultRebirthRequestTimeout	The default value of the RebirthRequestTimeout property. This is a constant, and its value is `60000`.
	DefaultRequestRebirthOnDataWithoutBirth	The default value of the RequestRebirthOnDataWithoutBirth property. This is a constant, and its value is `True`.

Public Properties

	Name	Description
	AutoStartStop	Determines whether the Sparkplug host application automatically starts and stops as needed for the consumer operations.
	EffectiveClientId	The effective client ID used for the communication with the broker.
	HostId	Sparkplug host ID of the Sparkplug host application.
	IsAnnounced	Determines whether this Sparkplug host application announces itself in the Sparkplug system.
	IsStarted	Determines whether the component is currently started.
	RebirthRequestTimeout	Determines how long the Sparkplug host application waits after issuing a rebirth request before a new automatic rebirth request can be issued. In milliseconds.
	RequestRebirthOnDataWithoutBirth	Determines whether the application requests a rebirth when it receives data without a birth message first.
	SystemConnectionParameters	The parameters used by the Sparkplug host application to connect to the Sparkplug system.
	SystemDescriptor	The effective descriptor of the Sparkplug system that this component is part of.

Public Methods

	Name	Description
	Equals	Overloaded. Overridden. Determines whether the specified EasySparkplugHostApplication is equal to the current object.
	GetHashCode	Overridden.
	GetService
	GetType	Gets the System.Type of the current instance. (Inherited from object)
	PublishPayload	Publishes the specified payload to the Sparkplug system.
	Start	Starts the Sparkplug host application, connecting it to the Sparkplug system.
	Stop	Stops the Sparkplug host application, disconnecting it from the Sparkplug system.
	ToHostDescriptor	Creates a Sparkplug host descriptor for this Sparkplug host application.
	ToString	Overridden.

Protected Methods

	Name	Description
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
	MemberwiseClone	Creates a shallow copy of the current System.Object. (Inherited from object)

Extension Methods

	Name	Description
	SetState<TNode>	Sets the arbitrary object associated with the node.

Public Events

	Name	Description
	Starting	Raised when the component is starting.
	Stopped	Raised when the component has stopped.

Public Operators

Equality	Determines whether the two objects are equal.
Implicit Type Conversion	Converts this Sparkplug host application to a Sparkplug host descriptor.
Inequality	Determines whether the two objects are not equal.

See Also

Reference

EasySparkplugHostApplication Class
OpcLabs.EasySparkplug.System Namespace

Copyright © 2004-2025 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

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.