Class SL4B_AbstractSubscriber

Object
   |
   +--SL4B_AbstractSubscriber

Direct Known Subclasses:

LF_RtmlSubscriber, SL4B_ProxySubscriber, LF_ContributionSubscriber, LF_RtslSubscriber, LF_NullSubscriptionManager

class SL4B_AbstractSubscriber

Base class that must be extended by any class that is interested in receiving notifications of updates to RTTP objects stored in a Liberator. The type of notification that will be received depends on whether a valid object has been requested, whether the user has permission to view the object, and what the type of the object is.

A subscription must be made via an implementation of the SL4B_AbstractRttpProvider class. The SL4B_Accessor.getRttpProvider() singleton method should be used to get a reference to the concrete RTTP provider that has been specified for the web page.

All subclasses must invoke the SL4B_AbstractSubscriber.initialise() method within their constructor. It is strongly recommended that it is only invoked after the constructor has initialised the object instance, since the ready() callback may be invoked as part of this initialise call.

Constructor Detail

SL4B_AbstractSubscriber

SL4B_AbstractSubscriber()

Constructs a new SL4B_AbstractSubscriber.

chat

void chat(<String> l_sObjectName, <String> l_sTime, <String> l_sUsername, <String> l_sMessage, <int> l_nStatus)

Invoked when a message has been contributed to the specified RTTP chat object which has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP chat object that the message was contributed to.
l_sTime - The time the message was received by the Liberator.
l_sUsername - The name of the user that contributed the message.
l_sMessage - The message text that was contributed.
l_nStatus - The type of message that has been sent. The possible states are defined by the SL4B_ChatStatus singleton class.

contribFailed

void contribFailed(<String> l_sObjectName, <String> l_sReason, <int> l_nAuthCode)

Invoked after an attempt to contribute data to the specified RTTP object has failed.

Warning: If data must be contributed to the same object before an ok/failed response is received, it is recommended that a different subscriber is used, otherwise if one ok and one failed response are received, it will not be possible for the subscriber to know which response applies to which contribution.

Parameters:
l_sObjectName - The name of the object that the data was contributed to.
l_sReason - A brief description of why the contribution failed.
l_nAuthCode - The optional error code sent by the Liberators Auth module to provide additional information for why read access was denied. This will be undefined if a standard read deny is returned by the Auth module.

contribOk

void contribOk(<String> l_sObjectName)

Invoked after an attempt to contribute data to the specified RTTP object has been successful.

Warning: If data must be contributed to the same object before an ok/failed response is received, it is recommended that a different subscriber is used, otherwise if one ok and one failed response are received, it will not be possible for the subscriber to know which response applies to which contribution.

Parameters:
l_sObjectName - The name of the object that the data was contributed to.

directoryMultiUpdated

void directoryMultiUpdated(l_sDirObjectName, <SL4B_RecordFieldData> l_oFieldData)

Invoked when a several field updates occur at the same time for an RTTP record object that has been subscribed to. This allows certain fields to be associated with a single transaction, such as a trade, where, for example, the trade price, trade volume and trade time may all need to be known.

Parameters:
l_oFieldData - A collection of all the field name/value pairs that have updated.
l_sObjectName - The name of the RTTP record object.

directoryUpdated

void directoryUpdated(<String> l_sDirObjectName, <String> l_sObjectName, <int> l_nType, <boolean> l_bAdded)

Invoked when the contents of an RTTP directory object that has been subscribed to change. This method is also invoked when the directory object is first subscribed to, informing the subscriber of the directorys initial contents.

Parameters:
l_sDirObjectName - The name of the RTTP directory object that has updated.
l_sObjectName - The base name (i.e. without the directory object name as a prefix) of the RTTP object within the directory that has been updated.
l_nType - The type of the RTTP object. The SL4B_ObjectType singleton defines the possible values.
l_bAdded - true if the specified object has been added to the directory, or false if it has been removed.

fieldDeleted

void fieldDeleted(<String> l_sObjectName, <String> l_sFieldName, <String> l_sMarketMakerId)

Invoked when a field is deleted from an RTTP record object which has been subscribed to. This method will only be called if the field that is deleted was subscribed to.

Parameters:
l_sObjectName - The name of the RTTP record object that the field was deleted from.
l_sFieldName - The name of the field that was deleted.
l_sMarketMakerId - If the field is a type 2 record field, this is the identifier of the market maker that the field was deleted for.

initialise

void initialise()

Initialises the member variables for the SL4B_AbstractSubscriber. This method must be invoked within the constructor for the concrete subscriber class. It is strongly recommended that it is only invoked after the constructor has initialised the object instance, since the ready() callback may be invoked as part of this initialise call.

newsUpdated

void newsUpdated(<String> l_sObjectName, <String> l_sStoryCode, <String> l_sHeadline, <String> l_sDate)

Invoked when an update is generated for an RTTP news headline object which has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP news headline object that the update applies to.
l_sStoryCode - The story code that is associated with the headline.
l_sHeadline - The headline text.
l_sDate - The date/time stamp associated with the headline.

