nats.client

Class NatsConnector

java.lang.Object

nats.client.NatsConnector

public class NatsConnector
extends Object

Author:

Mike Heath

Constructor Summary

Constructors

Constructor and Description
NatsConnector()

Method Summary

Modifier and Type	Method and Description
NatsConnector	addConnectionStateListener(ConnectionStateListener listener) Adds a ConnectionStateListener to the client.
NatsConnector	addHost(String uri) Adds a URI to the list of URIs that will be used to connect to a Nats server by the Nats instance.
NatsConnector	addHost(URI uri) Adds a URI to the list of URIs that will be used to connect to a Nats server by the Nats instance.
NatsConnector	automaticReconnect(boolean automaticReconnect) Indicates whether a reconnect should be attempted automatically if the Nats server connection fails.
NatsConnector	calllbackExecutor(Executor executor) Specifies the executor to use for invoking callbacks such as ConnectionStateListener.onConnectionStateChange(Nats, nats.client.ConnectionStateListener.State) and MessageHandler.onMessage(Message).
Nats	connect() Creates the Nats instance and asynchronously connects to the first Nats server provided using the #addHost methods.
NatsConnector	eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup) Specifies the Netty EventLoopGroup to use for connecting to the Nats server(s).
NatsConnector	idleTimeout(long idleTimeout) Specifies the time duration the connection to the NATS server may be idle before the client closes the connection.
NatsConnector	maxFrameSize(int maxFrameSize) Specified the maximum message size that can be received by the Nats instance.
NatsConnector	pedantic(boolean pedantic) Indicates whether the server should do extra checking, mostly around properly formed subjects.
NatsConnector	pingInterval(long pingInterval) Specifies the time between sending ping requests to the Nats server.
NatsConnector	reconnectWaitTime(long time, TimeUnit unit) Specifies the amount of time to wait between connection attempts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NatsConnector

public NatsConnector()

Method Detail

addHost

public NatsConnector addHost(URI uri)

Adds a URI to the list of URIs that will be used to connect to a Nats server by the Nats instance.

Parameters:

uri - a Nats URI referencing a Nats server.

Returns:

this connector.

addHost

public NatsConnector addHost(String uri)

Adds a URI to the list of URIs that will be used to connect to a Nats server by the Nats instance.

Parameters:

uri - a Nats URI referencing a Nats server.

Returns:

this connector.

automaticReconnect

public NatsConnector automaticReconnect(boolean automaticReconnect)

Indicates whether a reconnect should be attempted automatically if the Nats server connection fails. Thsi value is true by default.

Parameters:

automaticReconnect - whether a reconnect should be attempted automatically if the Nats server connection fails.

Returns:

this connector.

eventLoopGroup

public NatsConnector eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)

Specifies the Netty EventLoopGroup to use for connecting to the Nats server(s). (optional)

Parameters:

eventLoopGroup - the Netty ChannelFactory to use for connecting to the Nats server(s)

Returns:

this connector.

pingInterval

public NatsConnector pingInterval(long pingInterval)

Specifies the time between sending ping requests to the Nats server.

Parameters:

pingInterval - the time between ping packets in milliseconds.

Returns:

this connector.

idleTimeout

public NatsConnector idleTimeout(long idleTimeout)

Specifies the time duration the connection to the NATS server may be idle before the client closes the connection.

Parameters:

idleTimeout - time duration the connection to the NATS server may be idle before the client closes the connection

Returns:

this connector.

reconnectWaitTime

public NatsConnector reconnectWaitTime(long time,
                                       TimeUnit unit)

Specifies the amount of time to wait between connection attempts. This is only used when automatic reconnect is enabled.

Parameters:

time - the amount of time to wait between connection attempts.

unit - the time unit of the time argument

Returns:

this connector.

pedantic

public NatsConnector pedantic(boolean pedantic)

Indicates whether the server should do extra checking, mostly around properly formed subjects.

Parameters:

pedantic - indicates whether the server should do extra checking, mostly around properly formed subjects

Returns:

this connector.

maxFrameSize

public NatsConnector maxFrameSize(int maxFrameSize)

Specified the maximum message size that can be received by the Nats instance. Defaults to 1MB.

Parameters:

maxFrameSize - the maximum message size that can be received by the Nats instance.

Returns:

this connector.

calllbackExecutor

public NatsConnector calllbackExecutor(Executor executor)

Specifies the executor to use for invoking callbacks such as ConnectionStateListener.onConnectionStateChange(Nats, nats.client.ConnectionStateListener.State) and MessageHandler.onMessage(Message).

Parameters:

executor - the executor to use for invoking callbacks.

Returns:

this connector.

addConnectionStateListener

public NatsConnector addConnectionStateListener(ConnectionStateListener listener)

Adds a ConnectionStateListener to the client. This allows you to be notified when a connection is established, when the server is ready to process messages, and when the connection disconnects. If the connection to the server closes unexpectedly, the client will automatically try to reconnect to the Cloud Event Bus cluster.

Parameters:

listener - the listener to use

Returns:

this connector.

connect

public Nats connect()

Creates the Nats instance and asynchronously connects to the first Nats server provided using the #addHost methods.

Returns:

the Nats instance.