Interface IStreamMetadata

Represents metadata used in storing stream data in a store.

Namespace: Microsoft.Psi

Assembly: Microsoft.Psi.dll

Syntax

public interface IStreamMetadata

Properties

AverageMessageLatencyMs

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

Declaration

double AverageMessageLatencyMs { get; }

Property Value

Type	Description
System.Double

AverageMessageSize

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

Declaration

double AverageMessageSize { get; }

Property Value

Type	Description
System.Double

ClosedTime

Gets the time when the stream was closed.

Declaration

DateTime ClosedTime { get; }

Property Value

Type	Description
DateTime

FirstMessageCreationTime

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

Declaration

DateTime FirstMessageCreationTime { get; }

Property Value

Type	Description
DateTime

See Also

CreationTime

FirstMessageOriginatingTime

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

Declaration

DateTime FirstMessageOriginatingTime { get; }

Property Value

Type	Description
DateTime

See Also

OriginatingTime

Id

Gets the id of the stream the metadata represents.

Declaration

int Id { get; }

Property Value

Type	Description
System.Int32

IsClosed

Gets a value indicating whether the stream has been closed.

Declaration

bool IsClosed { get; }

Property Value

Type	Description
System.Boolean

LastMessageCreationTime

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

Declaration

DateTime LastMessageCreationTime { get; }

Property Value

Type	Description
DateTime

See Also

CreationTime

LastMessageOriginatingTime

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

Declaration

DateTime LastMessageOriginatingTime { get; }

Property Value

Type	Description
DateTime

See Also

OriginatingTime

MessageCount

Gets the number of messages in the stream.

Declaration

long MessageCount { get; }

Property Value

Type	Description
System.Int64

Name

Gets the name of the stream the metadata represents.

Declaration

string Name { get; }

Property Value

Type	Description
System.String

OpenedTime

Gets the time when the stream was opened.

Declaration

DateTime OpenedTime { get; }

Property Value

Type	Description
DateTime

StoreName

Gets the name of the store containing the stream.

Declaration

string StoreName { get; }

Property Value

Type	Description
System.String

StorePath

Gets the path of the store containing the stream.

Declaration

string StorePath { get; }

Property Value

Type	Description
System.String

SupplementalMetadataTypeName

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

Declaration

string SupplementalMetadataTypeName { get; }

Property Value

Type	Description
System.String

TypeName

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

Declaration

string TypeName { get; }

Property Value

Type	Description
System.String

Methods

GetSupplementalMetadata<T>()

Gets supplemental stream metadata.

Declaration

T GetSupplementalMetadata<T>()

Returns

Type	Description
T	Supplemental metadata.

Type Parameters

Name	Description
T	Type of supplemental metadata.

Update(Envelope, Int32)

Updates this stream metadata with the specified envelope and size.

Declaration

void Update(Envelope envelope, int size)

Parameters

Type	Name	Description
Envelope	envelope	The envelope.
System.Int32	size	The size.

Update(TimeInterval, TimeInterval)

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

Declaration

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.

Extension Methods

Serializer.DeepClone<T>(T, ref T)

Serializer.DeepClone<T>(T, IRecyclingPool<T>)

Serializer.DeepClone<T>(T)