io.nats.streaming

Interface StreamingConnection

All Superinterfaces:

java.lang.AutoCloseable

public interface StreamingConnection
extends java.lang.AutoCloseable

A StreamingConnection object is a client's active connection to the nats streaming data system.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
io.nats.client.Connection	getNatsConnection() Returns the underlying NATS connection.
void	publish(java.lang.String subject, byte[] data) Publishes the payload specified by data to the subject specified by subject, and blocks until an ACK or error is returned.
java.lang.String	publish(java.lang.String subject, byte[] data, AckHandler ah) 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.
Subscription	subscribe(java.lang.String subject, MessageHandler cb) Creates a Subscription with interest in a given subject, assigns the callback, and immediately starts receiving messages.
Subscription	subscribe(java.lang.String subject, MessageHandler cb, SubscriptionOptions opts) Creates a Subscription with interest in a given subject using the given SubscriptionOptions, assigns the callback, and immediately starts receiving messages.
Subscription	subscribe(java.lang.String subject, java.lang.String queue, MessageHandler cb) 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	subscribe(java.lang.String subject, java.lang.String queue, MessageHandler cb, SubscriptionOptions opts) 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.

Method Detail

publish

void publish(java.lang.String subject,
             byte[] data)
      throws java.io.IOException,
             java.lang.InterruptedException,
             java.util.concurrent.TimeoutException

Publishes the payload specified by data to the subject specified by subject, and blocks until an ACK or error is returned. If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established. The underlying connection will batch published messages until the reconnect buffer is full. See the JavaDoc for Options in the NATs client for more information on the reconnect buffer. However, keep in mind that ACK timeouts can come in to play and result in an exception despite the underlying connections caching attempt.

Parameters:

subject - the subject to which the message is to be published

data - the message payload

Throws:

java.io.IOException - if the publish operation is not successful

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.lang.IllegalStateException - if the connection is closed

java.util.concurrent.TimeoutException - if there is a timeout trying to ack

publish

java.lang.String publish(java.lang.String subject,
                         byte[] data,
                         AckHandler ah)
                  throws java.io.IOException,
                         java.lang.InterruptedException,
                         java.util.concurrent.TimeoutException

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. The underlying connection will batch published messages until the reconnect buffer is full. See the JavaDoc for Options in the NATs client for more information on the reconnect buffer. However, keep in mind that ACK timeouts can come in to play and result in an exception despite the underlying connections caching attempt.

Parameters:

subject - the subject to which the message is to be published

data - the message payload

ah - the AckHandler to invoke when an ack is received, passing the message GUID and any error information.

Returns:

the message GUID

Throws:

java.io.IOException - if an I/O exception is encountered

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.lang.IllegalStateException - if the connection is closed

java.util.concurrent.TimeoutException - if there is a timeout trying to ack

See Also:

AckHandler

subscribe

Subscription subscribe(java.lang.String subject,
                       MessageHandler cb)
                throws java.io.IOException,
                       java.lang.InterruptedException,
                       java.util.concurrent.TimeoutException

Creates a Subscription with interest in a given subject, assigns the callback, and immediately starts receiving messages. If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established. That includes telling the server about the subscription. In that situation it is possible for a timeout to occur.

Parameters:

subject - the subject of interest

cb - a MessageHandler callback used to process messages received by the Subscription

Returns:

the Subscription object, or null if the subscription request timed out

Throws:

java.io.IOException - if an I/O exception is encountered

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.util.concurrent.TimeoutException - if the server request cannot complete within subscription timeout

See Also:

MessageHandler, Subscription

subscribe

Subscription subscribe(java.lang.String subject,
                       MessageHandler cb,
                       SubscriptionOptions opts)
                throws java.io.IOException,
                       java.lang.InterruptedException,
                       java.util.concurrent.TimeoutException

Creates a Subscription with interest in a given subject using the given SubscriptionOptions, assigns the callback, and immediately starts receiving messages. If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established. That includes telling the server about the subscription. In that situation it is possible for a timeout to occur.

Parameters:

subject - the subject of interest

cb - a MessageHandler callback used to process messages received by the Subscription

opts - the SubscriptionOptions to configure this Subscription

Returns:

the Subscription object, or null if the subscription request timed out

Throws:

java.io.IOException - if an I/O exception is encountered

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.util.concurrent.TimeoutException - if the server request cannot complete within subscription timeout

See Also:

MessageHandler, Subscription, SubscriptionOptions

subscribe

Subscription subscribe(java.lang.String subject,
                       java.lang.String queue,
                       MessageHandler cb)
                throws java.io.IOException,
                       java.lang.InterruptedException,
                       java.util.concurrent.TimeoutException

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. If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established. That includes telling the server about the subscription. In that situation it is possible for a timeout to occur.

Parameters:

subject - the subject of interest

queue - optional queue group

cb - a MessageHandler callback used to process messages received by the Subscription

Returns:

the Subscription object, or null if the subscription request timed out

Throws:

java.io.IOException - if an I/O exception is encountered

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.util.concurrent.TimeoutException - if the server request cannot complete within subscription timeout

subscribe

Subscription subscribe(java.lang.String subject,
                       java.lang.String queue,
                       MessageHandler cb,
                       SubscriptionOptions opts)
                throws java.io.IOException,
                       java.lang.InterruptedException,
                       java.util.concurrent.TimeoutException

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. If the underlying NATs connection is disconnected, due to network problems, messages will not flow until that connection is re-established. That includes telling the server about the subscription. In that situation it is possible for a timeout to occur.

Parameters:

subject - the subject of interest

queue - optional queue group

cb - a MessageHandler callback used to process messages received by the Subscription

opts - the SubscriptionOptions to configure for this Subscription

Returns:

the Subscription object, or null if the subscription request timed out

Throws:

java.io.IOException - if an I/O exception is encountered

java.lang.InterruptedException - if the calling thread is interrupted before the call completes

java.util.concurrent.TimeoutException - if the server request cannot complete within subscription timeout

getNatsConnection

io.nats.client.Connection getNatsConnection()

Returns the underlying NATS connection. Use with caution, especially if you didn't create the connection.

Returns:

the underlying NATS connection.

See Also:

Connection

close

void close()
    throws java.io.IOException,
           java.util.concurrent.TimeoutException,
           java.lang.InterruptedException

Closes the connection.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an error occurs

java.util.concurrent.TimeoutException - if the close request is not responded to within the timeout period.

java.lang.InterruptedException