ConnectionImpl (jnats 0.7.0 API)

java.lang.Object
- io.nats.client.ConnectionImpl

All Implemented Interfaces:: Connection

public class ConnectionImpl
extends Object
implements Connection

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`_CRLF_`
`static String`	`_EMPTY_`
`static String`	`_ERR_OP_`
`static String`	`_INFO_OP_`
`static String`	`_MSG_OP_`
`static String`	`_OK_OP_`
`static String`	`_PING_OP_`
`static String`	`_PONG_OP_`
`static String`	`_PUB_P_`
`static String`	`_SPC_`
`static String`	`CONN_PROTO`
`static String`	`OK_PROTO`
`static String`	`PING_PROTO`
`static String`	`PONG_PROTO`
`static String`	`PUB_PROTO`
`Constants.ConnState`	`status`
`static String`	`SUB_PROTO`
`static String`	`UNSUB_PROTO`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the connection, also closing all subscriptions on this connection.
`void`	`flush()` Flushes the current connection, waiting up to 60 seconds for completion.
`void`	`flush(int timeout)` Flushes the current connection, waiting up to `timeout` for successful completion.
`ClosedCallback`	`getClosedCallback()` Returns the connection closed callback.
`String`	`getConnectedServerId()` Returns the unique server ID string of the connected server.
`io.nats.client.ServerInfo`	`getConnectedServerInfo()` Returns the details from the INFO protocol message received.
`String`	`getConnectedUrl()` Returns the URL string of the currently connected NATS server.
`DisconnectedCallback`	`getDisconnectedCallback()` Returns the connection disconnected callback.
`ExceptionHandler`	`getExceptionHandler()` Returns the connection's asynchronous exception callback.
`Exception`	`getLastException()` Returns the last exception registered on the connection.
`long`	`getMaxPayload()` Gets the maximum payload size this connection will accept.
`int`	`getPendingByteCount()` Returns the number of valid bytes in the pending output buffer.
`ReconnectedCallback`	`getReconnectedCallback()` Returns the connection reconnected callback.
`Constants.ConnState`	`getState()` Returns the current connection state.
`Statistics`	`getStats()` Retrieves the connection statistics.
`boolean`	`isClosed()` Indicates whether the connection has been closed.
`boolean`	`isConnected()` Indicates whether the connection is currently reconnecting.
`boolean`	`isReconnecting()` Indicates whether the connection is currently reconnecting.
`String`	`newInbox()` Creates a new, uniquely named inbox with the prefix '_INBOX.'
`void`	`publish(Message msg)` Publishes a message to a subject.
`void`	`publish(String subject, byte[] data)` Publishes the payload specified by `data` to the subject specified by `subject`.
`void`	`publish(String subject, String reply, byte[] data)` Publishes the payload specified by `data` to the subject specified by `subject`, with an optional reply subject.
`Message`	`request(String subject, byte[] data)` Publishes a request message to the specified subject, waiting for a response until one is available.
`Message`	`request(String subject, byte[] data, long timeout)` Publishes a request message to the specified subject, waiting up to `timeout` msec for a response.
`Message`	`request(String subject, byte[] data, long timeout, TimeUnit unit)`
`void`	`resetStats()` Resets the gathered statistics for this connection.
`void`	`setClosedCallback(ClosedCallback cb)` Sets the connection closed callback.
`void`	`setDisconnectedCallback(DisconnectedCallback cb)` Sets the connection disconnected callback.
`void`	`setExceptionHandler(ExceptionHandler exceptionHandler)` Sets the connection's asynchronous exception callback.
`void`	`setReconnectedCallback(ReconnectedCallback cb)` Sets the connection reconnected callback.
`SyncSubscription`	`subscribe(String subject)` Creates a `SyncSubscription` with interest in a given subject.
`AsyncSubscription`	`subscribe(String subject, MessageHandler cb)` Creates a `AsyncSubscription` with interest in a given subject, assign the callback, and immediately start receiving messages
`SyncSubscription`	`subscribe(String subject, String queue)` Creates a `SyncSubscription` with interest in a given subject.
`AsyncSubscription`	`subscribe(String subj, String queue, MessageHandler cb)` Creates an asynchronous queue subscriber on a given subject of interest.
`AsyncSubscription`	`subscribeAsync(String subj, MessageHandler cb)` Deprecated.
`AsyncSubscription`	`subscribeAsync(String subject, String queue, MessageHandler cb)` Deprecated.
`SyncSubscription`	`subscribeSync(String subject)` Creates a `SyncSubscription` with interest in a given subject.
`SyncSubscription`	`subscribeSync(String subject, String queue)` Creates a synchronous queue subscriber on a given subject of interest.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - status
```
public Constants.ConnState status
```
  - _CRLF_
