Class NodeMCUWS2812USBUpdateQueue

Represents a generic UpdateQueue<TIdentifier, TData> using an object as the key and a color as the value.

Inheritance
object
AbstractReferenceCounting
UpdateQueue<object, Color>
UpdateQueue
NodeMCUWS2812USBUpdateQueue
Implements
Inherited Members
Namespace: RGB.NET.Devices.WS281X.NodeMCU
Assembly: RGB.NET.Devices.WS281X.dll
Syntax
public sealed class NodeMCUWS2812USBUpdateQueue : UpdateQueue, IUpdateQueue, IUpdateQueue<object, Color>, IReferenceCounting, IDisposable

Constructors

| Edit this page View Source

NodeMCUWS2812USBUpdateQueue(IDeviceUpdateTrigger, string)

Initializes a new instance of the NodeMCUWS2812USBUpdateQueue class. If this constructor is used UDP updates are disabled.

Declaration
public NodeMCUWS2812USBUpdateQueue(IDeviceUpdateTrigger updateTrigger, string hostname)
Parameters
Type Name Description
IDeviceUpdateTrigger updateTrigger

The update trigger used by this queue.
string hostname

The hostname to connect to.
| Edit this page View Source

NodeMCUWS2812USBUpdateQueue(IDeviceUpdateTrigger, string, int)

Initializes a new instance of the NodeMCUWS2812USBUpdateQueue class. If this constructor is used UDP updates are enabled.

Declaration
public NodeMCUWS2812USBUpdateQueue(IDeviceUpdateTrigger updateTrigger, string hostname, int udpPort)
Parameters
Type Name Description
IDeviceUpdateTrigger updateTrigger

The update trigger used by this queue.
string hostname

The hostname to connect to.
int udpPort

The port used by the UDP-connection.

Methods

| Edit this page View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public override void Dispose()
Overrides
| Edit this page View Source

OnStartup(object?, CustomUpdateData)

Event handler for the Starting-event.

Declaration
protected override void OnStartup(object? sender, CustomUpdateData customData)
Parameters
Type Name Description
object sender

The starting IUpdateTrigger.
CustomUpdateData customData

CustomUpdateData provided by the trigger.
Overrides
| Edit this page View Source

Update(in ReadOnlySpan<(object key, Color color)>)

Performs the update this queue is responsible for.

Declaration
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
Parameters
Type Name Description
ReadOnlySpan<(object key, Color color)> dataSet

The set of data that needs to be updated.
Returns
Type Description
bool
Overrides

Implements