com.allanbank.mongodb.connection.socket

Class SocketConnection

java.lang.Object

com.allanbank.mongodb.connection.socket.SocketConnection

All Implemented Interfaces:

Connection, Closeable, Flushable, AutoCloseable

public class SocketConnection
extends Object
implements Connection

Provides a blocking Socket based connection to a MongoDB server.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SocketConnection.NoopCallback NoopCallback provides a callback that does not look at the reply.
protected class	SocketConnection.ReceiveRunnable Runnable to receive messages.
protected class	SocketConnection.SendRunnable Runnable to push data out over the MongoDB connection.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH The length of the message header in bytes.
protected static Logger	LOG The logger for the SocketConnection.
protected Executor	myExecutor The executor for the responses.
protected AtomicBoolean	myOpen Holds if the connection is open.
protected PendingMessageQueue	myPendingQueue The queue of messages sent but waiting for a reply.
protected AtomicBoolean	myShutdown Set to true when the connection should be gracefully closed.
protected PendingMessageQueue	myToSendQueue The queue of messages to be sent.
static MongoDbException	NO_REPLY Exception that there was no reply for a message from MongoDB.

Fields inherited from interface com.allanbank.mongodb.connection.Connection

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
SocketConnection(ServerState server, MongoClientConfiguration config) Creates a new SocketConnection to a MongoDB server.

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	close()
protected Message	doReceive() Receives a single message from the connection.
protected void	doSend(int messageId, Message message) Sends a single message to the connection.
void	drainPending(List<PendingMessage> pending) Removes any to be sent pending messages into the specified list.
void	flush() /**
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.
protected void	raiseError(Throwable exception, Callback<Reply> replyCallback) Updates to raise an error on the callback, if any.
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.
protected int	readIntSuppressTimeoutOnNonFirstByte() Reads a little-endian 4 byte signed integer from the stream.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from this connection.
protected void	reply(Reply reply, Callback<Reply> replyCallback) Updates to set the reply for the callback, if any.
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	start() Starts the connections read and write threads.
void	stop() Stops the socket connection by calling shutdown().
String	toString()
protected void	updateSocketWithOptions(MongoClientConfiguration config) Updates the socket with the configuration's socket options.
void	waitForClosed(int timeout, TimeUnit timeoutUnits) Waits for the connection to become idle.
protected void	waitForPending(int count, long millis) Waits for the requested number of messages to become pending.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HEADER_LENGTH

public static final int HEADER_LENGTH

The length of the message header in bytes.

See Also:

Constant Field Values

NO_REPLY

public static final MongoDbException NO_REPLY

Exception that there was no reply for a message from MongoDB.

LOG

protected static final Logger LOG

The logger for the SocketConnection.

myExecutor

protected final Executor myExecutor

The executor for the responses.

myOpen

protected final AtomicBoolean myOpen

Holds if the connection is open.

myPendingQueue

protected final PendingMessageQueue myPendingQueue

The queue of messages sent but waiting for a reply.

myShutdown

protected final AtomicBoolean myShutdown

Set to true when the connection should be gracefully closed.

myToSendQueue

protected final PendingMessageQueue myToSendQueue

The queue of messages to be sent.

Constructor Detail

SocketConnection

public SocketConnection(ServerState server,
                MongoClientConfiguration config)
                 throws SocketException,
                        IOException

Creates a new SocketConnection to a MongoDB server.

Parameters:

server - The MongoDB server to connect to.

config - The configuration for the Connection to the MongoDB server.

Throws:

SocketException - On a failure connecting to the MongoDB server.

IOException - On a failure to read or write data to the MongoDB server.

Method Detail

addPending

public void addPending(List<PendingMessage> pending)
                throws InterruptedException

Adds the pending messages from the specified list.

Specified by:

addPending in interface Connection

Parameters:

pending - The list to populate the pending list with.

Throws:

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

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

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

Overridden to add the listener to this connection.

Specified by:

addPropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

drainPending

public void drainPending(List<PendingMessage> pending)

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

Specified by:

drainPending in interface Connection

Parameters:

pending - The list to populate with the pending messages.

flush

public void flush()
           throws IOException

/**

Specified by:

flush in interface Flushable

Throws:

IOException

getPendingCount

public int getPendingCount()

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

Specified by:

getPendingCount in interface Connection

Returns:

The number of messages pending responses from the server.

getServerName

public String getServerName()

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

Overridden to returns the server's name.

Specified by:

getServerName in interface Connection

Returns:

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

isIdle

public boolean isIdle()

Determines if the connection is idle.

True if the send and pending queues are empty.

Specified by:

isIdle in interface Connection

Returns:

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

isOpen

public boolean isOpen()

Determines if the connection is open.

True if the send and receive threads are running.

Specified by:

isOpen in interface Connection

Returns:

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

raiseErrors

public 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.

Notifies the appropriate messages of the error.

Specified by:

raiseErrors in interface Connection

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

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this connection.

Overridden to remove the listener from this connection.

Specified by:

removePropertyChangeListener in interface Connection

Parameters:

listener - The listener for the change events.

send

public String send(Message message,
          Callback<Reply> replyCallback)
            throws MongoDbException

Sends a message on the connection.

Specified by:

send in interface 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

public String send(Message message1,
          Message message2,
          Callback<Reply> replyCallback)
            throws MongoDbException

Sends a message on the connection.

Specified by:

send in interface 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

public 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.

Overridden to mark the socket as shutting down and tickles the sender to make sure that happens as soon as possible.

Specified by:

shutdown in interface Connection

start

public void start()

Starts the connections read and write threads.

stop

public void stop()

Stops the socket connection by calling shutdown().

toString

public String toString()

Overridden to return the socket information.

Overrides:

toString in class Object

waitForClosed

public void waitForClosed(int timeout,
                 TimeUnit timeoutUnits)

Waits for the connection to become idle.

Waits for the connections pending queues to empty.

Specified by:

waitForClosed in interface Connection

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.

doReceive

protected Message doReceive()
                     throws MongoDbException

Receives a single message from the connection.

Returns:

The Message received.

Throws:

MongoDbException - On an error receiving the message.

doSend

protected void doSend(int messageId,
          Message message)
               throws IOException

Sends a single message to the connection.

Parameters:

messageId - The id to use for the message.

message - The message to send.

Throws:

IOException - On a failure sending the message.

raiseError

protected void raiseError(Throwable exception,
              Callback<Reply> replyCallback)

Updates to raise an error on the callback, if any.

Parameters:

exception - The thrown exception.

replyCallback - The callback for the reply to the message.

readIntSuppressTimeoutOnNonFirstByte

protected int readIntSuppressTimeoutOnNonFirstByte()
                                            throws EOFException,
                                                   IOException

Reads a little-endian 4 byte signed integer from the stream.

Returns:

The integer value.

Throws:

EOFException - On insufficient data for the integer.

IOException - On a failure reading the integer.

reply

protected void reply(Reply reply,
         Callback<Reply> replyCallback)

Updates to set the reply for the callback, if any.

Parameters:

reply - The reply.

replyCallback - The callback for the reply to the message.

updateSocketWithOptions

protected void updateSocketWithOptions(MongoClientConfiguration config)
                                throws SocketException

Updates the socket with the configuration's socket options.

Parameters:

config - The configuration to apply.

Throws:

SocketException - On a failure setting the socket options.

waitForPending

protected void waitForPending(int count,
                  long millis)

Waits for the requested number of messages to become pending.

Parameters:

count - The number of pending messages expected.

millis - The number of milliseconds to wait.