Package | Description |
---|---|
com.pushtechnology.diffusion.api |
The Diffusion API comprises a number of packages which provide access to
different aspects of Diffusion.
|
com.pushtechnology.diffusion.api.client |
Diffusion External Client API.
|
com.pushtechnology.diffusion.api.client.service | |
com.pushtechnology.diffusion.api.conflation | |
com.pushtechnology.diffusion.api.data |
Diffusion Topic Data API.
|
com.pushtechnology.diffusion.api.data.custom |
Diffusion Custom Topic Data API.
|
com.pushtechnology.diffusion.api.data.paging |
Diffusion Paged Topic Data API.
|
com.pushtechnology.diffusion.api.data.service |
Diffusion Service Topic Data API.
|
com.pushtechnology.diffusion.api.message | |
com.pushtechnology.diffusion.api.publisher |
Diffusion Internal Publisher API.
|
com.pushtechnology.diffusion.api.topic |
Diffusion Topics API.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
ServerConnection.createDeltaMessage(String topicName)
Deprecated.
Creates an empty delta message.
|
TopicMessage |
ServerConnection.createDeltaMessage(String topicName,
int capacity)
Deprecated.
Creates an empty delta message.
|
TopicMessage |
ServerConnection.createLoadMessage(String topicName)
Deprecated.
Creates an empty load message.
|
TopicMessage |
ServerConnection.createLoadMessage(String topicName,
int capacity)
Deprecated.
Creates an empty load message.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ServerConnection.acknowledge(TopicMessage message)
Deprecated.
Acknowledges a message that is
'Pending Acknowledgement' . |
PagedTopicHandler |
ServerConnection.createPagedTopicHandler(TopicMessage message,
PagedTopicListener listener)
Deprecated.
Creates a handler object for a 'paged' topic.
|
ServiceTopicHandler |
ServerConnection.createServiceTopicHandler(TopicMessage message,
ServiceTopicListener listener)
Deprecated.
since 5.7 service topics have been deprecated.
|
TopicNotifyTopicHandler |
ServerConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicHandler.NotificationLevel notificationLevel,
TopicNotifyTopicListener listener)
|
TopicNotifyTopicHandler |
ServerConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicListener listener)
Deprecated.
Creates a handler object for a 'Topic Notify' topic.
|
void |
ServerConnectionListener.messageFromServer(ServerConnection serverConnection,
TopicMessage message)
Deprecated.
Notification of a message from the Server.
|
void |
ServerAckListener.messageNotAcknowledged(ServerConnection serverConnection,
TopicMessage message)
Deprecated.
This is a notification of non acknowledgement of a message that required
acknowledgement by the Server.
|
boolean |
ServerConnection.send(TopicMessage message)
Deprecated.
Send a message to the server.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
ExternalClientConnection.createDeltaMessage(String topicName)
Deprecated.
|
TopicMessage |
ExternalClientConnection.createDeltaMessage(String topicName,
int capacity)
Deprecated.
|
TopicMessage |
ExternalClientConnection.createLoadMessage(String topicName)
Deprecated.
|
TopicMessage |
ExternalClientConnection.createLoadMessage(String topicName,
int capacity)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ExternalClientConnection.acknowledge(TopicMessage message)
Deprecated.
|
PagedTopicHandler |
ExternalClientConnection.createPagedTopicHandler(TopicMessage message,
PagedTopicListener listener)
Deprecated.
|
ServiceTopicHandler |
ExternalClientConnection.createServiceTopicHandler(TopicMessage message,
ServiceTopicListener listener)
Deprecated.
|
TopicNotifyTopicHandler |
ExternalClientConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicHandler.NotificationLevel level,
TopicNotifyTopicListener listener)
Deprecated.
|
TopicNotifyTopicHandler |
ExternalClientConnection.createTopicNotifyTopicHandler(TopicMessage message,
TopicNotifyTopicListener listener)
Deprecated.
|
boolean |
ExternalClientConnection.send(TopicMessage message)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
ServiceTopicResponse.getResponseMessage()
Deprecated.
Return details of the response in the form of a message containing
headers and/or data returned from the server.
|
TopicMessage |
ServiceTopicHandler.getServiceData()
Deprecated.
Returns a message containing any fixed data returned by the service on
subscription.
|
Modifier and Type | Method and Description |
---|---|
void |
ServiceTopicHandler.request(String requestType,
String requestId,
TopicMessage data)
Deprecated.
Sends a request to the service.
|
String |
ServiceTopicHandler.request(String requestType,
TopicMessage data)
Deprecated.
Sends a request to the Service.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
MessageMerger.merge(TopicMessage currentMessage,
TopicMessage newMessage)
Merges the content of two messages to produce a new message.
|
Modifier and Type | Method and Description |
---|---|
boolean |
MessageMatcher.matches(TopicMessage currentMessage,
TopicMessage newMessage)
Compares two messages to determine whether they can be conflated.
|
TopicMessage |
MessageMerger.merge(TopicMessage currentMessage,
TopicMessage newMessage)
Merges the content of two messages to produce a new message.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
PublishingTopicData.generateAckDeltaMessage(String... headers)
As
PublishingTopicData.generateDeltaMessage(String...) but generating a message that
requires acknowledgement. |
TopicMessage |
PublishingTopicData.generateDeltaMessage(String... headers)
Generates a
delta message summarising
changes to the data since updating was started (PublishingTopicData.startUpdate()
was called). |
TopicMessage |
TopicData.getLoadMessage()
This returns the current data state as a Topic Load message.
|
TopicMessage |
PublishingTopicData.getLoadMessage()
This returns the current data state as a
load message. |
TopicMessage |
TopicData.getLoadMessage(TopicClient client)
This returns the current data state as a Topic Load message.
|
Modifier and Type | Method and Description |
---|---|
void |
PublishingTopicData.initialise(TopicMessage message)
Initialises the data from a supplied message.
|
void |
PublishingTopicData.publishExclusiveMessage(TopicMessage message,
TopicClient client)
As
PublishingTopicData.publishMessage(TopicMessage) but excluding a specified
client. |
void |
PublishingTopicData.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
As
PublishingTopicData.publishExclusiveMessage(TopicMessage, TopicClient) but
allowing a message priority to be specified. |
void |
PublishingTopicData.publishMessage(TopicMessage message)
Publish a message (at
normal priority) to
all subscribed clients. |
void |
PublishingTopicData.publishMessage(TopicMessage message,
MessagePriority priority)
As
PublishingTopicData.publishMessage(TopicMessage) but allowing a message priority
to be specified. |
boolean |
PublishingTopicData.update(TopicMessage message)
Updates the data with the data from a supplied message.
|
boolean |
PublishingTopicData.updateAndPublish(TopicMessage message)
Convenience method to perform an atomic update and publish a delta
message if any changes are detected.
|
boolean |
PublishingTopicData.updateAndPublish(TopicMessage message,
MessagePriority priority)
As
PublishingTopicData.updateAndPublish(TopicMessage) but allowing a message
priority to be specified. |
void |
PublishingTopicData.updateAndPublishFromDelta(TopicMessage message)
This method allows the topic data to be updated using input that
represents only deltas of change to the topic.
|
Modifier and Type | Method and Description |
---|---|
void |
CustomTopicDataHandler.initialise(TopicMessage message)
Deprecated.
This is called if
PublishingTopicData.initialise(TopicMessage) is
used. |
void |
AbstractCustomTopicDataHandler.initialise(TopicMessage message)
Deprecated.
|
void |
CustomTopicDataHandler.populateDelta(TopicMessage delta)
Deprecated.
This is called when
PublishingTopicData.generateDeltaMessage(String...) is called to
populate a new delta message with updates done in the current block. |
void |
CustomTopicDataHandler.populateTopicLoad(TopicMessage topicLoad)
Deprecated.
This will be called to populate an empty Topic Load message with the
current state of the data.
|
boolean |
CustomTopicDataHandler.update(TopicMessage message)
Deprecated.
This will be called to update the state of the data from an incoming
delta Message.
|
boolean |
AbstractCustomTopicDataHandler.update(TopicMessage message)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
PagedStringTopicData.add(TopicMessage message)
Deprecated.
Add data from a message.
|
void |
PagedRecordTopicData.add(TopicMessage message)
Deprecated.
Adds data from a message.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
ServiceTopicData.createDeltaMessage(String... headers)
Deprecated.
Convenience method to create a delta message for the parent topic which
has the
default capacity from the owning Topic and the
delta encoding pre-applied. |
TopicMessage |
ServiceRequest.createResponseMessage(String... headers)
Deprecated.
Convenience method to create a message that can be returned in a
ServiceResponse . |
TopicMessage |
ServiceResponse.getReponseMessage()
Deprecated.
Returns the response message.
|
TopicMessage |
ServiceRequest.getRequestMessage()
Deprecated.
Returns the request message.
|
TopicMessage |
ServiceTopicData.getServiceData()
Deprecated.
Returns service data (if there is any).
|
Modifier and Type | Method and Description |
---|---|
void |
ServiceTopicData.setServiceData(TopicMessage data)
Deprecated.
Sets data that will be returned to any client that subscribed to a
service topic in it's load message.
|
Constructor and Description |
---|
ServiceResponse(ServiceRequest request,
String responseType,
TopicMessage responseMessage)
Deprecated.
Creates a response for specified request and for a specified response
type.
|
ServiceResponse(String clientId,
String requestId,
String responseType,
TopicMessage responseMessage)
Deprecated.
Creates a response for a request identified by client identifier and
request number and for a specified response type.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AttachableTopicMessage
This is the interface of a
TopicMessage that has an attachment. |
interface |
InternalTopicMessage
Internal topic message contract.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
TopicMessage.duplicate()
Creates an exact duplicate of the message.
|
TopicMessage |
MessageFilter.selectMessage(TopicMessage message)
Selects (or rejects) a Message for processing.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
MessageFilter.selectMessage(TopicMessage message)
Selects (or rejects) a Message for processing.
|
Modifier and Type | Method and Description |
---|---|
static TopicMessage |
Publishers.createDeltaMessage(String topicName)
Creates an empty delta message.
|
TopicMessage |
Publisher.createDeltaMessage(String topicName) |
static TopicMessage |
Publishers.createDeltaMessage(String topicName,
int capacity)
Creates an empty delta message.
|
TopicMessage |
Publisher.createDeltaMessage(String topicName,
int capacity) |
static TopicMessage |
Publishers.createLoadMessage(String topicName)
Creates an empty Topic Load message.
|
TopicMessage |
Publisher.createLoadMessage(String topicName) |
static TopicMessage |
Publishers.createLoadMessage(String topicName,
int capacity)
Creates an empty Topic Load message.
|
TopicMessage |
Publisher.createLoadMessage(String topicName,
int capacity) |
protected TopicMessage |
Publisher.fetchForClient(Client client,
Topic topic,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch
request to a stateless topic. This method enables a publisher
to return a reply. At future releases this capability will be
removed.
|
Modifier and Type | Method and Description |
---|---|
void |
DefaultClientListener.clientSendInvalid(Client client,
TopicMessage message) |
void |
ClientListener.clientSendInvalid(Client client,
TopicMessage message)
This is called when a client attempts to send a message to a topic that
doesn't exist, or to which it is not currently subscribed.
|
Topic |
Publisher.getTopic(TopicMessage message) |
protected void |
Publisher.messageFromClient(TopicMessage message,
Client client)
This is called when a message has been received from a client.
|
protected void |
Publisher.messageFromServer(ServerConnection serverConnection,
TopicMessage message)
Notification of a message from another Server.
|
void |
Publisher.messageNotAcknowledged(TopicMessage message,
List<TopicClient> clients) |
void |
Publisher.publishExclusiveMessage(TopicMessage message,
TopicClient client) |
void |
Publisher.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority) |
void |
Publisher.publishMessage(TopicMessage message) |
void |
Publisher.publishMessage(TopicMessage message,
MessagePriority priority) |
boolean |
Client.send(TopicMessage message,
MessagePriority priority)
Send a message to the client, specifying delivery priority.
|
boolean |
Client.sendFetchReply(TopicMessage message,
MessagePriority priority,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch request
to a stateless topic, or even a topic that does not exist.
This method enables a publisher to return a reply. At future
releases this capability will be removed.
|
Modifier and Type | Method and Description |
---|---|
TopicMessage |
Topic.createDeltaMessage()
Creates an empty delta message for the Topic.
|
TopicMessage |
Topic.createDeltaMessage(int capacity)
Creates an empty delta message for the Topic.
|
TopicMessage |
TopicProvider.createDeltaMessage(String topicName)
Creates an empty delta message.
|
TopicMessage |
TopicProvider.createDeltaMessage(String topicName,
int capacity)
Creates an empty delta message.
|
TopicMessage |
Topic.createLoadMessage()
Creates an empty Topic Load message for the Topic
|
TopicMessage |
Topic.createLoadMessage(int capacity)
Creates an empty Topic Load message for the Topic.
|
TopicMessage |
TopicProvider.createLoadMessage(String topicName)
Creates an empty Topic Load message.
|
TopicMessage |
TopicProvider.createLoadMessage(String topicName,
int capacity)
Creates an empty Topic Load message.
|
TopicMessage |
CachedTopicLoader.getTopicStateMessage(Topic topic)
Get the current state of the Topic
|
Modifier and Type | Method and Description |
---|---|
boolean |
TopicClient.acknowledge(TopicMessage message)
Acknowledges a Message that is
'Pending Acknowledgement' . |
Topic |
TopicProvider.getTopic(TopicMessage message)
Returns the Topic belonging to the provider that matches a given Message.
|
boolean |
TopicListener.handleTopicMessage(MessageSource source,
TopicMessage message)
Handles a Message received from a
MessageSource . |
void |
ClientAckListener.messageNotAcknowledged(TopicMessage message,
List<TopicClient> clients)
This is a notification of non acknowledgement of a message that required
acknowledgement by one or more Clients.
|
protected abstract void |
SimpleTopicLoader.populateMessage(TopicMessage message)
This populates a new empty Topic Load message with the topic load data.
|
void |
TopicProvider.publishExclusiveMessage(TopicMessage message,
TopicClient client)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishExclusiveMessage(TopicMessage message,
TopicClient client)
A variant of
Topic.publishMessage(TopicMessage) that publishes a
message to all but one client. |
void |
TopicProvider.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishExclusiveMessage(TopicMessage message,
TopicClient client,
MessagePriority priority)
A variant of
Topic.publishMessage(TopicMessage) that publishes a
message to all but one client and allows the message priority to be
specified. |
void |
TopicProvider.publishMessage(TopicMessage message)
Deprecated.
since 5.6.
The methods that publish messages to topics have been deprecated and will be removed in a future release. Use one of the following options instead.
|
void |
Topic.publishMessage(TopicMessage message)
Publish a message to all clients that are subscribed to the topic of the
message.
|
void |
TopicProvider.publishMessage(TopicMessage message,
MessagePriority priority)
Deprecated.
since 5.6. See
TopicProvider.publishMessage(TopicMessage) for
details. |
void |
Topic.publishMessage(TopicMessage message,
MessagePriority priority)
A variant of
Topic.publishMessage(TopicMessage) that allows the
message priority to be specified. |
boolean |
TopicClient.send(TopicMessage message)
Send a message to the client.
|
void |
ClientGroup.send(TopicMessage message)
Send a message to all clients in the group.
|
void |
ClientGroup.send(TopicMessage message,
MessagePriority priority)
Send a message to all clients in the group, specifying a delivery
priority.
|
void |
ClientGroup.sendExclusive(TopicMessage message,
TopicClient excludeClient)
Send an exclusive message, i.e.
|
void |
ClientGroup.sendExclusive(TopicMessage message,
TopicClient excludeClient,
MessagePriority priority)
Send an exclusive message, i.e.
|
boolean |
TopicClient.sendFetchReply(TopicMessage message,
List<String> headers)
Deprecated.
since 5.6. Currently a classic client can issue a fetch
request to a stateless topic, or even a topic that does not
exist. This method enables a publisher to return a reply. At
future releases this capability will be removed.
|
Copyright © 2016 Push Technology Ltd. All Rights Reserved.