Unsubscribing After N Messages

NATS provides a special form of unsubscribe that is configured with a message count and takes effect when that many messages are sent to a subscriber. This mechanism is very useful if only a single message is expected.

The message count you provide is the total message count for a subscriber. So if you unsubscribe with a count of 1, the server will stop sending messages to that subscription after it has received one message. If the subscriber has already received one or more messages, the unsubscribe will be immediate. This action based on history can be confusing if you try to auto-unsubscribe on a long running subscription, but is logical for a new one.

Auto-unsubscribe is based on the total messages sent to a subscriber, not just the new ones. Most of the client libraries also track the max message count after an auto-unsubscribe request. On reconnect, this enables clients to resend the unsubscribe with an updated total.

The following example shows unsubscribe after a single message:

Go

  1. nc, err := nats.Connect("demo.nats.io")
  2. if err != nil {
  3.     log.Fatal(err)
  4. }
  5. defer nc.Close()
  7. // Sync Subscription
  8. sub, err := nc.SubscribeSync("updates")
  9. if err != nil {
  10.     log.Fatal(err)
  11. }
  12. if err := sub.AutoUnsubscribe(1); err != nil {
  13.     log.Fatal(err)
  14. }
  16. // Async Subscription
  17. sub, err = nc.Subscribe("updates", func(_ *nats.Msg) {})
  18. if err != nil {
  19.     log.Fatal(err)
  20. }
  21. if err := sub.AutoUnsubscribe(1); err != nil {
  22.     log.Fatal(err)
  23. }

Java

  1. Connection nc = Nats.connect("nats://demo.nats.io:4222");
  2. Dispatcher d = nc.createDispatcher((msg) -> {
  3.     String str = new String(msg.getData(), StandardCharsets.UTF_8);
  4.     System.out.println(str);
  5. });
  7. // Sync Subscription
  8. Subscription sub = nc.subscribe("updates");
  9. sub.unsubscribe(1);
  11. // Async Subscription
  12. d.subscribe("updates");
  13. d.unsubscribe("updates", 1);
  15. // Close the connection
  16. nc.close();

JavaScript

  1. const sc = StringCodec();
  2. // `max` specifies the number of messages that the server will forward.
  3. // The server will auto-cancel.
  4. const subj = createInbox();
  5. const sub1 = nc.subscribe(subj, {
  6.   callback: (_err, msg) => {
  7.     t.log(`sub1 ${sc.decode(msg.data)}`);
  8.   },
  9.   max: 10,
  10. });
  12. // another way after 10 messages
  13. const sub2 = nc.subscribe(subj, {
  14.   callback: (_err, msg) => {
  15.     t.log(`sub2 ${sc.decode(msg.data)}`);
  16.   },
  17. });
  18. // if the subscription already received 10 messages, the handler
  19. // won't get any more messages
  20. sub2.unsubscribe(10);

Python

  1. nc = NATS()
  3. await nc.connect(servers=["nats://demo.nats.io:4222"])
  5. async def cb(msg):
  6.   print(msg)
  8. sid = await nc.subscribe("updates", cb=cb)
  9. await nc.auto_unsubscribe(sid, 1)
  10. await nc.publish("updates", b'All is Well')
  12. # Won't be received...
  13. await nc.publish("updates", b'...')

Ruby

  1. require 'nats/client'
  2. require 'fiber'
  4. NATS.start(servers:["nats://127.0.0.1:4222"]) do |nc|
  5.   Fiber.new do
  6.     f = Fiber.current
  8.     nc.subscribe("time", max: 1) do |msg, reply|
  9.       f.resume Time.now
  10.     end
  12.     nc.publish("time", 'What is the time?', NATS.create_inbox)
  14.     # Use the response
  15.     msg = Fiber.yield
  16.     puts "Reply: #{msg}"
  18.     # Won't be received
  19.     nc.publish("time", 'What is the time?', NATS.create_inbox)
  21.   end.resume
  22. end

C

  1. natsConnection      *conn      = NULL;
  2. natsSubscription    *sub       = NULL;
  3. natsMsg             *msg       = NULL;
  4. natsStatus          s          = NATS_OK;
  6. s = natsConnection_ConnectTo(&conn, NATS_DEFAULT_URL);
  8. // Subscribe
  9. if (s == NATS_OK)
  10.     s = natsConnection_SubscribeSync(&sub, conn, "updates");
  12. // Unsubscribe after 1 message is received
  13. if (s == NATS_OK)
  14.     s = natsSubscription_AutoUnsubscribe(sub, 1);
  16. // Wait for messages
  17. if (s == NATS_OK)
  18.     s = natsSubscription_NextMsg(&msg, sub, 10000);
  20. if (s == NATS_OK)
  21. {
  22.     printf("Received msg: %s - %.*s\n",
  23.             natsMsg_GetSubject(msg),
  24.             natsMsg_GetDataLength(msg),
  25.             natsMsg_GetData(msg));
  27.     // Destroy message that was received
  28.     natsMsg_Destroy(msg);
  29. }
  31. (...)
  33. // Destroy objects that were created
  34. natsSubscription_Destroy(sub);
  35. natsConnection_Destroy(conn);

{% endtabs %}