Class Mailbox
Represents CRUD row data recipient
Inheritance
System.Object
Mailbox
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)
System.Object.ToString()
Namespace: NFX.DataAccess.CRUD.Subscriptions
Assembly: NFX.dll
Syntax
public class Mailbox : SubscriptionAppComponent, IApplicationComponent, IDisposable, IExternallyParameterized, INamedConstructors
Mailbox(ICRUDSubscriptionStoreImplementation, String)
Declaration
protected Mailbox(ICRUDSubscriptionStoreImplementation store, string name)Parameters
| Type | Name | Description |
|---|---|---|
| ICRUDSubscriptionStoreImplementation | store | |
| System.String | name |
Properties
BufferCapacity
Declaration
[ExternalParameter(new string[]{"data"})]
public int BufferCapacity { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Buffered
Returns all buffered data in chronological order
Declaration
public CRUDSubscriptionEvent[] Buffered { get; }Property Value
| Type | Description |
|---|---|
| CRUDSubscriptionEvent[] |
BufferedCount
Returns how much is currently buffered
Declaration
public int BufferedCount { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Name
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Store
Declaration
public ICRUDSubscriptionStore Store { get; }Property Value
| Type | Description |
|---|---|
| ICRUDSubscriptionStore |
Subscriptions
Declaration
public IRegistry<Subscription> Subscriptions { get; }Property Value
| Type | Description |
|---|---|
| IRegistry<Subscription> |
Methods
Deliver(Subscription, CRUDSubscriptionEvent)
Delivers data to the mailbox. This method is called by subscription
Declaration
public bool Deliver(Subscription subscription, CRUDSubscriptionEvent data)Parameters
| Type | Name | Description |
|---|---|---|
| Subscription | subscription | |
| CRUDSubscriptionEvent | data |
Returns
| Type | Description |
|---|---|
| System.Boolean |
DeliverError(Subscription, Exception)
Declaration
public bool DeliverError(Subscription subscription, Exception error)Parameters
| Type | Name | Description |
|---|---|---|
| Subscription | subscription | |
| System.Exception | error |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Destructor()
Declaration
protected override void Destructor()Overrides
FetchBuffered(Int32, Boolean)
Tries to take the specified number of samples in chronological order
Declaration
public List<CRUDSubscriptionEvent> FetchBuffered(int count, bool keep = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | count | |
| System.Boolean | keep |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<CRUDSubscriptionEvent> |
OnReceipt(Subscription, CRUDSubscriptionEvent, Exception)
Declaration
protected virtual void OnReceipt(Subscription subscription, CRUDSubscriptionEvent data, Exception error)Parameters
| Type | Name | Description |
|---|---|---|
| Subscription | subscription | |
| CRUDSubscriptionEvent | data | |
| System.Exception | error |
Events
Receipt
Declaration
public event SubscriptionReceiptEventHandler ReceiptEvent Type
| Type | Description |
|---|---|
| SubscriptionReceiptEventHandler |
Implements
System.IDisposable