objectDeleted

void objectDeleted(<String> l_sObjectName)

Invoked when an object that has been subscribed to is deleted from the Liberator.

Parameters:
l_sObjectName - The name of the RTTP object that has been deleted.

objectInfo

void objectInfo(<String> l_sObjectName, <int> l_nType, <String> l_sParameter, <String> l_sValue)

Invoked when an generic informational message is generated for an RTTP object that has been subscribed to. This will be invoked before any other updates for the object.

Parameters:
l_sObjectName - The name of the RTTP object that the informational message applies to.
l_nType - The type of the RTTP object. The SL4B_ObjectType singleton defines the possible values.
l_sParameter - The parameter specified for the message.
l_sValue - The value of the message.

objectNotFound

void objectNotFound(<String> l_sObjectName)

Invoked when an RTTP object that has been subscribed to is not found on the Liberator (i.e. it does not exist at the moment). This will occur if the specified object cannot be found in the Liberators cache, nor from any of its DataSources.

Parameters:
l_sObjectName - The name of the RTTP object that was not found.

objectNotStale

void objectNotStale(<String> l_sObjectName, <String> l_sFieldName)

Invoked when the value of a field of an RTTP object that has been subscribed to is no longer stale.

Parameters:
l_sObjectName - The name of the RTTP object that is no longer stale.
l_sFieldName - The name of the field that is no longer stale.

Deprecated SL4B_AbstractSubscriber.objectStatus() will be invoked instead.

objectReadDenied

void objectReadDenied(<String> l_sObjectName, <int> l_nAuthCode)

Invoked when the user does not have permission to view an RTTP object that has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP object that read access was denied to.
l_nAuthCode - The optional error code sent by the Liberators Auth module to provide additional information for why read access was denied. This will be undefined if a standard read deny is returned by the Auth module.

objectStale

void objectStale(<String> l_sObjectName, <String> l_sFieldName)

Invoked when the value of a field of an RTTP object that has been subscribed to is stale.

Parameters:
l_sObjectName - The name of the RTTP object that is stale.
l_sFieldName - The name of the field that is stale.

Deprecated SL4B_AbstractSubscriber.objectStatus() will be invoked instead.

objectStatus

void objectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)

Invoked when the status of an RTTP object that has been subscribed to changes (e.g. the object has become stale).

Parameters:
l_sObjectName - The object for which the field has been deleted.
l_nType - The integer type of the status message (see SL4B_ObjectStatus for possible values).
l_nCode - An integer code for the status message, user-definable on Caplin Liberator.
l_sMessage - A message string, user-definable on Caplin Liberator.

objectType

void objectType(<String> l_sObjectName, <int> l_nRttpType, <int> l_nDataSourceType)

Invoked when an update for the type of an RTTP object that has been subscribed to is received.

Parameters:
l_sObjectName - The name of the RTTP object that the type applies to.
l_nRttpType - The RTTP type of the object. The SL4B_ObjectType singleton defines the possible values.
l_nDataSourceType - A sub type for the object defined by its DataSource.

objectUnavailable

void objectUnavailable(<String> l_sObjectName)

Invoked when an RTTP object that has been subscribed to is unavailable from the Liberator. This will occur if the specified object cannot be found in the Liberators cache, nor from any of the connected DataSources, however at least one of the DataSources is currently disconnected.

Parameters:
l_sObjectName - The name of the RTTP object that was unavailable.

objectUpdated

void objectUpdated(<String> l_sObjectName)

Invoked when a generic object update is received for an RTTP object that has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP object that the update applies to.

objectWriteDenied

void objectWriteDenied(<String> l_sObjectName, <int> l_nAuthCode)

Invoked when the user does not have permission to contribute (write) data to an RTTP object that has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP object that write access was denied to.
l_nAuthCode - The optional error code sent by the Liberators Auth module to provide additional information for why write access was denied. This will be undefined if a standard write deny is returned by the Auth module.

pageUpdated

void pageUpdated(<String> l_sObjectName, <int> l_nColumn, <int> l_nRow, <String> l_sPageData, <int> l_nUpdate)

Invoked when a update is received for an RTTP page object that has been subscribed to. The update will be a section of text that should replace the text at the specified column and row position within the current page.

Parameters:
l_sObjectName - The name of the RTTP page object.
l_nColumn - The column number that the update starts at.
l_nRow - The row number that the update applies to.
l_sPageData - The updated page text that should replace the text at the specified column and row position.
l_nUpdate - An generic parameter specified by some DataSources.

permissionDeleted

void permissionDeleted(<String> l_sObjectName, <String> l_sKeyName)

Invoked when either a delete entry or a clear all entries message is received for an RTTP permission object that has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP permission object that has had a modified.
l_sKeyName - The name of the permission key that the deletion applies to, or null if all the permissions for the specified object have been cleared.

permissionUpdated

