Skip navigation links
A B C D E G H I M N O P S T U 

A

ack() - Method in class io.nats.streaming.Message
Acknowledges the message to the streaming cluster.
AckHandler - Interface in io.nats.streaming
A callback interface for handling NATS Streaming message acknowledgements.
ackWait(Duration) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets the amount of time the subscription will wait for ACKs from the cluster.
ackWait(long, TimeUnit) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets the amount of time the subscription will wait for ACKs from the cluster.

B

build() - Method in class io.nats.streaming.Options.Builder
Construct the options object.
build() - Method in class io.nats.streaming.SubscriptionOptions.Builder
Creates a SubscriptionOptions instance based on the current configuration.
Builder() - Constructor for class io.nats.streaming.Options.Builder
 
Builder(Options) - Constructor for class io.nats.streaming.Options.Builder
Constructs a Options.Builder instance based on the supplied Options instance.
Builder() - Constructor for class io.nats.streaming.SubscriptionOptions.Builder
 

C

close() - Method in interface io.nats.streaming.StreamingConnection
Closes the connection.
close() - Method in interface io.nats.streaming.Subscription
Removes this subscriber from the server without removing durable interest (if it exists).
close(boolean) - Method in interface io.nats.streaming.Subscription
Removes this subscriber from the server.
connect(String, String) - Static method in class io.nats.streaming.NatsStreaming
Creates a NATS Streaming connection using the supplied cluster ID and client ID.
connect(String, String, Options) - Static method in class io.nats.streaming.NatsStreaming
Creates a NATS Streaming connection using the supplied cluster ID, client ID, and Options.
connectionListener(ConnectionListener) - Method in class io.nats.streaming.Options.Builder
Provide an connection listener to use when creating the nats connection.
connectWait(Duration) - Method in class io.nats.streaming.Options.Builder
Set the connect timeout
createConnection() - Method in class io.nats.streaming.StreamingConnectionFactory
Creates an active connection to a NATS Streaming server.

D

DEFAULT_ACK_WAIT - Static variable in class io.nats.streaming.SubscriptionOptions
Default ack wait time for a subscriptions.
DEFAULT_MAX_IN_FLIGHT - Static variable in class io.nats.streaming.SubscriptionOptions
Default max messages in flight for a subscriptions.
DEFAULT_SUBSCRIPTION_TIMEOUT - Static variable in class io.nats.streaming.SubscriptionOptions
Default time a connection will wait to create a subscription.
defaultOptions() - Static method in class io.nats.streaming.NatsStreaming
The default Options settings.
deliverAllAvailable() - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies that message delivery should begin at the oldest available message for this subject.
discoverPrefix(String) - Method in class io.nats.streaming.Options.Builder
Set the discovery prefix
dispatcher(String) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specify a dispatcher for this subscription.
durableName(String) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets the durable subscriber name for the subscription.

E

equals(Object) - Method in class io.nats.streaming.SubscriptionOptions
 
errorListener(ErrorListener) - Method in class io.nats.streaming.Options.Builder
Provide an error listener to use when creating the nats connection.

G

getAckInbox() - Method in interface io.nats.streaming.Subscription
 
getAckTimeout() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the ACK timeout.
getAckWait() - Method in class io.nats.streaming.SubscriptionOptions
Returns the timeout for waiting for an ACK from the cluster's point of view for delivered messages.
getClientId() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the client ID of the current NATS streaming session.
getClusterId() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the cluster ID of the current NATS streaming session.
getConnectionListener() - Method in class io.nats.streaming.StreamingConnectionFactory
 
getConnectTimeout() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the connect timeout interval in milliseconds.
getCrc32() - Method in class io.nats.streaming.Message
Returns the CRC32 checksum for the message.
getData() - Method in class io.nats.streaming.Message
Returns the message payload data.
getDiscoverPrefix() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the currently configured discover prefix string.
getDispatcherName() - Method in class io.nats.streaming.SubscriptionOptions
Returns name of the dispatcher to use for this subscription.
getDurableName() - Method in class io.nats.streaming.SubscriptionOptions
Returns the name of the durable subscriber.
getErrorListener() - Method in class io.nats.streaming.StreamingConnectionFactory
 
