Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl Class Reference

Implementation of IPagedTopicHandler. More...

Inheritance diagram for PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl:
PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler PushTechnology.DiffusionCore.Messaging.Topic.ITopicListener

Public Member Functions

 PagedTopicHandlerImpl ()
 Empty constructor. More...
 
 PagedTopicHandlerImpl (IDiffusionClientConnector client, ITopicMessage loadMessage, IPagedTopicListener listener)
 Constructor. More...
 
void Open (int linesPerPage, int openPage)
 Open the topic. More...
 
void Page (PageOption page)
 Requests a page relative to the current page. More...
 
void Page (int number)
 Requests a page by absolute number. More...
 
void Close ()
 Close the paged topic. More...
 
bool HandleTopicMessage (IMessageSource source, ITopicMessage message)
 Handles a message received from an IMessageSource. More...
 

Properties

IDiffusionClientConnector Client [get, set]
 Get/set the client connection object. More...
 

Detailed Description

Implementation of IPagedTopicHandler.

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.PagedTopicHandlerImpl ( )

Empty constructor.

PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.PagedTopicHandlerImpl ( IDiffusionClientConnector  client,
ITopicMessage  loadMessage,
IPagedTopicListener  listener 
)

Constructor.

Parameters
client
loadMessage
listener

Member Function Documentation

void PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.Close ( )

Close the paged topic.

The topic will remain subscribed but no more notifications will be received and no requests can be sent.

Implements PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.

bool PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.HandleTopicMessage ( IMessageSource  source,
ITopicMessage  message 
)

Handles a message received from an IMessageSource.

This will handle an incoming message from a specified source.

Parameters
sourceThe message source.
messageThe message.

Implements PushTechnology.DiffusionCore.Messaging.Topic.ITopicListener.

void PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.Open ( int  linesPerPage,
int  openPage 
)

Open the topic.

This is used to request the initial page and then receive updates. Updates will be received until Close() is called or the topic is unsubscribed.

If the topic is already open then this may be called again to resubmit with a different number of lines if required.

Parameters
linesPerPageThe number of lines required per page. This must be a positive value.
openPageSpecifies the first page to be sent. This can be an absolute page number (from 1 to n) or -1 to indicate the current last page. The resulting page will be received on the IPagedTopicListener.Page( IPageStatus, ILines ) method of the associated listener.

Implements PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.

void PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.Page ( PageOption  page)

Requests a page relative to the current page.

The resulting page will be received on the IPagedTopicListener.Page( IPageStatus, ILines ) method of the associated listener.

Parameters
page

Implements PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.

void PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.Page ( int  number)

Requests a page by absolute number.

Parameters
numberThe page number, or -1 to indicate the last page.

Implements PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.

Property Documentation

IDiffusionClientConnector PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.Client
getset

Get/set the client connection object.