void permissionUpdated(<String> l_sObjectName, <String> l_sKeyName, <SL4B_RecordFieldData> l_oFieldData)

Invoked when an upate is received for an RTTP permission object that has been subscribed to. Each permission object can contain multiple permissions which are indexed via a key.

Parameters:
l_sObjectName - The name of the RTTP permission object that has updated.
l_sKeyName - The name of the permission key that the update applies to.
l_oFieldData - The field name/value pair data associated with the permission update.

ready

void ready()

Invoked once the SL4B_AbstractRttpProvider has successfully logged into a Liberator. If the SL4B_AbstractSubscriber was instantiated after the RTTP provider has logged in, this method will be invoked immediately.

Once this method has been invoked, this subscriber can be used to subscribe to RTTP object updates with the Liberator (e.g. by invoking SL4B_AbstractRttpProvider.getObject() method). If this method has not been invoked, then there is no guarantee that a subscripition will be successful.

recordMultiUpdated

void recordMultiUpdated(<String> l_sObjectName, <SL4B_RecordFieldData> l_oFieldData, l_bIsCachedImage)

Invoked when a several field updates occur at the same time for an RTTP record object that has been subscribed to. This allows certain fields to be associated with a single transaction, such as a trade, where, for example, the trade price, trade volume and trade time may all need to be known.

The default implementation of this method is to loop through all of the fields and invoke the SL4B_AbstractSubscriber.recordUpdated() method for each one.

Parameters:
l_sObjectName - The name of the RTTP record object.
l_oFieldData - A collection of all the field name/value pairs that have updated.
l_bIsCachedImage - {boolean} true if the update represents a cached Image, otherwise false if this is a update.

recordUpdated

void recordUpdated(<String> l_sObjectName, <String> l_sFieldName, <String> l_sValue)

Invoked when a field is updated for an RTTP record object that has been subscribed to.

Parameters:
l_sObjectName - The name of the RTTP record object.
l_sFieldName - The name of the field that has updated.
l_sValue - The new value for the field.

storyReset

void storyReset(<String> l_sObjectName)

Invoked when a reset message is received for an RTTP news story object that has been subscribed to. This means that the text that has been received for the story is out of date and can be deleted.

Parameters:
l_sObjectName - The name of the RTTP news story object.

storyUpdated

void storyUpdated(<String> l_sObjectName, <String> l_sStoryText)

Invoked when an update is received for an RTTP news story object that has been subscribed to. It is likely that the full text for a story will be sent over a series of these updates.

Parameters:
l_sObjectName - The name of the RTTP news story object.
l_sStoryText - The text for the story.

structureChange

void structureChange(<String> l_sContainerName, <String> l_sObjectName, <String> l_sObjectType, <boolean> l_bAdded)

Invoked when the structure of a container or auto directory changes.

This callback has been deprecated for containers (but not for auto directories) where SL4B_AbstractSubscriber.structureMultiChange() should be used instead.

Parameters:
l_sContainerName - The name of the container (or auto directory) subscribed to.
l_sObjectName - The name of the object that has changed (been added/removed).
l_sObjectType - The type of the RTTP object. The SL4B_ObjectType singleton defines the possible values.
l_bAdded - true if object was added, false if removed.

structureMultiChange

void structureMultiChange(<String> l_sContainerName, <Array> l_pContainerStructureChanges, <Array> l_pOrderChanges, <int> l_nContainerSize)

Invoked when the structure of a container changes, returns multiple structure changes plus ordering and size information. Please see the Container Object section of the documentation for more information.

This callback should be used in preference to structureChange() for containers.

Parameters:
l_sContainerName - The name of the container subscribed to.
l_pContainerStructureChanges - An array of SL4B_ContainerStructureChange objects.
l_pOrderChanges - An array of SL4B_ContainerOrderChange objects.
l_nContainerSize - The new size of the container.

type2Clear

void type2Clear(<String> l_sObjectName)

Invoked when a type 2 clear update is received for a RTTP record object which has been subscribed to. This method will only be called if the field that is deleted was subscribed to.

Parameters:
l_sObjectName - The name of the RTTP record object that the field was cleared

type3Clear

void type3Clear(<String> l_sObjectName)

Invoked when a type 3 clear update is received for a RTTP record object which has been subscribed to. This method will only be called if the field that is deleted was subscribed to.

Parameters:
l_sObjectName - The name of the RTTP record object that the field was cleared

WTObjectStatus

void WTObjectStatus(<String> l_sObjectName, <int> l_nType, <int> l_nCode, <String> l_sMessage)

Invoked when the status of an RTTP object that has been subscribed to changes. This method proxies the call onto SL4B_AbstractSubscriber.objectStatus() on a timeout (using the C_CallbackQueue singleton).

Parameters:
l_sObjectName - The name of the RTTP object that has changed state.
l_nType - An integer type representing the new state of the object. See SL4B_ObjectStatus for the possible values.
l_nCode - An integer code for the status message, user-definable on the Liberator.
l_sMessage - A brief description of the objects new state.