 |
Diffusion .NET API
5.9.24
|
|
Diffusion .NET API
5.9.24
|
Update factory for ordered TopicType.PAGED_RECORD topics. More...
Public Member Functions | |
| IUpdate | Add (IRecord line) |
| Create an update that will add a line to the paged topic. More... | |
| IUpdate | Update (IRecord line) |
| Create an update that will update a line within the paged topic. More... | |
| IUpdate | Remove (IRecord line) |
| Create an update that will remove a line of data from the paged topic. More... | |
 Public Member Functions inherited from PushTechnology.ClientInterface.Client.Topics.Update.IPagedUpdateFactory | |
| IUpdate | RemoveAll () |
| Create an update which removes all lines from the paged topic. More... | |
Update factory for ordered TopicType.PAGED_RECORD topics.
Instances of this factory can be obtained from the ITopicUpdateControl feature using ITopicUpdateControl.UpdateFactory{TF}, for example:
var updateControl = session.GetTopicUpdateControlFeature(); var factory = updateControl.UpdateFactory<IPagedRecordOrderedUpdateFactory>();
Deprecated since 5.9.
| IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordOrderedUpdateFactory.Add | ( | IRecord | line | ) |
Create an update that will add a line to the paged topic.
The line will be added at the position indicated by the IPagedRecordOrderingPolicy policy of the topic. Duplicates will be handled according to the PagedTopicDuplicates policy indicated for the topic.
| line | The line to add. |
| IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordOrderedUpdateFactory.Remove | ( | IRecord | line | ) |
Create an update that will remove a line of data from the paged topic.
The IPagedRecordOrderingPolicy policy is used to locate a line that matches the specified line and that line is then removed and all interested clients are notified. If no match is found then no action occurs. If there is more than one line that matches then the line removed would depend upon the PagedTopicDuplicates policy.
Only as much data as is needed to match a line according to its ordering policy is needed to locate a line for removal. For example, if the policy only orders on the first field of the record then that is the only field that will be used when locating the line to remove.
| line | The line to remove. |
| IUpdate PushTechnology.ClientInterface.Client.Topics.Update.IPagedRecordOrderedUpdateFactory.Update | ( | IRecord | line | ) |
Create an update that will update a line within the paged topic.
An update will involve removing a line that matches the supplied line according to the IPagedRecordOrderingPolicy and then adding the new line. Each update will result in all interested clients being notified of the change.
Where there is more than one line that matches then the match would be made according to the PagedTopicDuplicates policy. If there is no line that matches the new line then the result would be the same as for a simple add.
| line | The line of data to use for update. |
1.8.5 
