Package io.nats.client

The Java NATS client is encapsulated into this single package io.nats.client.

See: Description

Interface Summary

Interface	Description
AuthHandler	NATS provides a challenge-response based authentication scheme based on NKeys.
Connection	The Connection class is at the heart of the NATS Java client.
ConnectionListener	Applications can use a ConnectionListener to track the status of a Connection.
Consumer	A Consumer in the NATS library is an object that represents an incoming queue of messages.
Dispatcher	This library uses the concept of a Dispatcher to organize message callbacks in a way that the application can control.
ErrorListener	This library groups problems into three categories: Errors The server sent an error message using the -err protocol operation. Exceptions A Java exception occurred, and was handled by the library. Slow Consumers One of the connections consumers, Subscription or Dispatcher, is slow, and starting to drop messages.
Message	The NATS library uses a Message object to encapsulate incoming messages.
MessageHandler	Dispatchers use the MessageHandler interface to define the listener for their messages.
Statistics	Connections can provide an instance of Statistics, getStatistics().
Subscription	A Subscription encapsulates an incoming queue of messages associated with a single subject and optional queue name.

Class Summary

Class	Description
Nats	The Nats class is the entry point into the NATS client for Java.
NKey	The NATS ecosystem will be moving to Ed25519 keys for identity, authentication and authorization for entities such as Accounts, Users, Servers and Clusters.
NUID	A highly performant unique identifier generator.
Options	The Options class specifies the connection options for a new NATs connection, including the default options.
Options.Builder	Options are created using a Builder.

Enum Summary

Enum	Description
Connection.Status
ConnectionListener.Events
NKey.Type	NKeys use a prefix byte to indicate their intended owner: 'N' = server, 'C' = cluster, 'A' = account, and 'U' = user.

Exception Summary

Exception	Description
AuthenticationException	AuthenticationException is used when the connect process fails due to an authentication problem.

Package io.nats.client Description

The Java NATS client is encapsulated into this single package io.nats.client. Applications will start from the Nats class to connect to the NATS server. Once connected, they can use the Connection object to publish messages or create subscriptions.

Since:

2.0.0