org.apache.hedwig.client.api

Interface Publisher

public interface Publisher

Interface to define the client Publisher API.

Method Summary

Methods

Modifier and Type	Method and Description
void	asyncPublish(com.google.protobuf.ByteString topic, PubSubProtocol.Message msg, Callback<Void> callback, Object context) Publishes a message asynchronously on the given topic.
void	asyncPublishWithResponse(com.google.protobuf.ByteString topic, PubSubProtocol.Message msg, Callback<PubSubProtocol.PublishResponse> callback, Object context) Publishes a message asynchronously on the given topic.
PubSubProtocol.PublishResponse	publish(com.google.protobuf.ByteString topic, PubSubProtocol.Message msg) Publishes a message on the given topic.

Method Detail

publish

PubSubProtocol.PublishResponse publish(com.google.protobuf.ByteString topic,
                                     PubSubProtocol.Message msg)
                                       throws PubSubException.CouldNotConnectException,
                                              PubSubException.ServiceDownException

Publishes a message on the given topic.

Parameters:

topic - Topic name to publish on

msg - Message object to serialize and publish

Returns:

The PubSubProtocol.PublishResponse of the publish ... can be used to pick seq-id.

Throws:

PubSubException.CouldNotConnectException - If we are not able to connect to the server host

PubSubException.ServiceDownException - If we are unable to publish the message to the topic.

asyncPublish

void asyncPublish(com.google.protobuf.ByteString topic,
                PubSubProtocol.Message msg,
                Callback<Void> callback,
                Object context)

Publishes a message asynchronously on the given topic.

Parameters:

topic - Topic name to publish on

msg - Message object to serialize and publish

callback - Callback to invoke when the publish to the server has actually gone through. This will have to deal with error conditions on the async publish request.

context - Calling context that the Callback needs since this is done asynchronously.

asyncPublishWithResponse

void asyncPublishWithResponse(com.google.protobuf.ByteString topic,
                            PubSubProtocol.Message msg,
                            Callback<PubSubProtocol.PublishResponse> callback,
                            Object context)

Publishes a message asynchronously on the given topic. This method, unlike asyncPublish(ByteString, PubSubProtocol.Message, Callback, Object), allows for the callback to retrieve PubSubProtocol.PublishResponse which was returned by the server.

Parameters:

topic - Topic name to publish on

msg - Message object to serialize and publish

callback - Callback to invoke when the publish to the server has actually gone through. This will have to deal with error conditions on the async publish request.

context - Calling context that the Callback needs since this is done asynchronously.