Click or drag to resize

FrameParser Methods

The FrameParser type exposes the following members.

Methods
  Name Description
Public method BeginRead Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public method BeginWrite Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public method Close Closes 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 method CopyTo(Stream) Reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public method CopyTo(Stream, Int32) Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream)
Public method CopyToAsync(Stream) Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream)
Public method CopyToAsync(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 method CopyToAsync(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 method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject)
Protected method CreateWaitHandle Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream)
Public method Dispose Releases all resources used by the Stream.
(Inherited from Stream)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the FrameParserBaseTFrameIdentifier object and optionally releases the managed resources.
(Inherited from FrameParserBaseTFrameIdentifier)
Public method EndRead Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public method EndWrite Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.)
(Inherited from Stream)
Public method Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public method Flush When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from BinaryImageParserBase)
Public method FlushAsync Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream)
Public method FlushAsync(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 method GetHashCode Serves as the default hash function.
(Inherited from Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Public method GetType Gets the Type of the current instance.
(Inherited from Object)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject)
Protected method MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject)
Protected method ObjectInvariant Obsolete.
Provides support for a Contract.
(Inherited from Stream)
Protected method OnBufferParsed Raises the BufferParsed event.
(Inherited from BinaryImageParserBase)
Protected method OnConfigurationChanged Raises the ConfigurationChanged event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected method OnDataDiscarded Raises the DataDiscarded event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected method OnDataParsed Raises the DataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected method OnDuplicateTypeHandlerEncountered Raises the DuplicateTypeHandlerEncountered event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected method OnOutputTypeNotFound Raises the OutputTypeNotFound event.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected method OnParsingException Raises the ParsingException event.
(Inherited from BinaryImageParserBase)
Protected method OnReceivedChannelFrame Casts the parsed IChannelFrame to its specific implementation (i.e., DataFrame, ConfigurationFrame, CommandFrame or HeaderFrame).
(Overrides FrameParserBaseTFrameIdentifierOnReceivedChannelFrame(IChannelFrame))
Protected method OnReceivedCommandFrame Raises the ReceivedCommandFrame event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected method OnReceivedConfigurationFrame Raises the ReceivedConfigurationFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedConfigurationFrame(IConfigurationFrame))
Protected method OnReceivedDataFrame Raises the ReceivedDataFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedDataFrame(IDataFrame))
Protected method OnReceivedFrameBufferImage Raises the ReceivedFrameImage and ReceivedFrameBufferImage event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected method OnReceivedHeaderFrame Raises the ReceivedHeaderFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedHeaderFrame(IHeaderFrame))
Protected method OnReceivedUndeterminedFrame Raises the ReceivedUndeterminedFrame event.
(Inherited from FrameParserBaseTFrameIdentifier)
Protected method OnSourceDataParsed Raises the SourceDataParsed event.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected method OnUnknownFrameTypeEncountered Handles unknown frame types.
(Inherited from FrameParserBaseTFrameIdentifier)
Public method Parse(ISupportBinaryImage) Obsolete.
Not implemented. Consumers should call the Parse(TSourceIdentifier, ISupportBinaryImage) method instead to make sure data source source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method Parse(TSourceIdentifier, ISupportBinaryImage) Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method Parse(TSourceIdentifier, Byte) Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method Parse(TSourceIdentifier, Byte, Int32, Int32) Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Protected method ParseCommonHeader Parses a common header instance that implements ICommonHeaderTTypeIdentifier for the output type represented in the binary image.
(Overrides FrameImageParserBaseTTypeIdentifier, TOutputTypeParseCommonHeader(Byte, Int32, Int32))
Protected method ParseFrame Output type specific frame parsing algorithm.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Protected method PublishParsedOutput AsyncQueueT handler used to publish queued outputs.
(Inherited from FrameImageParserBaseTTypeIdentifier, TOutputType)
Public method PurgeBuffer Clears the internal buffer of unparsed data received from the specified source.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method Read The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public method ReadAsync(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 method ReadAsync(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 method ReadByte Reads 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 method Seek The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public method SetLength The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase)
Public method Start Start the data parser.
(Overrides MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputTypeStart)
Public method Start(IEnumerableType) Starts the data parser given the specified type implementations.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method Stop Stops the streaming data parser.
(Inherited from BinaryImageParserBase)
Public method ToString Returns a string that represents the current object.
(Inherited from Object)
Public method Write Obsolete.
Not implemented. Consumers should call the Parse(TSourceIdentifier, Byte, Int32, Int32) method instead to make sure data source source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseTSourceIdentifier, TTypeIdentifier, TOutputType)
Public method WriteAsync(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 method WriteAsync(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 method WriteByte Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream)
Top
Extension Methods
  Name Description
Public Extension Method Compress Compress a stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension Method Compress Compress a stream onto given output stream using specified compression strength.
(Defined by CompressionExtensions)
Public Extension Method CopyStream Copies input Stream onto output Stream.
(Defined by StreamExtensions)
Public Extension Method CopyTo Writes the contents of a stream to the provided stream.
(Defined by StreamExtensions)
Public Extension Method Decompress Decompress a stream.
(Defined by CompressionExtensions)
Public Extension Method Decompress Decompress a stream onto given output stream.
(Defined by CompressionExtensions)
Public Extension Method Decrypt Returns a stream of decrypted data for the given parameters.
(Defined by Cipher)
Public Extension Method Decrypt Decrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension Method DeserializeToDataSet Deserializes a DataSet from a Stream.
(Defined by DataSetExtensions)
Public Extension Method Encrypt Returns a stream of encrypted data for the given parameters.
(Defined by Cipher)
Public Extension Method Encrypt Encrypts input stream onto output stream for the given parameters.
(Defined by Cipher)
Public Extension Method GetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method GetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension Method Read7BitUInt32 Reads the 7-bit encoded value from the stream.
(Defined by StreamExtensions)
Public Extension Method ReadAll 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 Method ReadBoolean Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension Method ReadBytes Reads a byte array from a Stream. The number of bytes should be prefixed in the stream.
(Defined by StreamExtensions)
Public Extension Method ReadChar Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadDateTime Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadDecimal Reads a decimal from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension Method ReadDouble Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadGuid Reads a Guid from the stream in Little Endian bytes.
(Defined by StreamExtensions)
Public Extension Method ReadInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadInt32Collection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension Method ReadInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadNextByte Read a byte from the stream. Will throw an exception if the end of the stream has been reached.
(Defined by StreamExtensions)
Public Extension Method ReadNullableString 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 Method ReadObject Reads an object from a stream.
(Defined by StreamExtensions)
Public Extension Method ReadSByte Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadSingle Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadStream Reads entire Stream contents, and returns Byte array of data.
(Defined by StreamExtensions)
Public Extension Method ReadString Reads a string from a Stream that was encoded in UTF8.
(Defined by StreamExtensions)
Public Extension Method ReadStringCollection Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension Method ReadUInt16 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadUInt32 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method ReadUInt64 Reads the value from the stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the entire buffer to the stream
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes a guid in little endian bytes to the stream
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied string to a Stream in UTF8 encoding.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method Write Writes the supplied value to stream in little endian format.
(Defined by StreamExtensions)
Public Extension Method WriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension Method WriteCollection Writes the supplied Collection to a Stream.
(Defined by StreamExtensions)
Public Extension Method WriteNullable Writes the supplied string to a Stream in UTF8 encoding with a prefix if the value is null
(Defined by StreamExtensions)
Public Extension Method WriteObject Encodes an object on a stream.
(Defined by StreamExtensions)
Public Extension Method WriteWithLength Writes the supplied value to stream along with prefixing the length so it can be properly read as a unit.
(Defined by StreamExtensions)
Top
See Also