getMaxInFlight() - Method in class io.nats.streaming.SubscriptionOptions
Returns the maximum number of messages the cluster will send without an ACK.
getMaxPubAcksInFlight() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the maximum number of publish ACKs that may be in flight at any point in time.
getNatsConnection() - Method in interface io.nats.streaming.StreamingConnection
Returns the underlying NATS connection.
getNatsConnection() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the NATS StreamingConnection, if set.
getNatsUrl() - Method in class io.nats.streaming.StreamingConnectionFactory
Returns the NATS connection URL.
getOptions() - Method in interface io.nats.streaming.Subscription
Returns the SubscriptionOptions object for this Subscription object.
getQueue() - Method in interface io.nats.streaming.Subscription
Returns the optional queue group name.
getReplyTo() - Method in class io.nats.streaming.Message
Returns the reply subject.
getSequence() - Method in class io.nats.streaming.Message
Returns the message sequence number.
getStartAt() - Method in class io.nats.streaming.SubscriptionOptions
Returns the desired start position for the message stream.
getStartSequence() - Method in class io.nats.streaming.SubscriptionOptions
Returns the desired start sequence position.
getStartTime() - Method in class io.nats.streaming.SubscriptionOptions
Returns the desired start time position.
getStartTime(TimeUnit) - Method in class io.nats.streaming.SubscriptionOptions
Returns the desired start time position in the requested units.
getSubject() - Method in class io.nats.streaming.Message
Returns the message subject.
getSubject() - Method in interface io.nats.streaming.Subscription
Retrieves the subject of interest from the Subscription object.
getSubscriptionTimeout() - Method in class io.nats.streaming.SubscriptionOptions
 
getTimestamp() - Method in class io.nats.streaming.Message
The message timestamp in nanoseconds.

H

hashCode() - Method in class io.nats.streaming.SubscriptionOptions
 

I

io.nats.streaming - package io.nats.streaming
io.nats.streaming is a Java client library for the STAN streaming data system.
isManualAcks() - Method in class io.nats.streaming.SubscriptionOptions
Returns whether or not messages for this subscription must be acknowledged individually by calling Message.ack().
isRedelivered() - Method in class io.nats.streaming.Message
Determines whether or not this message has been redelivered to this client's connection.

M

manualAcks() - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets whether or not messages must be acknowledge individually by calling Message.ack().
maxInFlight(int) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets the maximum number of in-flight (unacknowledged) messages for the subscription.
maxPubAcksInFlight(int) - Method in class io.nats.streaming.Options.Builder
Set the max pub acks the server/client will allow
Message - Class in io.nats.streaming
A Message object is used to send a message containing a stream of uninterpreted bytes.
MessageHandler - Interface in io.nats.streaming
A MessageHandler object is used as a callback to receive asynchronously delivered messages.

N

natsConn(Connection) - Method in class io.nats.streaming.Options.Builder
Manually set the NATS connection
NatsStreaming - Class in io.nats.streaming
 
natsUrl(String) - Method in class io.nats.streaming.Options.Builder
Set the url to connect to for NATS

O

onAck(String, Exception) - Method in interface io.nats.streaming.AckHandler
This method is called when a message has been acknowledged by the STAN server, or if an error has occurred during the publish operations.
onMessage(Message) - Method in interface io.nats.streaming.MessageHandler
Passes a message to the handler.
Options - Class in io.nats.streaming
 
Options.Builder - Class in io.nats.streaming
 

P

pubAckWait(Duration) - Method in class io.nats.streaming.Options.Builder
Set the ack timeout
publish(String, byte[]) - Method in interface io.nats.streaming.StreamingConnection
Publishes the payload specified by data to the subject specified by subject, and blocks until an ACK or error is returned.
publish(String, byte[], AckHandler) - Method in interface io.nats.streaming.StreamingConnection
Publishes the payload specified by data to the subject specified by subject and asynchronously processes the ACK or error state via the supplied AckHandler If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established.

S

