Class Subscription
Represents a subscription to the CRUD Data. Call Dispose() to terminate the subscription.
Inheritance
System.Object
Subscription
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Azos.Data.Access.Subscriptions
Assembly: Azos.dll
Syntax
public abstract class Subscription : SubscriptionAppComponent, IDisposable, IApplicationComponent, IExternallyParameterized, INamedConstructors
Subscription(ICRUDSubscriptionStoreImplementation, String, Query, Mailbox, Object)
Declaration
protected Subscription(ICRUDSubscriptionStoreImplementation store, string name, Query query, Mailbox mailbox, object correlate)Parameters
| Type | Name | Description |
|---|---|---|
| ICRUDSubscriptionStoreImplementation | store | |
| System.String | name | |
| Query | query | |
| Mailbox | mailbox | |
| System.Object | correlate |
Properties
Correlate
Allows to attach arbtrary bject for correlation
Declaration
public object Correlate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object |
InvalidSubscriptionException
If this property is not null then this subscription is !IsValid
Declaration
public InvalidSubscriptionRequestException InvalidSubscriptionException { get; }Property Value
| Type | Description |
|---|---|
| InvalidSubscriptionRequestException |
IsLoaded
Declaration
public bool IsLoaded { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsValid
Returns false when this subscription experienced InvalidSubscriptionException
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Mailbox
Declaration
public Mailbox Mailbox { get; }Property Value
| Type | Description |
|---|---|
| Mailbox |
Name
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Query
Declaration
public Query Query { get; }Property Value
| Type | Description |
|---|---|
| Query |
Store
Declaration
public ICRUDSubscriptionStore Store { get; }Property Value
| Type | Description |
|---|---|
| ICRUDSubscriptionStore |
Methods
Destructor()
Declaration
protected override void Destructor()Overrides
HasLoaded()
Call after subscription has been initialized
Declaration
protected void HasLoaded()Invalidate(InvalidSubscriptionRequestException)
Called by descendants to invalidate this subscription
Declaration
protected void Invalidate(InvalidSubscriptionRequestException error)Parameters
| Type | Name | Description |
|---|---|---|
| InvalidSubscriptionRequestException | error |
Implements
System.IDisposable