Gemstone PhasorProtocols Library
Frame
Methods
| BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| 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) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| 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. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CreateWaitHandle | Allocates a WaitHandle object. (Inherited from Stream) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the FrameParser object and optionally releases the managed resources.
(Overrides FrameParserBaseTFrameIdentifierDispose(Boolean)) |
| DisposeAsync | Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| 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) |
| FlushAsync | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream) |
| 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) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| ObjectInvariant | Provides support for a Contract. (Inherited from Stream) |
| OnBufferParsed |
Raises the BufferParsed event.
(Inherited from BinaryImageParserBase) |
| OnConfigurationChanged |
Raises the ConfigurationChanged event.
(Inherited from FrameParserBaseTFrameIdentifier) |
| OnDataDiscarded(Byte[]) |
Raises the DataDiscarded event.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| OnDataParsed(T3) |
Raises the DataParsed event.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| OnDuplicateTypeHandlerEncountered(Type, T1) |
Raises the DuplicateTypeHandlerEncountered event.
(Inherited from FrameImageParserBaseFrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| OnOutputTypeNotFound(T1) |
Raises the OutputTypeNotFound event.
(Inherited from FrameImageParserBaseFrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| OnParsingException |
Raises the ParsingException event.
(Overrides OnParsingException(Exception)) |
| OnReceivedChannelFrame |
Casts the parsed IChannelFrame to its specific implementation (i.e., DataFrame or ConfigurationFrame).
(Overrides FrameParserBaseTFrameIdentifierOnReceivedChannelFrame(IChannelFrame)) |
| OnReceivedCommandFrame |
Raises the ReceivedCommandFrame event.
(Inherited from FrameParserBaseTFrameIdentifier) |
| OnReceivedConfigurationFrame |
Raises the ReceivedConfigurationFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedConfigurationFrame(IConfigurationFrame)) |
| OnReceivedDataFrame |
Raises the ReceivedDataFrame event.
(Inherited from FrameParserBaseTFrameIdentifier) |
| OnReceivedFrameBufferImage |
Raises the ReceivedFrameImage and ReceivedFrameBufferImage event.
(Inherited from FrameParserBaseTFrameIdentifier) |
| OnReceivedHeaderFrame |
Raises the ReceivedHeaderFrame event.
(Overrides FrameParserBaseTFrameIdentifierOnReceivedHeaderFrame(IHeaderFrame)) |
| OnReceivedUndeterminedFrame |
Raises the ReceivedUndeterminedFrame event.
(Inherited from FrameParserBaseTFrameIdentifier) |
| OnSourceDataParsed(T1, IList<T3>) |
Raises the SourceDataParsed event.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| OnUnknownFrameTypeEncountered |
Handles unknown frame types.
(Inherited from FrameParserBaseTFrameIdentifier) |
| Parse(ISupportBinaryImage) |
Not implemented. Consumers should call the Parse(T1, ISupportBinaryImage) method instead to make sure data source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| Parse(T1, ISupportBinaryImage) |
Queues the object implementing the ISupportBinaryImage interface, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| Parse(T1, Byte[]) |
Queues a sequence of bytes, from the specified data source, onto the stream for parsing.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| Parse(SourceChannel, Byte, Int32, Int32) |
Writes a sequence of bytes onto the stream for parsing.
(Overrides Parse(T1, Byte[], Int32, Int32)) |
| ParseCommonHeader |
Parses a common header instance that implements ICommonHeader for the output type represented
in the binary image.
(Overrides ParseCommonHeader(Byte[], Int32, Int32)) |
| ParseFrame(Byte[], Int32, Int32) |
Output type specific frame parsing algorithm.
(Inherited from FrameImageParserBaseFrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| PublishParsedOutput(EventArgs<T2>) | AsyncQueue handler used to publish queued outputs.
(Inherited from FrameImageParserBaseFrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| PurgeBuffer(T1) |
Clears the internal buffer of unparsed data received from the specified source.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| Read(SpanByte) | When overridden in a derived class, 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) |
| Read(Byte[], Int32, Int32) |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| ReadAsync(MemoryByte, 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) |
| 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) |
| 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) |
| ReadAtLeast | Reads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream) |
| ReadAtLeastAsync | Asynchronously reads at least a minimum number 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) |
| 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) |
| ReadExactly(SpanByte) | Reads bytes from the current stream and advances the position within the stream until the buffer is filled. (Inherited from Stream) |
| ReadExactly(Byte, Int32, Int32) | Reads count number of bytes from the current stream and advances the position within the stream. (Inherited from Stream) |
| ReadExactlyAsync(MemoryByte, CancellationToken) | Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests. (Inherited from Stream) |
| ReadExactlyAsync(Byte, Int32, Int32, CancellationToken) | Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests. (Inherited from Stream) |
| Seek(Int64, SeekOrigin) |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| SetLength(Int64) |
The parser is designed as a write only stream, so this method is not implemented.
(Inherited from BinaryImageParserBase) |
| Start |
Start the data parser.
(Overrides Start) |
| Start(IEnumerable<Type>) |
Starts the data parser given the specified type implementations.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| Stop |
Stops the streaming data parser.
(Inherited from BinaryImageParserBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write(ReadOnlySpanByte) | When overridden in a derived class, 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) |
| Write(Byte[], Int32, Int32) |
Not implemented. Consumers should call the Parse(T1, Byte[], Int32, Int32) method instead to make sure data source ID gets tracked with data buffer.
(Inherited from MultiSourceFrameImageParserBaseSourceChannel, FrameType, ISupportSourceIdentifiableFrameImageSourceChannel, FrameType) |
| WriteAsync(ReadOnlyMemoryByte, 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) |
| 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) |
| 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) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream) |