setAckTimeout(Duration) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the ACK timeout duration.
setAckTimeout(long, TimeUnit) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the ACK timeout in the specified time unit.
setClientId(String) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the client ID for the current NATS streaming session.
setClusterId(String) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the cluster ID of the current NATS streaming session.
setConnectionListener(ConnectionListener) - Method in class io.nats.streaming.StreamingConnectionFactory
Set a connection listener for the underlying nats connection.
setConnectTimeout(Duration) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the connect timeout duration.
setConnectTimeout(long, TimeUnit) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the connect timeout in the specified time unit.
setData(byte[]) - Method in class io.nats.streaming.Message
Sets the message payload data.
setData(byte[], int, int) - Method in class io.nats.streaming.Message
Sets the message payload data.
setDiscoverPrefix(String) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the discover prefix string that is used to establish a nats streaming session.
setErrorListener(ErrorListener) - Method in class io.nats.streaming.StreamingConnectionFactory
Set a error listener for the underlying nats connection.
setMaxPubAcksInFlight(int) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the maximum number of publish ACKs that may be in flight at any point in time.
setNatsConnection(Connection) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the NATS StreamingConnection.
setNatsUrl(String) - Method in class io.nats.streaming.StreamingConnectionFactory
Sets the NATS URL.
setReplyTo(String) - Method in class io.nats.streaming.Message
Sets the message reply subject.
setSubject(String) - Method in class io.nats.streaming.Message
Sets the message subject.
startAtSequence(long) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies the sequence number from which to start receiving messages.
startAtTime(Instant) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies the desired start time position using java.time.Instant.
startAtTimeDelta(long, TimeUnit) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies the desired delta start time position in the desired unit.
startAtTimeDelta(Duration) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies the desired delta start time as a Duration.
startWithLastReceived() - Method in class io.nats.streaming.SubscriptionOptions.Builder
Specifies that message delivery should start with the last (most recent) message stored for this subject.
StreamingConnection - Interface in io.nats.streaming
A StreamingConnection object is a client's active connection to the nats streaming data system.
StreamingConnectionFactory - Class in io.nats.streaming
A StreamingConnectionFactory object encapsulates a set of connection configuration options.
StreamingConnectionFactory() - Constructor for class io.nats.streaming.StreamingConnectionFactory
 
StreamingConnectionFactory(String, String) - Constructor for class io.nats.streaming.StreamingConnectionFactory
 
subscribe(String, MessageHandler) - Method in interface io.nats.streaming.StreamingConnection
Creates a Subscription with interest in a given subject, assigns the callback, and immediately starts receiving messages.
subscribe(String, MessageHandler, SubscriptionOptions) - Method in interface io.nats.streaming.StreamingConnection
Creates a Subscription with interest in a given subject using the given SubscriptionOptions, assigns the callback, and immediately starts receiving messages.
subscribe(String, String, MessageHandler) - Method in interface io.nats.streaming.StreamingConnection
Creates a Subscription in the queue group specified by queue with interest in a given subject, assigns the message callback, and immediately starts receiving messages.
subscribe(String, String, MessageHandler, SubscriptionOptions) - Method in interface io.nats.streaming.StreamingConnection
Creates a Subscription in the queue group specified by queue with interest in a given subject, assigns the message callback, and immediately starts receiving messages.
Subscription - Interface in io.nats.streaming
A client uses a Subscription object to receive messages that have been published to a subject.
SubscriptionOptions - Class in io.nats.streaming
A SubscriptionOptions object defines the configurable parameters of a STAN Subscription object.
SubscriptionOptions.Builder - Class in io.nats.streaming
A Builder implementation for creating an immutable SubscriptionOptions object.
subscriptionTimeout(Duration) - Method in class io.nats.streaming.SubscriptionOptions.Builder
Sets the amount of time the subscription will wait during creation on a network failure.

T

toString() - Method in class io.nats.streaming.Message
 
toString() - Method in class io.nats.streaming.SubscriptionOptions
 

U

unsubscribe() - Method in interface io.nats.streaming.Subscription
Removes interest in the Subscription.
A B C D E G H I M N O P S T U 
Skip navigation links