Work with producer

After setting up your clients, you can explore more to start working with producers.

Create the producer

This example shows how to create a producer.

• Java
• C++

Producer<String> producer = pulsarClient.newProducer(Schema.STRING)
              .topic("my-topic")
              .create();

Producer producer;
Result result = client.createProducer("my-topic", producer);

Send messages

This example shows how to send messages using producers.

• Java
• C++
• Go
• Node.js
• C#

producer.newMessage()
       .key("my-message-key")
       .value("my-sync-message")
       .send();

You can terminate the builder chain with sendAsync() and get a future return.

Message msg = MessageBuilder()
                    .setContent("content")
                    .setPartitionKey("my-message-key")
                    .build();
Result res = producer.send(msg);

 msg := pulsar.ProducerMessage{
     Payload: []byte("Here is some message data"),
     Key: "message-key",
     Properties: map[string]string{
         "foo": "bar",
     },
     EventTime: time.Now(),
     ReplicationClusters: []string{"cluster1", "cluster3"},
 }
 if _, err := producer.send(msg); err != nil {
   log.Fatalf("Could not publish message due to: %v", err)
 }

For all methods of the `ProducerMessage` object, see [here](https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#ProducerMessage).

const msg = {
data: Buffer.from('Hello, Pulsar'),
partitionKey: 'key1',
properties: {
    'foo': 'bar',
},
eventTimestamp: Date.now(),
replicationClusters: [
    'cluster1',
    'cluster2',
],
}
await producer.send(msg);

The following keys are available for producer message objects:

Message object operations

In Pulsar Node.js client, you can receive (or read) message objects as consumers (or readers).

The message object has the following methods available:

Message ID object operations

In Pulsar Node.js client, you can get message id objects from message objects.

The message id object has the following methods available:

The client has a static method of message id object. You can access it as Pulsar.MessageId.someStaticMethod.

The following static methods are available for the message id object:

var data = Encoding.UTF8.GetBytes("Hello World");
await producer.Send(data);

Send messages with customized metadata

• Send messages with customized metadata by using the builder.

  • Java
  • C++
  • C#

  producer.newMessage()
          .value("my-sync-message")
          .property("my-key", "my-value")
          .property("my-other-key", "my-other-value")
          .send();

  Message msg = MessageBuilder()
                    .setContent("content")
                    .setProperty("my-key", "my-value")
                    .setProperty("my-other-key", "my-other-value")
                    .build();
  Result res = producer.send(msg);

  var messageId = await producer.NewMessage()
                              .Property("SomeKey", "SomeValue")
                              .Send(data);

Async send messages

You can publish messages asynchronously using the Java client. With async send, the producer puts the message in a blocking queue and returns it immediately. Then the client library sends the message to the broker in the background. If the queue is full (max size configurable), the producer is blocked or fails immediately when calling the API, depending on arguments passed to the producer.

The following is an example.

• Java
• C++

producer.sendAsync("my-async-message".getBytes()).thenAccept(msgId -> {
    System.out.println("Message with ID " + msgId + " successfully sent");
});

Message msg = MessageBuilder()
                  .setContent("content")
                  .build();
producer.sendAsync(msg, [](Result result, MessageId messageId) {
    std::cout << "Result: " << result << "; Message ID:" << messageId;
});

As you can see from the example above, async send operations return a MessageId wrapped in a CompletableFuture.

Publish messages to partitioned topics

By default, Pulsar topics are served by a single broker, which limits the maximum throughput of a topic. Partitioned topics can span multiple brokers and thus allow for higher throughput.

You can publish messages to partitioned topics using Pulsar client libraries. When publishing messages to partitioned topics, you must specify a routing mode. If you do not specify any routing mode when you create a new producer, the round-robin routing mode is used.

Use built-in message router

You can specify the routing mode in the ProducerConfiguration object to configure your producer. The routing mode determines which partition (internal topic) each message should be published to.

The following is an example:

• Java
• C++
• Go

String pulsarBrokerRootUrl = "pulsar://localhost:6650";
String topic = "persistent://my-tenant/my-namespace/my-topic";
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl(pulsarBrokerRootUrl).build();
Producer<byte[]> producer = pulsarClient.newProducer()
   .topic(topic)
   .messageRoutingMode(MessageRoutingMode.SinglePartition)
   .create();
producer.send("Partitioned topic message".getBytes());

#include "lib/RoundRobinMessageRouter.h" // Make sure include this header file
 Producer producer;
 Result result = client.createProducer(
     "persistent://public/default/my-topic",
     ProducerConfiguration().setMessageRouter(std::make_shared<RoundRobinMessageRouter>(
         ProducerConfiguration::BoostHash, true, 1000, 100000, boost::posix_time::seconds(1))),
     producer);

 client, err := pulsar.NewClient(pulsar.ClientOptions{
     URL: "pulsar://localhost:6650",
 })
 if err != nil {
     log.Fatal(err)
 }
 defer client.Close()
 producer, err := client.CreateProducer(pulsar.ProducerOptions{
     Topic: "my-partitioned-topic",
     MessageRouter: func(msg *pulsar.ProducerMessage, tm pulsar.TopicMetadata) int {
         fmt.Println("Topic has", tm.NumPartitions(), "partitions. Routing message ", msg, " to partition 2.")
         // always push msg to partition 2
         return 2
     },
 })
 if err != nil {
     log.Fatal(err)
 }
 defer producer.Close()
 for i := 0; i < 10; i++ {
     if msgId, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
         Payload: []byte(fmt.Sprintf("message-%d", i)),
     }); err != nil {
         log.Fatal(err)
     } else {
         log.Println("Published message: ", msgId)
     }
 }
 // subscribe a specific partition of a topic
 // for demos only, not recommend to subscribe a specific partition
 consumer, err := client.Subscribe(pulsar.ConsumerOptions{
     // pulsar partition is a special topic has the suffix '-partition-xx'
     Topic:            "my-partitioned-topic-partition-2",
     SubscriptionName: "my-sub",
     Type:             pulsar.Shared,
 })
 if err != nil {
     log.Fatal(err)
 }
 defer consumer.Close()
 for i := 0; i < 10; i++ {
     msg, err := consumer.Receive(context.Background())
     if err != nil {
         log.Fatal(err)
     }
     fmt.Printf("Received message msgId: %#v -- content: '%s'\n", msg.ID(), string(msg.Payload()))
     consumer.Ack(msg)
 }

