Click or drag to resize

BinaryImageParserBase Class

This class defines the fundamental functionality for parsing any stream of binary data.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    System.IOStream
      GSF.ParsingBinaryImageParserBase
        GSF.ParsingFrameImageParserBaseTTypeIdentifier, TOutputType

Namespace: GSF.Parsing
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax
public abstract class BinaryImageParserBase : Stream, 
	IBinaryImageParser, IProvideStatus
View Source

The BinaryImageParserBase type exposes the following members.

Constructors
 NameDescription
Protected methodBinaryImageParserBase Creates a new instance of the BinaryImageParserBase class.
Top
Properties
 NameDescription
Public propertyCanRead Gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead)
Public propertyCanSeek Gets a value indicating whether the current stream supports seeking.
(Overrides StreamCanSeek)
Public propertyCanTimeoutGets a value that determines whether the current stream can time out.
(Inherited from Stream)
Public propertyCanWrite Gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite)
Public propertyEnabled Gets or sets a boolean value that indicates whether the data parser is currently enabled.
Public propertyLength The parser is designed as a write only stream, so this method is not implemented.
(Overrides StreamLength)
Public propertyName Gets the name of BinaryImageParserBase.
Public propertyPosition The parser is designed as a write only stream, so this method is not implemented.
(Overrides StreamPosition)
Public propertyProtocolSyncBytes Gets or sets synchronization bytes for this parsing implementation, if used.
Public propertyProtocolUsesSyncBytes Gets flag that determines if this protocol parsing implementation uses synchronization bytes.
Public propertyReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream)
Public propertyRunTime Gets the total amount of time, in seconds, that the BinaryImageParserBase has been active.
Public propertyStatus Gets current status of BinaryImageParserBase.
Public propertyTotalProcessedBuffers Gets the total number of buffer images processed so far.
Public propertyWriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream)
Top
Methods
 NameDescription
Public methodBeginReadBegins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodBeginWriteBegins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodCloseCloses the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.
(Inherited from Stream)
Public methodCopyTo(Stream)Reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public methodCopyTo(Stream, Int32)Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream)
Public methodCopyToAsync(Stream)Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public methodCopyToAsync(Stream, Int32)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream)
Public methodCopyToAsync(Stream, Int32, CancellationToken)Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
(Inherited from Stream)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Protected methodCreateWaitHandleObsolete.
Allocates a WaitHandle object.
(Inherited from Stream)
Public methodDisposeReleases all resources used by the Stream.
(Inherited from Stream)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Inherited from Stream)
Public methodEndReadWaits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodEndWriteEnds an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFlush When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Overrides StreamFlush)
Public methodFlushAsyncAsynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream)
Public methodFlushAsync(CancellationToken)Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
(Inherited from Stream)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected methodObjectInvariantObsolete.
Provides support for a Contract.
(Inherited from Stream)
Protected methodOnBufferParsed Raises the BufferParsed event.
Protected methodOnDataDiscarded Raises the DataDiscarded event.
Protected methodOnParsingException Raises the ParsingException event.
Public methodParse Parses the object implementing the ISupportBinaryImage interface.
Protected methodParseFrame Protocol specific frame parsing algorithm.
Public methodRead The parser is designed as a write only stream, so this method is not implemented.
(Overrides StreamRead(Byte, Int32, Int32))
Public methodReadAsync(Byte, Int32, Int32)Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from Stream)
Public methodReadAsync(Byte, Int32, Int32, CancellationToken)Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from Stream)
Public methodReadByteReads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from Stream)
Public methodSeek The parser is designed as a write only stream, so this method is not implemented.
(Overrides StreamSeek(Int64, SeekOrigin))
Public methodSetLength The parser is designed as a write only stream, so this method is not implemented.
(Overrides StreamSetLength(Int64))
Public methodStart Start the streaming data parser.
Public methodStop Stops the streaming data parser.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWrite Writes a sequence of bytes onto the stream for parsing.
(Overrides StreamWrite(Byte, Int32, Int32))
Public methodWriteAsync(Byte, Int32, Int32)Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from Stream)
Public methodWriteAsync(Byte, Int32, Int32, CancellationToken)Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
(Inherited from Stream)
Public methodWriteByteWrites a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream)
Top
Events
 NameDescription
Public eventBufferParsed Occurs when buffer parsing has completed.
Public eventDataDiscarded Occurs when data image fails deserialized due to an exception.
Public eventParsingException Occurs when an Exception is encountered while attempting to parse data.
Top
Fields
 NameDescription
Public fieldStatic memberDefaultProtocolSyncBytes Specifies the default value for the ProtocolSyncBytes property.
Protected fieldStreamInitialized Tracks if data stream has been initialized.
Protected fieldUnparsedBuffer Remaining unparsed buffer from last parsing execution, if any.
Top
Extension Methods
 NameDescription
Public Extension MethodCompress Compress a stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension MethodCompress Compress a stream onto given output stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension MethodCopyStream Copies input Stream onto output Stream.
(Defined by StreamExtensions)
Public Extension MethodCopyTo Writes the contents of a stream to the provided stream.
(Defined by StreamExtensions)
Public Extension MethodDecompress Decompress a stream.
(Defined by CompressionExtensions)
Public Extension MethodDecompress Decompress a stream onto given output stream.
(Defined by CompressionExtensions)
Public Extension MethodDecrypt Returns a stream of decrypted data for the given parameters.
(Defined by Cipher)
Public Extension MethodDecrypt Decrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension MethodDeserializeToDataSet Deserializes a DataSet from a Stream.
(Defined by DataSetExtensions)
Public Extension MethodEncrypt Returns a stream of encrypted data for the given parameters.
(Defined by Cipher)
Public Extension MethodEncrypt Encrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodRead7BitUInt32 Reads the 7-bit encoded value from the stream.
(Defined by StreamExtensions)
Public Extension MethodReadAll Reads all of the provided bytes. Will not return prematurely, but continue to execute a Read(Byte, Int32, Int32) command until the entire length has been read.
(Defined by StreamExtensions)
Public Extension MethodReadBoolean Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension MethodReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension MethodReadChar Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadDateTime Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadDecimal Reads a decimal from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension MethodReadDouble Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadGuid Reads a Guid from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension MethodReadInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadInt32Collection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodReadInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadNextByte Read a byte from the stream. Will throw an exception if the end of the stream has been reached.
(Defined by StreamExtensions)
Public Extension MethodReadNullableString Reads a string from a Stream that was encoded in UTF8. Value can be null and is prefixed with a boolean.
(Defined by StreamExtensions)
Public Extension MethodReadObject Reads an object from a stream.
(Defined by StreamExtensions)
Public Extension MethodReadSByte Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadSingle Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadStream Reads entire Stream contents, and returns Byte array of data.
(Defined by StreamExtensions)
Public Extension MethodReadString Reads a string from a Stream that was encoded in UTF8.
(Defined by StreamExtensions)
Public Extension MethodReadStringCollection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodReadUInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadUInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodReadUInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the entire buffer to the stream
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes a guid in little endian bytes to the stream
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWrite Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension MethodWriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension MethodWriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension MethodWriteNullable Writes the supplied string to a Stream in UTF8 encoding with a prefix if the value is null
(Defined by StreamExtensions)
Public Extension MethodWriteObject Encodes an object on a stream.
(Defined by StreamExtensions)
Public Extension MethodWriteWithLength Writes the supplied value to stream along with prefixing the length so it can be properly read as a unit.
(Defined by StreamExtensions)
Top
Remarks
This parser is designed as a write-only stream such that data can come from any source.
See Also