Caplin.DataSource.Messaging.Record.IGenericMessage Interface Reference

Interface for sending Generic messages, adding fields by name and value. More...

Inheritance diagram for Caplin.DataSource.Messaging.Record.IGenericMessage:

Properties
bool	NoCache [get, set]
	Gets or sets whether this generic message should be cached in the DataSource (both remote and local ). More...
Properties inherited from Caplin.DataSource.Messaging.Record.IRecordMessage
IList< IField >	Fields [get]
	Gets the fields within this mesasge. More...
DateTime	InitialLatencyChainTime [set]
	Sets the initial time for latency chaining. More...
string	this[string fieldName] [get, set]
	Gets or sets a specified field. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Additional Inherited Members
Public Member Functions inherited from Caplin.DataSource.Messaging.Record.IRecordMessage
void	AddLatencyChainPoint (string pointName, DateTime dateTime)
	Adds a latency chain point More...
void	ClearFields ()
	Removes all the fields More...
bool	ContainsField (string fieldName)
	Determines whether the message contains the specified field More...
void	RemoveField (string fieldName)
	Removes the given field from this RecordMessage. More...
void	SetField (string fieldName, string value)
	Sets the value of a specified field. More...

Detailed Description

Interface for sending Generic messages, adding fields by name and value.

Caplin.DataSource.Messaging.Record.IGenericMessage behaves according to the Caplin.DataSource.Messaging.Record.IRecordMessage interface, so calling Caplin.DataSource.Messaging.Record.GenericMessage.Fields on a Caplin.DataSource.Messaging.Record.IGenericMessage returns an identical list of fields to a properly configured adapter using a Caplin.DataSource.Messaging.Record.RecordType1Message.

While GenericMessage behave similarly to RecordType1Message, it eliminates the need to provide field mappings in fields.conf. This may be useful when receiving updates from a provider which supplies a variable or unknown number of fields.

Property Documentation

bool Caplin.DataSource.Messaging.Record.IGenericMessage.NoCache

getset

Gets or sets whether this generic message should be cached in the DataSource (both remote and local ).

true if if this record should not be cached in the remote DataSource's cache, false if it should be cached.