Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 2.25 KB

File metadata and controls

65 lines (50 loc) · 2.25 KB

Buffering Messages During Reconnect Attempts

The NATS client libraries try as much as possible to be fire and forget. One of the features that may be included in the library you are using is the ability to buffer outgoing messages when the connection is down.

During a short reconnect, the client can allow applications to publish messages that, because the server is offline, will be cached in the client. The library will then send those messages once reconnected. When the maximum reconnect buffer is reached, messages will no longer be publishable by the client and an error will be returned.

Be aware, while the message appears to be sent to the application it is possible that it is never sent because the connection is never remade. Your applications should use patterns like acknowledgements to ensure delivery.

For clients that support this feature, you are able to configure the size of this buffer with bytes, messages or both.

{% tabs %} {% tab title="Go" %}

// Set reconnect buffer size in bytes (5 MB)
nc, err := nats.Connect("demo.nats.io", nats.ReconnectBufSize(5*1024*1024))
if err != nil {
    log.Fatal(err)
}
defer nc.Close()

// Do something with the connection

{% endtab %}

{% tab title="Java" %}

Options options = new Options.Builder().
                            server("nats://demo.nats.io:4222").
                            reconnectBufferSize(5 * 1024 * 1024).  // Set buffer in bytes
                            build();
Connection nc = Nats.connect(options);

// Do something with the connection

nc.close();

{% endtab %}

{% tab title="JavaScript" %}

// Reconnect buffer size is not configurable on NATS Javascript client

{% endtab %}

{% tab title="Python" %}

# Asyncio NATS client currently does not implement a reconnect buffer

{% endtab %}

{% tab title="Ruby" %}

# There is currently no reconnect pending buffer as part of the Ruby NATS client

{% endtab %}

{% tab title="TypeScript" %}

// Reconnect buffer size is not configurable on NATS Typescript client

{% endtab %} {% endtabs %}

As mentioned throughout this document, each client library may behave slightly differently. Please check the documentation for the library you are using.