com.allanbank.mongodb.client.connection

Interface Connection

All Superinterfaces:

AutoCloseable, Closeable, Flushable

All Known Implementing Classes:

AbstractProxyConnection, AbstractProxyMultipleConnection, AbstractSocketConnection, AuthenticatingConnection, ReplicaSetConnection, ShardedConnection, SocketConnection, TwoThreadSocketConnection

public interface Connection
extends Closeable, Flushable

Provides the lowest level interface for interacting with a MongoDB server. The method provided here are a straight forward mapping from the MongoDB Wire Protocol.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_COLLECTION The collection to use when issuing commands to the database.
static String	OPEN_PROP_NAME The property for if the connection is open or not.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this connection.
int	getPendingCount() Returns the number of messages that are pending responses from the server.
String	getServerName() Returns the name of a server the connection is currently connected to.
boolean	isAvailable() Returns true if the connection is open and not shutting down, false otherwise.
boolean	isIdle() Determines if the connection is idle.
boolean	isOpen() Determines if the connection is open.
boolean	isShuttingDown() Returns true if the connection is being gracefully closed, false otherwise.
void	raiseErrors(MongoDbException exception) Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from this connection.
void	send(Message message1, Message message2, ReplyCallback replyCallback) Sends a message on the connection.
void	send(Message message, ReplyCallback replyCallback) Sends a message on the connection.
void	shutdown(boolean force) Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed.
void	waitForClosed(int timeout, TimeUnit timeoutUnits) Waits for the connection to become idle.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Field Detail

COMMAND_COLLECTION

static final String COMMAND_COLLECTION

The collection to use when issuing commands to the database.

See Also:

Constant Field Values

OPEN_PROP_NAME

static final String OPEN_PROP_NAME

The property for if the connection is open or not.

See Also:

Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener to this connection. Events are fired as the state of the connection changes.

Parameters:

listener - The listener for the change events.

getPendingCount

int getPendingCount()

Returns the number of messages that are pending responses from the server.

Returns:

The number of messages pending responses from the server.

getServerName

String getServerName()

Returns the name of a server the connection is currently connected to.

Returns:

The name of a server the connection is currently connected to.

isAvailable

boolean isAvailable()

Returns true if the connection is open and not shutting down, false otherwise.

Returns:

True if the connection is open and not shutting down, false otherwise.

isIdle

boolean isIdle()

Determines if the connection is idle.

Returns:

True if the connection is waiting for messages to send and has no outstanding messages to receive.

isOpen

boolean isOpen()

Determines if the connection is open.

Returns:

True if the connection is open and thinks it can send messages.

isShuttingDown

boolean isShuttingDown()

Returns true if the connection is being gracefully closed, false otherwise.

Returns:

True if the connection is being gracefully closed, false otherwise.

raiseErrors

void raiseErrors(MongoDbException exception)

Notifies the call backs for the pending and optionally the to be sent messages that there has been an external, unrecoverable error.

Parameters:

exception - The error condition.

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this connection.

Parameters:

listener - The listener for the change events.

send

void send(Message message1,
        Message message2,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Parameters:

message1 - The first message to send on the connection.

message2 - The second message to send on the connection.

replyCallback - The callback to notify of responses to the message2. May be null.

Throws:

MongoDbException - On an error sending the message.

send

void send(Message message,
        ReplyCallback replyCallback)
          throws MongoDbException

Sends a message on the connection.

Parameters:

message - The message to send on the connection.

replyCallback - The callback to notify of responses to the messages. May be null.

Throws:

MongoDbException - On an error sending the message.

shutdown

void shutdown(boolean force)

Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed. This method will return prior to the connection being closed.

Parameters:

force - If true then the connection can be immediately closed as the caller knows there are no outstanding requests to the server.

waitForClosed

void waitForClosed(int timeout,
                 TimeUnit timeoutUnits)

Waits for the connection to become idle.

Parameters:

timeout - The amount of time to wait for the connection to become idle.

timeoutUnits - The units for the amount of time to wait for the connection to become idle.