Customize message router

• Java
• C++

To use a custom message router, you need to provide an implementation of the MessageRouter interface, which has just one choosePartition method:

public interface MessageRouter extends Serializable {
    int choosePartition(Message msg);
}

To use a custom message router, you need to provide an implementation of the `MessageRoutingPolicy interface, which has just one getPartition` method:

class MessageRouter : public MessageRoutingPolicy {
   public:
    MessageRouter() : {}
    int getPartition(const Message& msg, const TopicMetadata& topicMetadata) {
        // The implementation of getPartition
    }
};

The following router routes every message to partition 10:

• Java
• C++

public class AlwaysTenRouter implements MessageRouter {
    public int choosePartition(Message msg) {
        return 10;
    }
}

class MessageRouter : public MessageRoutingPolicy {
   public:
    MessageRouter() {}
    int getPartition(const Message& msg, const TopicMetadata& topicMetadata) {
        return 10;
    }
};

With that implementation, you can send messages to partitioned topics as below.

• Java
• C++

String pulsarBrokerRootUrl = "pulsar://localhost:6650";
String topic = "persistent://my-tenant/my-cluster-my-namespace/my-topic";
PulsarClient pulsarClient = PulsarClient.builder().serviceUrl(pulsarBrokerRootUrl).build();
Producer<byte[]> producer = pulsarClient.newProducer()
        .topic(topic)
        .messageRouter(new AlwaysTenRouter())
        .create();
producer.send("Partitioned topic message".getBytes());

Producer producer;
Result result = client.createProducer(
    "persistent://public/default/my-topic",
    ProducerConfiguration().setMessageRouter(std::make_shared<MessageRouter>()),
    producer);
Message msg = MessageBuilder().setContent("content").build();
result = producer.send(msg);

Choose partitions when using a key

If a message has a key, it supersedes the round robin routing policy. The following java example code illustrates how to choose the partition when using a key.

// If the message has a key, it supersedes the round robin routing policy
        if (msg.hasKey()) {
            return signSafeMod(hash.makeHash(msg.getKey()), topicMetadata.numPartitions());
        }
        if (isBatchingEnabled) { // if batching is enabled, choose partition on `partitionSwitchMs` boundary.
            long currentMs = clock.millis();
            return signSafeMod(currentMs / partitionSwitchMs + startPtnIdx, topicMetadata.numPartitions());
        } else {
            return signSafeMod(PARTITION_INDEX_UPDATER.getAndIncrement(this), topicMetadata.numPartitions());
        }

Enable chunking

Message chunking enables Pulsar to process large payload messages by splitting the message into chunks at the producer side and aggregating chunked messages on the consumer side.

The message chunking feature is OFF by default. The following is an example of how to enable message chunking when creating a producer.

• Java
• C++
• Go
• Python

  Producer<byte[]> producer = client.newProducer()
     .topic(topic)
     .enableChunking(true)
     .enableBatching(false)
     .create();

ProducerConfiguration conf;
conf.setBatchingEnabled(false);
conf.setChunkingEnabled(true);
Producer producer;
client.createProducer("my-topic", conf, producer);

client, err := pulsar.NewClient(pulsar.ClientOptions{
    URL: serviceURL,
})
if err != nil {
       log.Fatal(err)
}
defer client.Close()
// The message chunking feature is OFF by default.
// By default, a producer chunks the large message based on the max message size (`maxMessageSize`) configured at the broker side (for example, 5MB).
// Client can also configure the max chunked size using the producer configuration `ChunkMaxMessageSize`.
// Note: to enable chunking, you need to disable batching (`DisableBatching=true`) concurrently.
producer, err := client.CreateProducer(pulsar.ProducerOptions{
  Topic:               "my-topic",
  DisableBatching:     true,
  EnableChunking:      true,
})
if err != nil {
    log.Fatal(err)
}
defer producer.Close()

