Caplin.DataSource.Cache.ICachedObject Interface Reference

An Caplin.DataSource.Cache.ICachedObject represents the base interface that all cached object types will implement in addition to any subject-type specific methods. More...

Inheritance diagram for Caplin.DataSource.Cache.ICachedObject:

Public Member Functions
IMessage	CreateImageMessage ()
	Creates the cache message. More...
IMessage	CreateUpdateMessage ()
	Creates a message containing the changes since the last time this method was called. More...
IMessage	CreateUpdateMessageWithOnlyChangedFields ()
	Creates a message containing the changes since the last time this method or CreateDeltaMessage() was called. More...
void	Update (IMessage message)
	Updates the cache using information from the supplied Caplin.DataSource.Messaging.IMessage More...

Properties
string	Subject [get]
	Gets the subject of this Caplin.DataSource.Cache.ICachedObject. More...

Detailed Description

An Caplin.DataSource.Cache.ICachedObject represents the base interface that all cached object types will implement in addition to any subject-type specific methods.

Member Function Documentation

IMessage Caplin.DataSource.Cache.ICachedObject.CreateImageMessage

(

)

Creates the cache message.

Returns

A message representing the state of the object

This method takes no account of the changes that may be pending.

IMessage Caplin.DataSource.Cache.ICachedObject.CreateUpdateMessage

(

)

Creates a message containing the changes since the last time this method was called.

Returns

An Caplin.DataSource.Messaging.IMessage representing the changes.

This method will commit to the cache any pending changes

IMessage Caplin.DataSource.Cache.ICachedObject.CreateUpdateMessageWithOnlyChangedFields

(

)

Creates a message containing the changes since the last time this method or CreateDeltaMessage() was called.

Returns

An Caplin.DataSource.Messaging.IMessage representing the changes.

This method will only add to the message fields which have had a value change. For example if the previous value of Bid was "20" and it has been updated to be "20" then this field will not be sent out.

This method will commit to the cache any pending changes.

void Caplin.DataSource.Cache.ICachedObject.Update

(

IMessage

message

)

Updates the cache using information from the supplied Caplin.DataSource.Messaging.IMessage

Parameters

message

The message.

This method will update the cache immediately, with the result that a call to Caplin.DataSource.Cache.ICachedObject.CreateDeltaMessage will not yield a message containing these changes

Property Documentation

string Caplin.DataSource.Cache.ICachedObject.Subject

get

Gets the subject of this Caplin.DataSource.Cache.ICachedObject.

The subject.