PipeLoggerServer<TPipeStream> Class

Summary

Receives MSBuild logging events over a pipe. This is the base class for AnonymousPipeLoggerServer and NamedPipeLoggerServer.
Namespace
MsBuildPipeLogger
Interfaces
Base Types
  • EventArgsDispatcher
Derived Types
graph TD Base0["EventArgsDispatcher"]-->Type Interface0["IPipeLoggerServer"]-.->Type click Interface0 "/api/MsBuildPipeLogger/IPipeLoggerServer" Interface1["IDisposable"]-.->Type Type["PipeLoggerServer<TPipeStream>"] class Type type-node Type-->Derived0["NamedPipeLoggerServer"] click Derived0 "/api/MsBuildPipeLogger/NamedPipeLoggerServer" Type-->Derived1["AnonymousPipeLoggerServer"] click Derived1 "/api/MsBuildPipeLogger/AnonymousPipeLoggerServer"

Syntax

public abstract class PipeLoggerServer<TPipeStream> : EventArgsDispatcher, IPipeLoggerServer, 
    IDisposable
    where TPipeStream : PipeStream

Type Parameters

Name Description
TPipeStream

Constructors

Name Summary
PipeLoggerServer(TPipeStream) Creates a server that receives MSBuild events over a specified pipe.
PipeLoggerServer(TPipeStream, CancellationToken) Creates a server that receives MSBuild events over a specified pipe.

Properties

Name Value Summary
CancellationToken CancellationToken
PipeStream TPipeStream

Methods

Name Value Summary
Connect() void
Dispose() void
Read() BuildEventArgs
Reads a single event from the pipe. This method blocks until an event is received, there are no more events, or the pipe is closed.
ReadAll() void
Reads all events from the pipe and blocks until there are no more events or the pipe is closed.