Connection Name

Connections can be assigned a name which will appear in some of the server monitoring data. This name is not required, but is highly recommended as a friendly connection name will help in monitoring, error reporting, debugging, and testing.
Go
Java
JavaScript
Python
Ruby
TypeScript
C
Go
nc, err := nats.Connect("demo.nats.io", nats.Name("API Name Option Example"))
if err != nil {
    log.Fatal(err)
}
defer nc.Close()
​
// Do something with the connection
Java
Options options = new Options.Builder().
                            server("nats://demo.nats.io:4222").
                            connectionName("API Name Option Example"). // Set Name
                            build();
Connection nc = Nats.connect(options);
​
// Do something with the connection
​
nc.close();
JavaScript
let nc = NATS.connect({
    url: "nats://demo.nats.io:4222",
    name: "API Name Option Example"
});
nc.on('connect', (c) => {
    // Do something with the connection
    doSomething();
    // When done close it
    nc.close();
});
nc.on('error', (err) => {
    failed(err);
});
Python
nc = NATS()
await nc.connect(
    servers=["nats://demo.nats.io:4222"], 
    name="API Name Option Example")
​
# Do something with the connection
​
await nc.close()
Ruby
require 'nats/client'
​
NATS.start(servers: ["nats://demo.nats.io:4222"], name: "API Name Option Example") do |nc|
   # Do something with the connection
​
   # Close the connection
   nc.close
end
TypeScript
// will throw an exception if connection fails
let nc = await connect({
    url:"nats://demo.nats.io:4222", 
    name: "API Name Option Example"
})
// Do something with the connection
​
// Close the connection
nc.close();
C
natsConnection      *conn    = NULL;
natsOptions         *opts    = NULL;
natsStatus          s        = NATS_OK;
​
s = natsOptions_Create(&opts);
if (s == NATS_OK)
    s = natsOptions_SetName(opts, "API Name Option Example");
if (s == NATS_OK)
    s = natsConnection_Connect(&conn, opts);
​
(...)
​
// Destroy objects that were created
natsConnection_Destroy(conn);
natsOptions_Destroy(opts);
Connecting to a Cluster
Setting a Connect Timeout
Last updated 2 months ago