```
public static final String _CRLF_
```
    See Also:
    
    Constant Field Values
  - _EMPTY_
```
public static final String _EMPTY_
```
    See Also:
    
    Constant Field Values
  - _SPC_
```
public static final String _SPC_
```
    See Also:
    
    Constant Field Values
  - _PUB_P_
```
public static final String _PUB_P_
```
    See Also:
    
    Constant Field Values
  - _OK_OP_
```
public static final String _OK_OP_
```
    See Also:
    
    Constant Field Values
  - _ERR_OP_
```
public static final String _ERR_OP_
```
    See Also:
    
    Constant Field Values
  - _MSG_OP_
```
public static final String _MSG_OP_
```
    See Also:
    
    Constant Field Values
  - _PING_OP_
```
public static final String _PING_OP_
```
    See Also:
    
    Constant Field Values
  - _PONG_OP_
```
public static final String _PONG_OP_
```
    See Also:
    
    Constant Field Values
  - _INFO_OP_
```
public static final String _INFO_OP_
```
    See Also:
    
    Constant Field Values
  - CONN_PROTO
```
public static final String CONN_PROTO
```
    See Also:
    
    Constant Field Values
  - PING_PROTO
```
public static final String PING_PROTO
```
    See Also:
    
    Constant Field Values
  - PONG_PROTO
```
public static final String PONG_PROTO
```
    See Also:
    
    Constant Field Values
  - PUB_PROTO
```
public static final String PUB_PROTO
```
    See Also:
    
    Constant Field Values
  - SUB_PROTO
```
public static final String SUB_PROTO
```
    See Also:
    
    Constant Field Values
  - UNSUB_PROTO
```
public static final String UNSUB_PROTO
```
    See Also:
    
    Constant Field Values
  - OK_PROTO
```
public static final String OK_PROTO
```
    See Also:
    
    Constant Field Values
- Method Detail
  - close
```
public void close()
```
    Closes the connection, also closing all subscriptions on this connection.
    When close() is called, the following things happen, in order:
    1. The Connection is flushed, and any other pending flushes previously requested by the user are immediately cleared.
    2. Message delivery to all active subscriptions is terminated immediately, without regard to any messages that may have been delivered to the client's connection, but not to the relevant subscription(s). Any such undelivered messages are discarded immediately.
    3. The DisconnectedCallback, if registered, is invoked.
    4. The ClosedCallback, if registered, is invoked.
    5. The TCP/IP socket connection to the NATS server is gracefully closed.
    See Also:
    
    AutoCloseable.close()
  - isReconnecting
```
public boolean isReconnecting()
```
    Indicates whether the connection is currently reconnecting.
    
    Returns:
    
    whether or not the connection is currently reconnecting
  - isConnected
```
public boolean isConnected()
```
    Indicates whether the connection is currently reconnecting.
    
    Returns:
    
    whether or not the connection is currently reconnecting
  - isClosed
```
public boolean isClosed()
```
    Indicates whether the connection has been closed.
    
    Returns:
    
    true if the connection is closed.
  - flush
```
public void flush(int timeout)
           throws Exception
```
    Flushes the current connection, waiting up to timeout for successful completion.
    
    Parameters:
    
    timeout - - the connection timeout in milliseconds.
    
    Throws:
    
    IOException - if a connection-related error prevents the flush from completing
    
    TimeoutException - if the connection does not complete within the specified interval
    
    Exception - if some other error occurs
  - flush
```
public void flush()
           throws Exception
```
    Flushes the current connection, waiting up to 60 seconds for completion.
    
    Throws:
    
    IOException - if a connection-related issue prevented the flush from completing successfully
    
    Exception - if some other error is encountered
    
    See Also:
    
    flush(int)
  - subscribe
```
public SyncSubscription subscribe(String subject)
```
    Creates a SyncSubscription with interest in a given subject. In order to receive messages, call one of the available SyncSubscription.nextMessage().
    
    Parameters:
    
    subject - the subject of interest
    
    Returns:
    
    the SyncSubscription
  - subscribe
```
public SyncSubscription subscribe(String subject,
                                  String queue)
```
    Creates a SyncSubscription with interest in a given subject. All subscribers with the same queue name will form the queue group and only one member of the group will be selected to receive any given message.
    
    Parameters:
    
    subject - the subject of interest
    
    queue - the queue group
    
    Returns:
    
    the SyncSubscription
  - subscribe
```
public AsyncSubscription subscribe(String subject,
                                   MessageHandler cb)
```
    Creates a AsyncSubscription with interest in a given subject, assign the callback, and immediately start receiving messages
    
    Parameters:
    
    subject - the subject of interest
    
    cb - a MessageHandler object used to process messages received by the AsyncSubscription
    
    Returns:
    
    the started AsyncSubscription
  - subscribe
