Interface IEmitter
Enables message passing between components.
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public interface IEmitter
Properties
View SourceHasSubscribers
Gets a value indicating whether emitter has subscribers.
Declaration
bool HasSubscribers { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Id
Gets emitter ID.
Declaration
int Id { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
LastEnvelope
Gets the envelope of the last message posted on this emitter.
Declaration
Envelope LastEnvelope { get; }
Property Value
Type | Description |
---|---|
Envelope |
Name
Gets emitter name.
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
String |
Owner
Gets emitter owner object.
Declaration
object Owner { get; }
Property Value
Type | Description |
---|---|
Object |
Pipeline
Gets pipeline to which emitter belongs.
Declaration
Pipeline Pipeline { get; }
Property Value
Type | Description |
---|---|
Pipeline |
Type
Gets emitter type.
Declaration
Type Type { get; }
Property Value
Type | Description |
---|---|
Type |
Methods
View SourceClose(DateTime)
Close emitter, causing all receivers to be unsubscribed.
Declaration
void Close(DateTime originatingTime)
Parameters
Type | Name | Description |
---|---|---|
DateTime | originatingTime | The originating time at which the emitter closes. |
DebugView(String)
Enables debug visualization for this stream.
Declaration
string DebugView(string debugName = null)
Parameters
Type | Name | Description |
---|---|---|
String | debugName | An optional name to use in the visualization window. |
Returns
Type | Description |
---|---|
String | The debug name of the stream, either as provided or the generated one if one was not specified. |