Nats (Java NATS Client 0.6.4 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

MockNats
```
public interface Nats
extends Closeable
```
Provides the interface for publishing messages and subscribing to NATS subjects. This class is responsible for maintaining a connection to the NATS server as well as automatic fail-over to a second server if the connection to one server fails.
This class is fully thread-safe.

Author:

Mike Heath

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this Nats instance.
`boolean`	`isClosed()` Indicates if this client has been closed.
`boolean`	`isConnected()` Indicates if this client is connected to a NATS server.
`void`	`publish(String subject)` Publishes a message with an empty body to the specified subject.
`Registration`	`publish(String subject, long period, TimeUnit unit)` Publishes a message with an empty body to the specified subject on a recurring basis according to the specified period.
`void`	`publish(String subject, String body)` Publishes a message with the provided body to the specified subject.
`Registration`	`publish(String subject, String body, long period, TimeUnit unit)` Publishes a message with the provided body to the specified subject on a recurring basis according to the specified period.
`void`	`publish(String subject, String body, String replyTo)` Publishes a message with the provided body to the specified subject.
`Registration`	`publish(String subject, String body, String replyTo, long period, TimeUnit unit)` Publishes a message with the provided body to the specified subject on a recurring basis according to the specified period.
`Request`	`request(String subject, long timeout, TimeUnit unit, MessageHandler... messageHandlers)` Sends a request on the given subject.
`Request`	`request(String subject, String message, long timeout, TimeUnit unit, Integer maxReplies, MessageHandler... messageHandlers)` Sends a request body on the given subject and will except a specified number of replies.
`Request`	`request(String subject, String message, long timeout, TimeUnit unit, MessageHandler... messageHandlers)` Sends a request body on the given subject.
`Subscription`	`subscribe(String subject, Integer maxMessages, MessageHandler... messageHandlers)` Subscribes to the specified subject and will automatically unsubscribe after the specified number of messages arrives.
`Subscription`	`subscribe(String subject, MessageHandler... messageHandlers)` Subscribes to the specified subject.
`Subscription`	`subscribe(String subject, String queueGroup, Integer maxMessages, MessageHandler... messageHandlers)` Subscribes to the specified subject within a specific queue group and will automatically unsubscribe after the specified number of messages arrives.
`Subscription`	`subscribe(String subject, String queueGroup, MessageHandler... messageHandlers)` Subscribes to the specified subject within a specific queue group.

- Method Detail
  - isConnected
```
boolean isConnected()
```
    Indicates if this client is connected to a NATS server. This method will always return false after the close() method has been invoked. If the connection to the server is lost, the client will automatically try to reconnect to a server unless, of course, this feature has been disabled.
    
    Returns:
    
    true if the client is connected to a NATS server, false otherwise.
  - isClosed
```
boolean isClosed()
```
    Indicates if this client has been closed.
    
    Returns:
    
    true if close() was called (explicitly or implicitly due to an error), false otherwise.
  - close
```
void close()
```
    Closes this Nats instance. Closes the connection to the Nats server, closes any subscriptions, cancels any pending messages to be published.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - publish
```
void publish(String subject)
```
    Publishes a message with an empty body to the specified subject. If this Nats instance is not currently connected to a NATS server, the message will be queued up to be published once a connection is established.
    
    Parameters:
    
    subject - the subject to which the message will be published
  - publish
```
void publish(String subject,
             String body)
```
    Publishes a message with the provided body to the specified subject. If this Nats instance is not currently connected to a NATS server, the message will be queued up to be published once a connection is established.
    
    Parameters:
    
    subject - the subject to which the message will be published
    
    body - the message body to publish
  - publish
```
void publish(String subject,
             String body,
             String replyTo)
```
    Publishes a message with the provided body to the specified subject. Any replies to this message will be sent to the specified reply to subject. If this Nats instance is not currently connected to a NATS server, the message will be queued up to be published once a connection is established.
    
    Parameters:
    
    subject - the subject to which the message will be published
    
    body - the message body to publish
    
    replyTo - the subject replies to this body should be sent to.
  - publish
```
Registration publish(String subject,
                     long period,
                     TimeUnit unit)
```
    Publishes a message with an empty body to the specified subject on a recurring basis according to the specified period. If this Nats instance is not currently connected to a NATS server, the message will not be sent or queued up.
    
    Parameters:
    
    subject - the subject to which the message will be published
    
    period - the period between successive publishes
    
    unit - the time unit of the period parameter
    
    Returns:
    
    a Registration object that can be used to cancel repeatedly publishing the message.
  - publish
```
Registration publish(String subject,
                     String body,
                     long period,
                     TimeUnit unit)
```
    Publishes a message with the provided body to the specified subject on a recurring basis according to the specified period. If this Nats instance is not currently connected to a NATS server, the message will not be sent or queued up.
    
    Parameters:
    
    subject - the subject to which the message will be published
    
    body - the message body to publish
    
    period - the period between successive publishes
    
    unit - the time unit of the period parameter
    
    Returns:
    
    a Registration object that can be used to cancel recurring publishing.
  - publish
```
Registration publish(String subject,
                     String body,
                     String replyTo,
                     long period,
                     TimeUnit unit)
```
    Publishes a message with the provided body to the specified subject on a recurring basis according to the specified period. Any replies to this message will be sent to the specified reply to subject. If this Nats instance is not currently connected to a NATS server, the message will not be sent or queued up.
    
    Parameters:
    
    subject - the subject to which the message will be published
    
    body - the message body to publish
    
    replyTo - the subject replies to this body should be sent to.
    
    period - the period between successive publishes
    
    unit - the time unit of the period parameter
    
    Returns:
    
    a Registration object that can be used to cancel recurring publishing.
  - subscribe
```
Subscription subscribe(String subject,
                       MessageHandler... messageHandlers)
```
    Subscribes to the specified subject.
    
    Parameters:
    
    subject - the subject to subscribe to
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Subscription object used for interacting with the subscription
    
    See Also:
    
    subscribe(String, String, Integer,MessageHandler...)
  - subscribe
```
Subscription subscribe(String subject,
                       String queueGroup,
                       MessageHandler... messageHandlers)
```
    Subscribes to the specified subject within a specific queue group. The subject can be a specific subject or include wild cards. A body to a particular subject will be delivered to only member of the same queue group.
    
    Parameters:
    
    subject - the subject to subscribe to
    
    queueGroup - the queue group the subscription participates in
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Subscription object used for interacting with the subscription
    
    See Also:
    
    subscribe(String, String, Integer,MessageHandler...)
  - subscribe
```
Subscription subscribe(String subject,
                       Integer maxMessages,
                       MessageHandler... messageHandlers)
```
    Subscribes to the specified subject and will automatically unsubscribe after the specified number of messages arrives.
    
    Parameters:
    
    subject - the subject to subscribe to
    
    maxMessages - the maximum number of messages received by the subscription
    
    messageHandlers - the MessageHandlers to listen for incoming messages
    
    Returns:
    
    a Subscription object used for interacting with the subscription
    
    See Also:
    
    subscribe(String, String, Integer,MessageHandler...)
  - subscribe
```
Subscription subscribe(String subject,
                       String queueGroup,
                       Integer maxMessages,
                       MessageHandler... messageHandlers)
```
    Subscribes to the specified subject within a specific queue group and will automatically unsubscribe after the specified number of messages arrives.
    The subject may contain wild cards. "*" matches any token, at any level of the subject. For example:
```
     "foo.*.baz"  matches "foo.bar.baz, foo.a.baz, etc.
     "*.bar" matches "foo.bar", "baz.bar", etc.
     "*.bar.*" matches "foo.bar.baz", "foo.bar.foo", etc.
 
```
    ">" matches any length of the tail of a subject and can only be the last token. For examples, 'foo.>' will match 'foo.bar', 'foo.bar.baz', 'foo.foo.bar.bax.22'. A subject of simply ">" will match all messages.
    All subscriptions with the same queueGroup will form a queue group. Each body will be delivered to only one subscriber per queue group.
    Parameters:
    
    subject - the subject to subscribe to
    
    queueGroup - the queue group the subscription participates in
    
    maxMessages - the maximum number of messages received by the subscription
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Subscription object used for interacting with the subscription
  - request
```
Request request(String subject,
                long timeout,
                TimeUnit unit,
                MessageHandler... messageHandlers)
```
    Sends a request on the given subject.
    
    Parameters:
    
    subject - the subject to send the request on
    
    timeout - the amount of time to wait for replies
    
    unit - the unit of time to wait
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Request instance associated with the request.
    
    See Also:
    
    request(String, String, long, java.util.concurrent.TimeUnit, Integer, MessageHandler...)
  - request
```
Request request(String subject,
                String message,
                long timeout,
                TimeUnit unit,
                MessageHandler... messageHandlers)
```
    Sends a request body on the given subject.
    
    Parameters:
    
    subject - the subject to send the request on
    
    message - the content of the request
    
    timeout - the amount of time to wait for replies
    
    unit - the unit of time to wait
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Request instance associated with the request.
    
    See Also:
    
    request(String, String, long, java.util.concurrent.TimeUnit, Integer, MessageHandler...)
  - request
```
Request request(String subject,
                String message,
                long timeout,
                TimeUnit unit,
                Integer maxReplies,
                MessageHandler... messageHandlers)
```
    Sends a request body on the given subject and will except a specified number of replies.
    Invoking this method is roughly equivalent to the following: String replyTo = Nats.createInbox(); Subscription subscription = nats.subscribe(replyTo, maxReplies); Publication publication = nats.publish(subject, body, replyTo); that returns a combination of Subscription and Publication as a Request object.
    
    Parameters:
    
    subject - the subject to send the request on
    
    message - the content of the request
    
    timeout - the amount of time to wait for replies
    
    unit - the unit of time to wait
    
    maxReplies - the maximum number of replies that the request will accept before automatically closing, null for unlimited replies
    
    messageHandlers - the MessageHandlers to listen for incoming messages.
    
    Returns:
    
    a Request instance associated with the request.

Interface Nats

Method Summary

Method Detail

isConnected

isClosed

close

publish

publish

publish

publish

publish

publish

subscribe

subscribe

subscribe

subscribe

request

request

request