IBinaryImageParser Interface

This interface represents the protocol independent representation of a streaming data parser.

Namespace: GSF.Parsing
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

public interface IBinaryImageParser : IProvideStatus

Public Interface IBinaryImageParser
	Inherits IProvideStatus

public interface class IBinaryImageParser : IProvideStatus

type IBinaryImageParser = 
    interface
        interface IProvideStatus
    end

GSF.Parsing.IBinaryImageParser = function();
GSF.Parsing.IBinaryImageParser.createInterface('GSF.Parsing.IBinaryImageParser');

The IBinaryImageParser type exposes the following members.

Properties

	Name	Description
	Enabled	Gets or sets a boolean value that indicates whether the data parser is currently enabled.
	Name	Gets the name of the object providing status information. (Inherited from IProvideStatus)
	Status	Gets the current status details about object providing status information. (Inherited from IProvideStatus)
	TotalProcessedBuffers	Gets the total number of buffer images processed so far.

Methods

	Name	Description
	Start	Start the streaming data parser.
	Stop	Stops the streaming data parser.
	Write	Writes a sequence of bytes onto the IBinaryImageParser stream for parsing.

Events

	Name	Description
	DataDiscarded	Occurs when data image fails deserialization due to an exception.
	ParsingException	Occurs when an Exception is encountered while attempting to parse data.