DataSource.NET
8.0.3.290770-7760911e
|
![]() |
A message factory is used to create DataSource messages that can be published to other DataSources. More...
Inherited by Caplin.DataSource.Messaging.IInternalMessageFactory.
Public Member Functions | |
IContainerMessage | CreateContainerMessage (string subject) |
Create a message that defines a container. The name of the container is the given subject. More... | |
IGenericMessage | CreateGenericMessage (string subject) |
Creates a Generic message to which Generic structured data can be added. More... | |
IJsonMessage | CreateJsonImageMessage (string subject, string json) |
Creates a JSON image message for the given subject. More... | |
IJsonMessage | CreateJsonPatchMessage (string subject, string json) |
Creates a JSON patch message for the given subject. More... | |
IMappingMessage | CreateMappingMessage (string subject, string mapping) |
Create a new mapping message; More... | |
INewsMessage | CreateNewsMessage (string subject, string headline, string storyReference, string newsDateTime) |
Creates a News message for the given subject. More... | |
IPageMessage | CreatePageMessage (string subject, int maxColumns, int maxRows) |
Creates a Page message for the given subject. More... | |
IPermissionMessage | CreatePermissionMessage (string subject, string key) |
Creates a Permission message for the given subject. More... | |
IRecordType1Message | CreateRecordType1Message (string subject) |
Creates a Record message to which Type 1 structured data can be added. More... | |
IRecordType2Message | CreateRecordType2Message (string subject, string type2Indexfield, string type2IndexValue) |
Creates a Record message to which Type 2 structured data can be added. More... | |
IRecordType3Message | CreateRecordType3Message (string subject) |
Creates a Record message to which Type 3 structured data can be added. More... | |
IStatusEvent | CreateStatusEvent (SubjectStatus status, string message) |
Creates a status event. More... | |
IStoryMessage | CreateStoryMessage (string subject, string text) |
Creates a story message for the given subject. More... | |
ISubjectErrorEvent | CreateSubjectErrorEvent (string subject, SubjectError error, params SubjectErrorFlags[] flags) |
Creates a subject error event. More... | |
ISubjectStatusEvent | CreateSubjectStatusEvent (string subject, SubjectStatus status, string message) |
Creates a subject status event. More... | |
IWrapperMessage | CreateWrapperMessage (string subject) |
Create a new wrapper message; More... | |
A message factory is used to create DataSource messages that can be published to other DataSources.
IContainerMessage Caplin.DataSource.Messaging.IMessageFactory.CreateContainerMessage | ( | string | subject | ) |
Create a message that defines a container. The name of the container is the given subject.
subject | The subject defining the name of the container. |
IGenericMessage Caplin.DataSource.Messaging.IMessageFactory.CreateGenericMessage | ( | string | subject | ) |
Creates a Generic message to which Generic structured data can be added.
subject | The subject of the Message. |
Generic messages can be used without specifying field mappings in a separate adapter configuration file. This may be useful when receiving updates from a provider which supplies a variable or unknown number of fields.
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Record.IGenericMessage.
IJsonMessage Caplin.DataSource.Messaging.IMessageFactory.CreateJsonImageMessage | ( | string | subject, |
string | json | ||
) |
IJsonMessage Caplin.DataSource.Messaging.IMessageFactory.CreateJsonPatchMessage | ( | string | subject, |
string | json | ||
) |
IMappingMessage Caplin.DataSource.Messaging.IMessageFactory.CreateMappingMessage | ( | string | subject, |
string | mapping | ||
) |
Create a new mapping message;
subject | The original subject. |
mapping | The new subject that the remote peer must request to satisfy the subscription. |
INewsMessage Caplin.DataSource.Messaging.IMessageFactory.CreateNewsMessage | ( | string | subject, |
string | headline, | ||
string | storyReference, | ||
string | newsDateTime | ||
) |
IPageMessage Caplin.DataSource.Messaging.IMessageFactory.CreatePageMessage | ( | string | subject, |
int | maxColumns, | ||
int | maxRows | ||
) |
Creates a Page message for the given subject.
subject | The subject of the page message. |
maxColumns | The maximum horizontal size of the page in columns of text characters. |
maxRows | The maximum vertical size of the page in rows of text. |
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Page.IPageMessage.
IPermissionMessage Caplin.DataSource.Messaging.IMessageFactory.CreatePermissionMessage | ( | string | subject, |
string | key | ||
) |
Creates a Permission message for the given subject.
subject | The subject of the Permission message. |
key | The permission key. |
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Permission.IPermissionMessage.
IRecordType1Message Caplin.DataSource.Messaging.IMessageFactory.CreateRecordType1Message | ( | string | subject | ) |
Creates a Record message to which Type 1 structured data can be added.
subject | The subject of the Record. |
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Record.IRecordType1Message.
IRecordType2Message Caplin.DataSource.Messaging.IMessageFactory.CreateRecordType2Message | ( | string | subject, |
string | type2Indexfield, | ||
string | type2IndexValue | ||
) |
Creates a Record message to which Type 2 structured data can be added.
subject | The subject of the Record. |
type2Indexfield | Field name of the type2 index. |
type2IndexValue | The value of the type2 index. |
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Record.IRecordType2Message.
IRecordType3Message Caplin.DataSource.Messaging.IMessageFactory.CreateRecordType3Message | ( | string | subject | ) |
Creates a Record message to which Type 3 structured data can be added.
subject | The subject of the Record. |
The returned message contains no data. To populate the message with data, use the appropriate methods of Caplin.DataSource.Messaging.Record.IRecordType3Message.
IStatusEvent Caplin.DataSource.Messaging.IMessageFactory.CreateStatusEvent | ( | SubjectStatus | status, |
string | message | ||
) |
Creates a status event.
status | The status. |
message | A free form textual message indicating the reason for the status message being raised. |
The following example shows how to create an IStatusEvent, and send it for all requested subjects to all peers that have requested those subjects.
IStoryMessage Caplin.DataSource.Messaging.IMessageFactory.CreateStoryMessage | ( | string | subject, |
string | text | ||
) |
Creates a story message for the given subject.
subject | The subject. |
text | The story text. |
ISubjectErrorEvent Caplin.DataSource.Messaging.IMessageFactory.CreateSubjectErrorEvent | ( | string | subject, |
SubjectError | error, | ||
params SubjectErrorFlags[] | flags | ||
) |
Creates a subject error event.
subject | The subject to which the error relates. |
error | The error. |
flags | Additional Flags to be applied to the SubjectError message. |
The following example shows how to create an ISubjectErrorEvent for a specified subject, and send it to all peers that have requested that subject:
ISubjectStatusEvent Caplin.DataSource.Messaging.IMessageFactory.CreateSubjectStatusEvent | ( | string | subject, |
SubjectStatus | status, | ||
string | message | ||
) |
Creates a subject status event.
subject | The subject to which the status relates. |
status | The status. |
message | A free form textual message indicating the reason for the status message being raised. |
The following example shows how to create an ISubjectStatusEvent for a specified subject, and send it to all peers that have requested that subject.
IWrapperMessage Caplin.DataSource.Messaging.IMessageFactory.CreateWrapperMessage | ( | string | subject | ) |
Create a new wrapper message;
subject | The subject. |