Struct TopicId

Namespace

Microsoft.AutoGen.Contracts

Assembly

Microsoft.AutoGen.Contracts.dll

Stellt eine Themen-ID dar, die den Geltungsbereich einer Broadcast-Nachricht definiert. Die Agenten-Laufzeit implementiert ein Publish-Subscribe-Modell über ihre Broadcast-API, wobei Nachrichten mit einem bestimmten Thema veröffentlicht werden müssen.

Siehe das Python-Äquivalent: CloudEvents Type Specification.

public struct TopicId

Geerbte Member

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Konstruktoren

TopicId(string, string)

Initialisiert eine neue Instanz der TopicId-Struktur.

public TopicId(string type, string source = "default")

Parameter

type string

Der Typ des Themas.

source string

Die Quelle des Ereignisses. Standardmäßig DefaultSource, wenn nicht angegeben.

TopicId((string Type, string Source))

Initialisiert eine neue Instanz der TopicId-Struktur aus einem Tupel.

public TopicId((string Type, string Source) kvPair)

Parameter

kvPair (string, string)

Ein Tupel, das den Thema-Typ und die Quelle enthält.

Felder

DefaultSource

Der Standardwert für die Quelle, der verwendet wird, wenn keine Quelle explizit angegeben ist.

public const string DefaultSource = "default"

Feldwert

string

Eigenschaften

Source

Ruft die Quelle ab, die den Kontext identifiziert, in dem ein Ereignis aufgetreten ist. Dies entspricht der CloudEvents-Spezifikation.

Mehr dazu hier: CloudEvents Source.

public readonly string Source { get; }

Eigenschaftswert

string

Type

Ruft den Typ des Ereignisses ab, das diese TopicId darstellt. Dies entspricht der CloudEvents-Spezifikation.

Muss dem Muster entsprechen: ^[\w-.:=]+$.

Mehr dazu hier: CloudEvents Type.

public readonly string Type { get; }

Eigenschaftswert

string

Methoden

Equals(object?)

Bestimmt, ob das angegebene Objekt gleich der aktuellen TopicId ist.

public override bool Equals(object? obj)

Parameter

obj object

Das Objekt, das mit der aktuellen Instanz verglichen werden soll.

Rückgabe

bool

true, wenn das angegebene Objekt gleich der aktuellen TopicId ist; andernfalls false.

FromStr(string)

Konvertiert eine Zeichenfolge im Format "typ/quelle" in eine TopicId.

public static TopicId FromStr(string maybeTopicId)

Parameter

maybeTopicId string

Die Topic-ID-Zeichenfolge.

Rückgabe

TopicId

Eine Instanz von TopicId.

Ausnahmen

FormatException

Wird ausgelöst, wenn die Zeichenfolge nicht im gültigen "typ/quelle"-Format vorliegt.

GetHashCode()

Gibt einen Hashcode für diese TopicId zurück.

public override int GetHashCode()

Rückgabe

int

Ein Hashcode für die aktuelle Instanz.

IsWildcardMatch(TopicId)

Bestimmt, ob die gegebene TopicId mit einem anderen Thema übereinstimmt.

public bool IsWildcardMatch(TopicId other)

Parameter

other TopicId

Die Topic-ID, mit der verglichen werden soll.

Rückgabe

bool

true, wenn die Thema-Typen gleich sind; andernfalls false.

ToString()

Gibt die Zeichenfolgendarstellung der TopicId zurück.

public override string ToString()

Rückgabe

string

Eine Zeichenfolge im Format "typ/quelle".

Operatoren

explicit operator TopicId(string)

Konvertiert explizit eine Zeichenfolge in eine TopicId.

public static explicit operator TopicId(string id)

Parameter

id string

Die Zeichenfolgendarstellung einer Topic-ID.

Rückgabe

TopicId

Eine Instanz von TopicId.