Represents an endpoint that text can be written to. More...

Inheritance diagram for VolumeControl.Log.Interfaces.IEndpointWriter:

Collaboration diagram for VolumeControl.Log.Interfaces.IEndpointWriter:

Public Member Functions
TextWriter	GetTextWriter ()
	Gets a TextWriter object for writing to this endpoint. More...

void	Write (string @string)
	Writes the specified string to the endpoint. More...

void	WriteLine (string @string)
	Writes the specified string to the endpoint, followed by a line break. More...

void	Reset ()
	Clears the endpoint's contents, leaving it blank. More...

Properties
bool	IsWritingEnabled `[get, set]`
	Gets or sets whether this endpoint can be written to. More...

Events
EventHandler< bool >?	EnabledChanging
	Occurs when the endpoint is about to be enabled or disabled for any reason. More...

EventHandler< bool >?	EnabledChanged
	Occurs when the endpoint is enabled or disabled for any reason. More...

Detailed Description

Represents an endpoint that text can be written to.

Member Function Documentation

◆ GetTextWriter()

TextWriter VolumeControl.Log.Interfaces.IEndpointWriter.GetTextWriter ( )

Gets a TextWriter object for writing to this endpoint.

The caller is responsible for disposing of the stream.

Returns: A TextWriter instance for this endpoint when it is enabled; otherwise null.

Implemented in VolumeControl.Log.Endpoints.PersistentFileEndpoint, VolumeControl.Log.Endpoints.MemoryEndpoint, VolumeControl.Log.Endpoints.FileEndpoint, VolumeControl.Log.Endpoints.ConsoleEndpoint, and VolumeControl.Log.Endpoints.BaseEndpointWriter.

◆ Reset()

void VolumeControl.Log.Interfaces.IEndpointWriter.Reset ( )

Clears the endpoint's contents, leaving it blank.

Implemented in VolumeControl.Log.Endpoints.PersistentFileEndpoint, VolumeControl.Log.Endpoints.MemoryEndpoint, VolumeControl.Log.Endpoints.FileEndpoint, VolumeControl.Log.Endpoints.ConsoleEndpoint, and VolumeControl.Log.Endpoints.BaseEndpointWriter.

◆ Write()

void VolumeControl.Log.Interfaces.IEndpointWriter.Write ( string @ string )

Writes the specified string to the endpoint.

Parameters

string A string to write to the endpoint.

Implemented in VolumeControl.Log.Endpoints.BaseEndpointWriter.

◆ WriteLine()

void VolumeControl.Log.Interfaces.IEndpointWriter.WriteLine ( string @ string )

Writes the specified string to the endpoint, followed by a line break.

Parameters

string A string to write to the endpoint.

Implemented in VolumeControl.Log.Endpoints.BaseEndpointWriter.

Property Documentation

◆ IsWritingEnabled

bool VolumeControl.Log.Interfaces.IEndpointWriter.IsWritingEnabled

getset

Gets or sets whether this endpoint can be written to.

Event Documentation

◆ EnabledChanged

EventHandler<bool>? VolumeControl.Log.Interfaces.IEndpointWriter.EnabledChanged

Occurs when the endpoint is enabled or disabled for any reason.

The boolean argument is the new state.

◆ EnabledChanging

EventHandler<bool>? VolumeControl.Log.Interfaces.IEndpointWriter.EnabledChanging

Occurs when the endpoint is about to be enabled or disabled for any reason.

The boolean argument is the incoming state.

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

/home/runner/work/volume-control/volume-control/VolumeControl.Log/Interfaces/IEndpointWriter.cs

Public Member Functions

Properties

Events