```
public AsyncSubscription subscribe(String subj,
                                   String queue,
                                   MessageHandler cb)
```
    Creates an asynchronous queue subscriber on a given subject of interest. All subscribers with the same queue name will form the queue group and only one member of the group will be selected to receive any given message asynchronously.
    
    Parameters:
    
    subj - the subject of interest
    
    queue - the name of the queue group
    
    cb - a MessageHandler object used to process messages received by the Subscription
    
    Returns:
    
    Subscription
  - subscribeAsync
```
@Deprecated
public AsyncSubscription subscribeAsync(String subject,
                                                    String queue,
                                                    MessageHandler cb)
```
    Deprecated.
    
    Create an AsyncSubscription with interest in a given subject, assign the message callback, and immediately start receiving messages.
    
    Parameters:
    
    subject - the subject of interest
    
    queue - the name of the queue group
    
    cb - a message callback for this subscription
    
    Returns:
    
    the AsyncSubscription
  - subscribeAsync
```
@Deprecated
public AsyncSubscription subscribeAsync(String subj,
                                                    MessageHandler cb)
```
    Deprecated.
    
    Creates a AsyncSubscription with interest in a given subject, assign the callback, and immediately start receiving messages
    
    Parameters:
    
    subj - the subject of interest
    
    cb - a MessageHandler object used to process messages received by the AsyncSubscription
    
    Returns:
    
    the started AsyncSubscription
  - subscribeSync
```
public SyncSubscription subscribeSync(String subject,
                                      String queue)
```
    Creates a synchronous queue subscriber on a given subject of interest. All subscribers with the same queue name will form the queue group and only one member of the group will be selected to receive any given message. MessageHandler must be registered, and AsyncSubscription.start() must be called.
    
    Parameters:
    
    subject - the subject of interest
    
    queue - the queue group
    
    Returns:
    
    the SyncSubscription
  - subscribeSync
```
public SyncSubscription subscribeSync(String subject)
```
    Creates a SyncSubscription with interest in a given subject. In order to receive messages, call one of the available SyncSubscription.nextMessage().
    
    Parameters:
    
    subject - the subject of interest
    
    Returns:
    
    the SyncSubscription
  - publish
```
public void publish(String subject,
                    String reply,
                    byte[] data)
             throws IOException
```
    Description copied from interface: Connection
    
    Publishes the payload specified by data to the subject specified by subject, with an optional reply subject. If reply is null, the behavior is identical to Connection.publish(String, byte[])
    
    Specified by:
    
    publish in interface Connection
    
    Parameters:
    
    subject - the subject to publish the message to
    
    reply - the subject to which subscribers should send responses
    
    data - the message payload
    
    Throws:
    
    IOException - if an I/O error is encountered
  - publish
```
public void publish(String subject,
                    byte[] data)
             throws IOException
```
    Description copied from interface: Connection
    
    Publishes the payload specified by data to the subject specified by subject.
    
    Specified by:
    
    publish in interface Connection
    
    Parameters:
    
    subject - the subject to publish the message to
    
    data - the message payload
    
    Throws:
    
    IOException - if an I/O error is encountered
  - publish
```
public void publish(Message msg)
             throws IOException
```
    Description copied from interface: Connection
    
    Publishes a message to a subject. The subject is set via Message.setSubject(String) or the Message.Message(String, String, byte[]) constructor.
    
    Specified by:
    
    publish in interface Connection
    
    Parameters:
    
    msg - the Message to publish
    
    Throws:
    
    IOException - if an I/O error is encountered
  - request
```
public Message request(String subject,
                       byte[] data,
                       long timeout,
                       TimeUnit unit)
                throws TimeoutException,
                       IOException
```
    Specified by:
    
    request in interface Connection
    
    Throws:
    
    TimeoutException
    
    IOException
  - request
```
public Message request(String subject,
                       byte[] data,
                       long timeout)
                throws TimeoutException,
                       IOException
```
    Description copied from interface: Connection
    
    Publishes a request message to the specified subject, waiting up to timeout msec for a response.
    
    Specified by:
    
    request in interface Connection
    
    Parameters:
    
    subject - the subject to publish the request message to
    
    data - the request message payload
    
    timeout - how long to wait for a response message (in msec)
    
    Returns:
    
    the response message
    
    Throws:
    
    TimeoutException - if timeout elapses before a message is returned
    
    IOException - if a connection-related error occurs
  - request
```
public Message request(String subject,
                       byte[] data)
                throws IOException,
                       TimeoutException
```
    Description copied from interface: Connection
    
    Publishes a request message to the specified subject, waiting for a response until one is available.
    
    Specified by:
    
    request in interface Connection
    
    Parameters:
    
    subject - the subject to publish the request message to
    
    data - the message payload
    
    Returns:
    
    the response message
    
    Throws:
    
    IOException - if a connection-related error occurs
    
    TimeoutException - if timeout elapses before a message is returned
  - newInbox
