Class StreamMetadataBase

Stream metadata base class.

Inheritance
System.Object
StreamMetadataBase
WaveFileStreamReader.WaveAudioStreamMetadata
Implements
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public abstract class StreamMetadataBase : object, IStreamMetadata

Constructors

View Source

StreamMetadataBase(String, Int32, String, String, String, DateTime, DateTime, Int64, Double, Double)

Initializes a new instance of the StreamMetadataBase class.

Declaration
public StreamMetadataBase(string name, int id, string typeName, string partitionName, string partitionPath, DateTime first, DateTime last, long messageCount, double averageMessageSize, double averageLatencyMs)
Parameters
Type Name Description
System.String name

Stream name.
System.Int32 id

Stream ID.
System.String typeName

Stream type name.
System.String partitionName

Partition/file name.
System.String partitionPath

Partition/file path.
DateTime first

First message time.
DateTime last

Last message time.
System.Int64 messageCount

Total message count.
System.Double averageMessageSize

Average message size (bytes).
System.Double averageLatencyMs

Average message latency (milliseconds).

Properties

View Source

AverageMessageLatencyMs

Gets the average latency (milliseconds) of messages in the stream.

Declaration
public double AverageMessageLatencyMs { get; }
Property Value
Type Description
System.Double
View Source

AverageMessageSize

Gets the average size (bytes) of messages in the stream.

Declaration
public double AverageMessageSize { get; }
Property Value
Type Description
System.Double
View Source

ClosedTime

Gets the time when the stream was closed.

Declaration
public DateTime ClosedTime { get; }
Property Value
Type Description
DateTime
View Source

FirstMessageCreationTime

Gets the first creation time of a message in the stream.

Declaration
public DateTime FirstMessageCreationTime { get; }
Property Value
Type Description
DateTime
See Also
View Source

FirstMessageOriginatingTime

Gets the first originating time of a message in the stream.

Declaration
public DateTime FirstMessageOriginatingTime { get; }
Property Value
Type Description
DateTime
See Also
View Source

Id

Gets the id of the stream the metadata represents.

Declaration
public int Id { get; }
Property Value
Type Description
System.Int32
View Source

IsClosed

Gets a value indicating whether the stream has been closed.

Declaration
public bool IsClosed { get; }
Property Value
Type Description
System.Boolean
View Source

LastMessageCreationTime

Gets the last creation time of a message in the stream.

Declaration
public DateTime LastMessageCreationTime { get; }
Property Value
Type Description
DateTime
See Also
View Source

LastMessageOriginatingTime

Gets the last originating time of a message in the stream.

Declaration
public DateTime LastMessageOriginatingTime { get; }
Property Value
Type Description
DateTime
See Also
View Source

MessageCount

Gets the number of messages in the stream.

Declaration
public long MessageCount { get; }
Property Value
Type Description
System.Int64
View Source

Name

Gets the name of the stream the metadata represents.

Declaration
public string Name { get; }
Property Value
Type Description
System.String
View Source

OpenedTime

Gets the time when the stream was opened.

Declaration
public DateTime OpenedTime { get; }
Property Value
Type Description
DateTime
View Source

StoreName

Gets the name of the store containing the stream.

Declaration
public string StoreName { get; }
Property Value
Type Description
System.String
View Source

StorePath

Gets the path of the store containing the stream.

Declaration
public string StorePath { get; }
Property Value
Type Description
System.String
View Source

SupplementalMetadataTypeName

Gets the name of the type of supplemental metadata for the stream the metadata represents.

Declaration
public string SupplementalMetadataTypeName { get; }
Property Value
Type Description
System.String
View Source

TypeName

Gets the name of the type of data contained in the stream the metadata represents.

Declaration
public string TypeName { get; }
Property Value
Type Description
System.String

Methods

View Source

GetSupplementalMetadata<T>()

Gets supplemental stream metadata.

Declaration
public virtual T GetSupplementalMetadata<T>()
Returns
Type Description
T

Supplemental metadata.
Type Parameters
Name Description
T

Type of supplemental metadata.
View Source

Update(Envelope, Int32)

Updates this stream metadata with the specified envelope and size.

Declaration
public virtual void Update(Envelope envelope, int size)
Parameters
Type Name Description
Envelope envelope

The envelope.
System.Int32 size

The size.
View Source

Update(TimeInterval, TimeInterval)

Updates this stream metadata with the times and originating times of the first and last messages.

Declaration
public virtual void Update(TimeInterval messagesTimeInterval, TimeInterval messagesOriginatingTimeInterval)
Parameters
Type Name Description
TimeInterval messagesTimeInterval

A TimeInterval representing the times of the first and last messages in the stream.
TimeInterval messagesOriginatingTimeInterval

A TimeInterval representing the originating times of the first and last messages in the stream.

Implements

Extension Methods