io.nats.stan

Interface Connection

All Superinterfaces:

AutoCloseable

public interface Connection
extends AutoCloseable

A Connection object is a client's active connection to the STAN 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(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.
String	publish(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
Subscription	subscribe(String subject, MessageHandler cb) Creates a Subscription with interest in a given subject, assigns the callback, and immediately starts receiving messages.
Subscription	subscribe(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(String subject, 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(String subject, 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(String subject,
             byte[] data)
      throws IOException

Publishes the payload specified by data to the subject specified by subject, and blocks until an ACK or error is returned.

Parameters:

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

data - the message payload

Throws:

IOException - if the publish operation is not successful

IllegalStateException - if the connection is closed

publish

String publish(String subject,
               byte[] data,
               AckHandler ah)
        throws IOException

Publishes the payload specified by data to the subject specified by subject and asynchronously processes the ACK or error state via the supplied AckHandler

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:

IOException - if an I/O exception is encountered

IllegalStateException - if the connection is closed

See Also:

AckHandler

subscribe

Subscription subscribe(String subject,
                       MessageHandler cb)
                throws IOException,
                       TimeoutException

Creates a Subscription with interest in a given subject, assigns the callback, and immediately starts receiving messages.

Parameters:

subject - the subject of interest

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

Returns:

the Subscription object

Throws:

IOException - if an I/O exception is encountered

TimeoutException - if the subscription request times out

See Also:

MessageHandler, Subscription

subscribe

Subscription subscribe(String subject,
                       MessageHandler cb,
                       SubscriptionOptions opts)
                throws IOException,
                       TimeoutException

Creates a Subscription with interest in a given subject using the given SubscriptionOptions, assigns the callback, and immediately starts receiving messages.

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

Throws:

IOException - if an I/O exception is encountered

TimeoutException - if the subscription request times out

See Also:

MessageHandler, Subscription, SubscriptionOptions

subscribe

Subscription subscribe(String subject,
                       String queue,
                       MessageHandler cb)
                throws IOException,
                       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.

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

Throws:

IOException - if an I/O exception is encountered

TimeoutException - if the subscription request times out

subscribe

Subscription subscribe(String subject,
                       String queue,
                       MessageHandler cb,
                       SubscriptionOptions opts)
                throws IOException,
                       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.

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

Throws:

IOException - if an I/O exception is encountered

TimeoutException - if the subscription request times out

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 IOException,
           TimeoutException

Closes the connection.

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an error occurs

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