producer = client.create_producer(
         topic,
         chunking_enabled=True
     )

By default, producer chunks the large message based on max message size (maxMessageSize) configured at broker (eg: 5MB). However, client can also configure max chunked size using producer configuration chunkMaxMessageSize.

note

To enable chunking, you need to disable batching (enableBatching\=false) concurrently.

Configure delayed message delivery

The following is an example of how to configure delayed message delivery for a producer.

• Java
• C++
• Go

// message to be delivered at the configured delay interval
producer.newMessage().deliverAfter(3L, TimeUnit.Minute).value("Hello Pulsar!").send();

Message msg = MessageBuilder().setContent("content")
                   .setDeliverAfter(std::chrono::minutes(3))
                   .build();
producer.send(msg);

client, err := pulsar.NewClient(pulsar.ClientOptions{
    URL: "pulsar://localhost:6650",
})
if err != nil {
    log.Fatal(err)
}
defer client.Close()
topicName := "topic-1"
producer, err := client.CreateProducer(pulsar.ProducerOptions{
    Topic:           topicName,
    DisableBatching: true,
})
if err != nil {
    log.Fatal(err)
}
defer producer.Close()
consumer, err := client.Subscribe(pulsar.ConsumerOptions{
    Topic:            topicName,
    SubscriptionName: "subName",
    Type:             pulsar.Shared,
})
if err != nil {
    log.Fatal(err)
}
defer consumer.Close()
ID, err := producer.Send(context.Background(), &pulsar.ProducerMessage{
    Payload:      []byte(fmt.Sprintf("test")),
    DeliverAfter: 3 * time.Second,
})
if err != nil {
    log.Fatal(err)
}
fmt.Println(ID)
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
msg, err := consumer.Receive(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(msg.Payload())
cancel()
ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
msg, err = consumer.Receive(ctx)
if err != nil {
    log.Fatal(err)
}
fmt.Println(msg.Payload())
cancel()

Intercept messages

ProducerInterceptor intercepts and possibly mutates messages received by the producer before they are published to the brokers.

The interface has three main events:

• eligible checks if the interceptor can be applied to the message.
• beforeSend is triggered before the producer sends the message to the broker. You can modify messages within this event.
• onSendAcknowledgement is triggered when the message is acknowledged by the broker or the sending failed.

To intercept messages, you can add a ProducerInterceptor or multiple ones when creating a Producer as follows.

• Java
• C++

Producer<byte[]> producer = client.newProducer()
     .topic(topic)
     .intercept(new ProducerInterceptor {
            @Override
            boolean eligible(Message message) {
                return true;  // process all messages
            }
            @Override
            Message beforeSend(Producer producer, Message message) {
                // user-defined processing logic
            }
            @Override
            void onSendAcknowledgement(Producer producer, Message message, MessageId msgId, Throwable exception) {
                // user-defined processing logic
            }
     })
     .create();

Implement the custom interceptor:

 class MyInterceptor : public ProducerInterceptor {
   public:
     MyInterceptor() {}
     Message beforeSend(const Producer& producer, const Message& message) override {
       // Your implementation code
       return message;
     }
     void onSendAcknowledgement(const Producer& producer, Result result, const Message& message,
                               const MessageId& messageID) override {
       // Your implementation code
     }
     void close() override { 
       // Your implementation code
     }
 };

Configue the producer:

 ProducerConfiguration conf;
 conf.intercept({std::make_shared<MyInterceptor>(),
                 std::make_shared<MyInterceptor>()}); // You can add multiple interceptors to the same producer
 Producer producer;
 client.createProducer(topic, conf, producer);

note

Multiple interceptors apply in the order they are passed to the intercept method.

Configure encryption policies

The Pulsar C# client supports four kinds of encryption policies:

• EnforceUnencrypted: always use unencrypted connections.
• EnforceEncrypted: always use encrypted connections)
• PreferUnencrypted: use unencrypted connections, if possible.
• PreferEncrypted: use encrypted connections, if possible.

This example shows how to set the EnforceUnencrypted encryption policy.

• C#

using DotPulsar;
var client = PulsarClient.Builder()
                      .ConnectionSecurity(EncryptionPolicy.EnforceEncrypted)
                      .Build();

Configure access mode

Access mode allows applications to require exclusive producer access on a topic to achieve a “single-writer” situation.

This example shows how to set producer access mode.

• Java
• C++

note

This feature is supported in Java client 2.8.0 or later versions.

Producer<byte[]> producer = client.newProducer()
     .topic(topic)
     .accessMode(ProducerAccessMode.Exclusive)
     .create();

note

This feature is supported in C++ client 3.1.0 or later versions.

 Producer producer;
 ProducerConfiguration producerConfiguration;
 producerConfiguration.setAccessMode(ProducerConfiguration::Exclusive);
 client.createProducer(topicName, producerConfiguration, producer);