Class Channel
Represents a messaging channel that hosts message boxes of the particular type
Inheritance
System.Object
Channel
Implements
System.IDisposable
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)
Assembly: Azos.Sky.dll
Syntax
public abstract class Channel : DaemonWithInstrumentation<WebMessageSystemService>, IDisposable, IDaemon, IDaemonView, IApplicationComponent, INamed, IConfigurable, ILocalizedTimeProvider, IInstrumentable, IExternallyParameterized
Constructors
Channel(WebMessageSystemService)
Declaration
protected Channel(WebMessageSystemService director)
Parameters
Methods
FetchMailboxMessage(MailboxMsgID)
Fetches mailbox message by id or null if not found
Declaration
public abstract SkyWebMessage FetchMailboxMessage(MailboxMsgID mid)
Parameters
Returns
FetchMailboxMessageAttachment(MailboxMsgID, Int32)
Fetches an attachment for the specified message by id and attachment index or null if not found
Declaration
public abstract Message.Attachment FetchMailboxMessageAttachment(MailboxMsgID mid, int attachmentIndex)
Parameters
| Type |
Name |
Description |
| MailboxMsgID |
mid |
|
| System.Int32 |
attachmentIndex |
|
Returns
GetMailboxInfo(MailboxID)
Returns information about a particular mailbox on this channel or null if not found
Declaration
public abstract MailboxInfo GetMailboxInfo(MailboxID xid)
Parameters
Returns
GetMessageCount(MailboxID, String)
Returns message count for the specified mailbox and query
Declaration
public abstract int GetMessageCount(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
| Type |
Description |
| System.Int32 |
|
Returns message headers for the specified mailbox and query or null
Declaration
public abstract MessageHeaders GetMessageHeaders(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
UpdateMailboxMessagePublication(MailboxMsgID, MsgPubStatus, String, String)
Updates the particular mailbox message publication status along with operator and description
Declaration
public abstract void UpdateMailboxMessagePublication(MailboxMsgID mid, MsgPubStatus status, string oper, string description)
Parameters
UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID>, MsgStatus, String, String)
Updates mailbox messages status
Declaration
public abstract void UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID> mids, MsgStatus status, string folders, string adornments)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.IEnumerable<MailboxMsgID> |
mids |
|
| MsgStatus |
status |
|
| System.String |
folders |
|
| System.String |
adornments |
|
UpdateMailboxMessageStatus(MailboxMsgID, MsgStatus, String, String)
Updates the particular mailbox message status
Declaration
public abstract void UpdateMailboxMessageStatus(MailboxMsgID mid, MsgStatus status, string folders, string adornments)
Parameters
Write(List<MsgSendInfo>, Int32, String, SkyWebMessage)
Writes msg into mailbox identified by the particular address.
Reliability: this method must not leak errors, but should handle them depending on particular
channel implementation and message importance (i.e. we may create ToDo that will try to redeliver)
Declaration
public abstract MsgChannelWriteResult Write(List<MsgSendInfo> deliveryList, int idx, string address, SkyWebMessage msg)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<MsgSendInfo> |
deliveryList |
|
| System.Int32 |
idx |
|
| System.String |
address |
|
| SkyWebMessage |
msg |
|
Returns
Implements
System.IDisposable
Extension Methods