Consumer(TRoot) Class

ConsumerTRoot Class

Implements an Ember+ consumer that communicates with an Ember+ provider as specified in the "Ember+ Specification"^[1].

Inheritance Hierarchy

SystemObject
Lawo.EmberPlusSharp.ModelConsumerTRoot

Namespace: Lawo.EmberPlusSharp.Model
Assembly: Lawo.EmberPlusSharp (in Lawo.EmberPlusSharp.dll) Version: 1.4.1707.27006

Syntax

public sealed class Consumer<TRoot> : IMonitoredConnection, 
	IDisposable
where TRoot : Root<TRoot>

TRoot: The type of the root of the object tree that will mirror the state of the tree published by the provider.

The ConsumerTRoot type exposes the following members.

Properties

	Name	Description
	AutoSendInterval	Gets or sets the minimal amount of time, in milliseconds, the consumer will wait after automatically calling SendAsync before it will automatically call it again.
	Root	Gets the root of the object tree that mirrors the state of the tree published by the provider.

Methods

	Name	Description
	CreateAsync(S101Client)	Returns the return value of CreateAsync(client, 10000).
	CreateAsync(S101Client, Int32)	Returns the return value of CreateAsync(client, timeout, 0x00).
	CreateAsync(S101Client, Int32, ChildrenRetrievalPolicy)	Returns the return value of CreateAsync(client, timeout, childrenRetrievalPolicy, 0x00).
	CreateAsync(S101Client, Int32, Byte)	Returns the return value of CreateAsync(client, timeout, ChildrenRetrievalPolicy.All, slot).
	CreateAsync(S101Client, Int32, ChildrenRetrievalPolicy, Byte)	Asynchronously uses client to create a new ConsumerTRoot object.
	Dispose	Stops synchronizing changes to the object tree accessible through the Root property and raises the ConnectionLost event.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SendAsync	Asynchronously sends the locally applied changes and invocations to the provider.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Events

	Name	Description
	ConnectionLost	Occurs when the connection to the provider has been lost.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Bibliography

[1] Marius Keuck and Philip Boger, Ember+ Specification, L-S-B Broadcast Technologies GmbH, https://github.com/Lawo/ember-plus/raw/master/documentation/Ember%2B%20Documentation.pdf