Config Class

Defines the STTP connection related configuration parameters.

Inheritance Hierarchy

SystemObject
sttpConfig

Namespace: sttp
Assembly: sttp.net (in sttp.net.dll) Version: 1.0.0

Syntax

public class Config

Public Class Config

public ref class Config

type Config = class end

The Config type exposes the following members.

Constructors

	Name	Description
	Config	Initializes a new instance of the Config class

Properties

	Name	Description
	AutoReconnect	Gets or sets flag that determines if connections should be automatically reattempted.
	AutoRequestMetadata	Gets or sets flag that determines if metadata should be automatically requested upon successful connection.
	AutoSubscribe	Gets or sets flag that determines if subscription should be handled automatically upon successful connection.
	CompressMetadata	Gets or sets flag that determines whether the metadata transfer is compressed.
	CompressPayloadData	Gets or sets flag that determines whether payload data is compressed.
	CompressSignalIndexCache	Gets or sets flag that determines whether the signal index cache is compressed.
	MaxRetries	Gets or sets the maximum number of times to retry a connection. Set value to -1 to retry infinitely.
	MaxRetryInterval	Gets or sets the maximum retry interval, in seconds.
	MetadataFilters	Gets or sets any filters to be applied to incoming metadata to reduce total received metadata. Each filter expression should be separated by semi-colon.
	RetryInterval	Gets or sets the base retry interval, in seconds. Retries will exponentially back-off starting from this interval.
	Version	Gets or sets the target STTP protocol version. This currently defaults to 2.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)