IKVM.Tools.Core.Diagnostics.AsyncDiagnosticChannelWriter Class Reference

Wraps a IBufferWriter<T> and queues data writen to it. Requires disposal to ensure flushing. More...

Inheritance diagram for IKVM.Tools.Core.Diagnostics.AsyncDiagnosticChannelWriter:

Public Member Functions
	AsyncDiagnosticChannelWriter (IBufferWriter< byte > writer)
	Initializes a new instance.
void	Write (IMemoryOwner< byte > owner, int length)
	Enqueues the given memory to be written. Ownership is transfered.
void	Dispose ()
	Disposes of the instance.
Public Member Functions inherited from IKVM.Tools.Core.Diagnostics.IDiagnosticChannelWriter

Detailed Description

Wraps a IBufferWriter<T> and queues data writen to it. Requires disposal to ensure flushing.

Definition at line 13 of file AsyncDiagnosticChannelWriter.cs.

Constructor & Destructor Documentation

AsyncDiagnosticChannelWriter()

IKVM.Tools.Core.Diagnostics.AsyncDiagnosticChannelWriter.AsyncDiagnosticChannelWriter

(

IBufferWriter< byte >

writer

)

Initializes a new instance.

Parameters

writer

Exceptions

ArgumentNullException

Definition at line 34 of file AsyncDiagnosticChannelWriter.cs.

        {
            _writer = writer ?? throw new ArgumentNullException(nameof(writer));
        }

Member Function Documentation

Dispose()

void IKVM.Tools.Core.Diagnostics.AsyncDiagnosticChannelWriter.Dispose

(

)

Disposes of the instance.

Definition at line 102 of file AsyncDiagnosticChannelWriter.cs.

        {
            lock (this)
            {
                // stop dequeue task
                _stop?.Cancel();
                _task?.GetAwaiter().GetResult();
                _stop = null;
                _task = null;
 
                // empty the channel to pick up any straggling items not caught by the dequeue thread
                while (_channel.Reader.TryRead(out var item))
                    item.Owner.Dispose();
 
                // complete the channel
                _channel.Writer.TryComplete();
            }
        }

Write()

void IKVM.Tools.Core.Diagnostics.AsyncDiagnosticChannelWriter.Write	(	IMemoryOwner< byte >	owner,
		int	length )

Enqueues the given memory to be written. Ownership is transfered.

Parameters

owner

Implements IKVM.Tools.Core.Diagnostics.IDiagnosticChannelWriter.

Definition at line 43 of file AsyncDiagnosticChannelWriter.cs.

        {
            if (owner is null)
                throw new ArgumentNullException(nameof(owner));
 
            if (_stop == null || _task == null)
            {
                lock (this)
                {
                    if (_stop == null || _task == null)
                    {
                        _stop = new CancellationTokenSource();
                        _task = DequeueLoop(_stop.Token);
                    }
                }
            }
 
            _channel.Writer.TryWrite((owner, length));
        }

---

The documentation for this class was generated from the following file:

• src/IKVM.Tools.Core/Diagnostics/AsyncDiagnosticChannelWriter.cs