Class SubscribeInitMessage

Namespace

DuetAPI.Connection.InitMessages

Assembly

DuetAPI.dll

Enter subscription mode and receive either the full object model or parts of it after every update

public class SubscribeInitMessage : ClientInitMessage

Inheritance

object

InitMessage

ClientInitMessage

SubscribeInitMessage

Inherited Members

ClientInitMessage.Mode

ClientInitMessage.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SubscribeInitMessage()

Creates a new init message instance

public SubscribeInitMessage()

Properties

Channel

Optional code channel to receive messages from or null if only generic messages are supposed to be received

public CodeChannel? Channel { get; set; }

Property Value

CodeChannel?

Filters

Optional list of filter paths for Patch mode

public List<string> Filters { get; set; }

Property Value

List<string>

Remarks

The style of a filter is similar to XPath. For example, if you want to monitor only the current heater temperatures, you can use the filter expression "heat/heaters[*]/current". Wildcards are supported either for full names or indices. To get updates for an entire namespace, the ** wildcard can be used (for example heat/** for everything heat-related), however it can be only used at the end of a filter expression

SubscriptionMode

Type of the subscription

public SubscriptionMode SubscriptionMode { get; set; }

Property Value

SubscriptionMode