com.allanbank.mongodb.connection

Interface Connection

All Superinterfaces:

AutoCloseable, Closeable, Flushable

All Known Implementing Classes:

AbstractProxyConnection, AuthenticatingConnection, ReplicaSetConnection, ShardedConnection, SocketConnection

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-2013, 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	addPending(List<PendingMessage> pending) Adds the pending messages from the specified list.
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this connection.
void	drainPending(List<PendingMessage> pending) Removes any to be sent pending messages into the specified list.
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	isIdle() Determines if the connection is idle.
boolean	isOpen() Determines if the connection is open.
void	raiseErrors(MongoDbException exception, boolean notifyToBeSent) 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.
String	send(Message message, Callback<Reply> replyCallback) Sends a message on the connection.
String	send(Message message1, Message message2, Callback<Reply> replyCallback) Sends a message on the connection.
void	shutdown() 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

addPending

void addPending(List<PendingMessage> pending)
                throws InterruptedException

Adds the pending messages from the specified list.

Parameters:

pending - The list to populate the pending list with.

Throws:

InterruptedException - On the thread being interrupted while copying the messages.

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.

drainPending

void drainPending(List<PendingMessage> pending)

Removes any to be sent pending messages into the specified list.

Parameters:

pending - The list to populate with the pending messages.

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.

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.

raiseErrors

void raiseErrors(MongoDbException exception,
               boolean notifyToBeSent)

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.

notifyToBeSent - If true then the to be sent message's callback are also notified, otherwise just the pending messages are notified.

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this connection.

Parameters:

listener - The listener for the change events.

send

String send(Message message,
          Callback<Reply> 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.

Returns:

The server that was sent the request.

Throws:

MongoDbException - On an error sending the message.

send

String send(Message message1,
          Message message2,
          Callback<Reply> 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.

Returns:

The server that was sent the request.

Throws:

MongoDbException - On an error sending the message.

shutdown

void shutdown()

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.

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.