Craig's Utility Library  4.0 Beta
Utilities.IO.Messaging.BaseClasses.MessagingSystemBase Class Referenceabstract

Messaging system base class More...

Inheritance diagram for Utilities.IO.Messaging.BaseClasses.MessagingSystemBase:
Utilities.IO.Messaging.Interfaces.IMessagingSystem Utilities.IO.Messaging.Default.SMTPSystem

Public Member Functions

void Initialize (IEnumerable< IFormatter > Formatters)
 Initializes the system More...
 
async Task Send< T > (IMessage Message, T Model=null)
 Sends a message asynchronously More...
 
async Task Send (IMessage Message)
 Sends a message asynchronously More...
 

Protected Member Functions

 MessagingSystemBase ()
 Constructor More...
 
abstract void InternalSend (IMessage message)
 Internal function More...
 

Properties

IEnumerable< IFormatterFormatters [get]
 Formatters that the system have available More...
 
abstract Type MessageType [get]
 Message type that this handles More...
 
abstract string Name [get]
 Name of the messaging system More...
 
- Properties inherited from Utilities.IO.Messaging.Interfaces.IMessagingSystem
Type MessageType [get]
 Message type used by the communicator More...
 
string Name [get]
 Name of the communicator More...
 

Detailed Description

Messaging system base class

Definition at line 33 of file MessagingSystemBase.cs.

Constructor & Destructor Documentation

Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.MessagingSystemBase ( )
protected

Constructor

Definition at line 38 of file MessagingSystemBase.cs.

Member Function Documentation

void Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.Initialize ( IEnumerable< IFormatter Formatters)

Initializes the system

Parameters
FormattersPasses in the list of formatters that the system has found

Definition at line 62 of file MessagingSystemBase.cs.

abstract void Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.InternalSend ( IMessage  message)
protectedpure virtual

Internal function

Parameters
messageThe message.
async Task Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.Send ( IMessage  Message)

Sends a message asynchronously

Parameters
MessageMessage to send
Returns
The async task

Implements Utilities.IO.Messaging.Interfaces.IMessagingSystem.

Definition at line 98 of file MessagingSystemBase.cs.

async Task Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.Send< T > ( IMessage  Message,
Model = null 
)

Sends a message asynchronously

Template Parameters
TModel type
Parameters
MessageMessage to send
ModelModel object
Returns
The async task

Implements Utilities.IO.Messaging.Interfaces.IMessagingSystem.

Type Constraints
T :class 

Definition at line 75 of file MessagingSystemBase.cs.

Property Documentation

IEnumerable<IFormatter> Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.Formatters
get

Formatters that the system have available

Definition at line 46 of file MessagingSystemBase.cs.

abstract Type Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.MessageType
get

Message type that this handles

Definition at line 51 of file MessagingSystemBase.cs.

abstract string Utilities.IO.Messaging.BaseClasses.MessagingSystemBase.Name
get

Name of the messaging system

Definition at line 56 of file MessagingSystemBase.cs.


The documentation for this class was generated from the following file: