Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler Interface Reference

A paged topic handler. More...

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

Public Member Functions

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...
 

Detailed Description

A paged topic handler.

This is an object which is used to send notifications to a 'paged' topic - see IPagedTopicData. The handler simplifies the use of such a topic and avoids having to format messages to send to the topic or parse messages received from it.

Such a handler is created using ExternalClient.CreatePagedTopicHandler( ITopicMessage, IPagedTopicListener ) and all notifications from the topic will be routed through the supplied listener.

When such a handler is in use then messages received on the topic will not be delivered to the IServerConnectionListener declared to the ExternalClient object.

Member Function Documentation

void PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.Close ( )

Close the paged topic.

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

Implemented in PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.

void PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.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.

Implemented in PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.

void PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.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

Implemented in PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.

void PushTechnology.DiffusionCore.Connection.Connectors.ExternalClient.Paging.IPagedTopicHandler.Page ( int  number)

Requests a page by absolute number.

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

Implemented in PushTechnology.DiffusionCore.Messaging.Data.Paging.PagedTopicHandlerImpl.