```
public String newInbox()
```
    Creates a new, uniquely named inbox with the prefix '_INBOX.'
    
    Returns:
    
    the newly created inbox subject
  - getStats
```
public Statistics getStats()
```
    Retrieves the connection statistics.
    
    Returns:
    
    the statistics for this connection.
    
    See Also:
    
    Statistics
  - resetStats
```
public void resetStats()
```
    Resets the gathered statistics for this connection.
    
    See Also:
    
    Statistics
  - getMaxPayload
```
public long getMaxPayload()
```
    Gets the maximum payload size this connection will accept.
    
    Returns:
    
    the maximum message payload size in bytes.
  - getClosedCallback
```
public ClosedCallback getClosedCallback()
```
    Returns the connection closed callback.
    
    Returns:
    
    the connection closed callback for this connection
    
    See Also:
    
    ClosedCallback
  - setClosedCallback
```
public void setClosedCallback(ClosedCallback cb)
```
    Sets the connection closed callback.
    
    Parameters:
    
    cb - the connection closed callback to set
  - getDisconnectedCallback
```
public DisconnectedCallback getDisconnectedCallback()
```
    Returns the connection disconnected callback.
    
    Returns:
    
    the disconnected callback for this conection
  - setDisconnectedCallback
```
public void setDisconnectedCallback(DisconnectedCallback cb)
```
    Sets the connection disconnected callback.
    
    Parameters:
    
    cb - the disconnected callback to set
  - getReconnectedCallback
```
public ReconnectedCallback getReconnectedCallback()
```
    Returns the connection reconnected callback.
    
    Returns:
    
    the reconnect callback for this connection
  - setReconnectedCallback
```
public void setReconnectedCallback(ReconnectedCallback cb)
```
    Sets the connection reconnected callback.
    
    Parameters:
    
    cb - the reconnect callback to set for this connection
  - getExceptionHandler
```
public ExceptionHandler getExceptionHandler()
```
    Returns the connection's asynchronous exception callback.
    
    Returns:
    
    the asynchronous exception handler for this connection
    
    See Also:
    
    ExceptionHandler
  - setExceptionHandler
```
public void setExceptionHandler(ExceptionHandler exceptionHandler)
```
    Sets the connection's asynchronous exception callback.
    
    Parameters:
    
    exceptionHandler - the asynchronous exception handler to set for this connection
    
    See Also:
    
    ExceptionHandler
  - getConnectedUrl
```
public String getConnectedUrl()
```
    Returns the URL string of the currently connected NATS server.
    
    Returns:
    
    the URL string of the currently connected NATS server.
  - getConnectedServerId
```
public String getConnectedServerId()
```
    Returns the unique server ID string of the connected server.
    
    Returns:
    
    the unique server ID string of the connected server
  - getState
```
public Constants.ConnState getState()
```
    Returns the current connection state.
    
    Returns:
    
    the current connection state
    
    See Also:
    
    Constants.ConnState
  - getConnectedServerInfo
```
public io.nats.client.ServerInfo getConnectedServerInfo()
```
    Returns the details from the INFO protocol message received.
    
    Returns:
    
    the details from the INFO protocol message received from the NATS server on initial establishment of a TCP connection.
    
    See Also:
    
    ServerInfo
  - getLastException
```
public Exception getLastException()
```
    Returns the last exception registered on the connection.
    
    Returns:
    
    the last exception registered on this connection
  - getPendingByteCount
```
public int getPendingByteCount()
```
    Returns the number of valid bytes in the pending output buffer. This buffer is only used during disconnect/reconnect sequences to buffer messages that are published during a temporary disconnection.
    
    Returns:
    
    the number of valid bytes in the pending output buffer.

Class ConnectionImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

status

_CRLF_

_EMPTY_

_SPC_

_PUB_P_

_OK_OP_

_ERR_OP_

_MSG_OP_

_PING_OP_

_PONG_OP_

_INFO_OP_

CONN_PROTO

PING_PROTO

PONG_PROTO

PUB_PROTO

SUB_PROTO

UNSUB_PROTO

OK_PROTO

Method Detail

close

isReconnecting

isConnected

isClosed

flush

flush

subscribe

subscribe

subscribe

subscribe

subscribeAsync

subscribeAsync

subscribeSync

subscribeSync

publish

publish

publish

request

request

request

newInbox

getStats

resetStats

getMaxPayload

getClosedCallback

setClosedCallback

getDisconnectedCallback

setDisconnectedCallback

getReconnectedCallback

setReconnectedCallback

getExceptionHandler

setExceptionHandler

getConnectedUrl

getConnectedServerId

getState

getConnectedServerInfo

getLastException

getPendingByteCount