com.allanbank.mongodb.client.connection.socket

Class AbstractSocketConnection

java.lang.Object

com.allanbank.mongodb.client.connection.socket.AbstractSocketConnection

All Implemented Interfaces:

Receiver, Connection, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

SocketConnection, TwoThreadSocketConnection

public abstract class AbstractSocketConnection
extends Object
implements Connection, Receiver

AbstractSocketConnection provides the basic functionality for a socket connection that passes messages between the sender and receiver.

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 ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH The length of the message header in bytes.
protected BsonInputStream	myBsonIn The writer for BSON documents.
protected MongoClientConfiguration	myConfig The connections configuration.
protected StringEncoderCache	myEncoderCache The cache for the encoding of strings.
protected PropertyChangeSupport	myEventSupport Support for emitting property change events.
protected Executor	myExecutor The executor for the responses.
protected InputStream	myInput The buffered input stream.
protected Log	myLog The logger for the connection.
protected AtomicBoolean	myOpen Holds if the connection is open.
protected BufferedOutputStream	myOutput The buffered output stream.
protected PendingMessageQueue	myPendingQueue The queue of messages sent but waiting for a reply.
protected Server	myServer The open socket.
protected AtomicBoolean	myShutdown Set to true when the connection should be gracefully closed.
protected Socket	mySocket The open socket.

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

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractSocketConnection(Server server, MongoClientConfiguration config, StringEncoderCache encoderCache, StringDecoderCache decoderCache) Creates a new AbstractSocketConnection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this connection.
protected Message	doReceive() Receives a single message from the connection.
protected void	doReceiveOne() Receives and process a single message.
protected void	doSend(int messageId, RandomAccessOutputStream message) Sends a single message to the connection.
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	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.
protected void	markReaderNeedsToFlush() Should be called when the send of a message happens on the receive thread.
protected void	raiseError(Throwable exception, ReplyCallback replyCallback) Updates to raise an error on the callback, if any.
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.
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, PendingMessage pendingMessage) Updates to set the reply for the callback, if any.
protected void	send(PendingMessage pendingMessage, RandomAccessOutputStream message) Sends a single message.
void	shutdown(boolean force) Notifies the connection that once all outstanding requests have been sent and all replies received the Connection should be closed.
protected void	shutdown(MongoDbException error, boolean receiveError) Shutsdown the connection on an error.
abstract void	start() Starts the connection.
void	stop() Stops the socket connection by calling shutdown(false).
String	toString()
void	tryReceive() Tries to receive a message from the server.
protected void	updateSocketWithOptions(MongoClientConfiguration config) Updates the socket with the configuration's socket options.
protected void	validate(Message message1, Message message2) Ensures that the documents in the message do not exceed the maximum size allowed by MongoDB.
void	waitForClosed(int timeout, TimeUnit timeoutUnits) Waits for the connection to become idle.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.allanbank.mongodb.client.connection.Connection

send, send

Methods inherited from interface java.io.Closeable

close

Field Detail

HEADER_LENGTH

public static final int HEADER_LENGTH

The length of the message header in bytes.

See Also:

Constant Field Values

myBsonIn

protected final BsonInputStream myBsonIn

The writer for BSON documents. Shares this objects myInput.

myConfig

protected final MongoClientConfiguration myConfig

The connections configuration.

myEncoderCache

protected final StringEncoderCache myEncoderCache

The cache for the encoding of strings.

myEventSupport

protected final PropertyChangeSupport myEventSupport

Support for emitting property change events.

myExecutor

protected final Executor myExecutor

The executor for the responses.

myInput

protected final InputStream myInput

The buffered input stream.

myLog

protected final Log myLog

The logger for the connection.

myOpen

protected final AtomicBoolean myOpen

Holds if the connection is open.

myOutput

protected final BufferedOutputStream myOutput

The buffered output stream.

myPendingQueue

protected final PendingMessageQueue myPendingQueue

The queue of messages sent but waiting for a reply.

myServer

protected final Server myServer

The open socket.

myShutdown

protected final AtomicBoolean myShutdown

Set to true when the connection should be gracefully closed.

mySocket

protected final Socket mySocket

The open socket.

Constructor Detail

AbstractSocketConnection

public AbstractSocketConnection(Server server,
                        MongoClientConfiguration config,
                        StringEncoderCache encoderCache,
                        StringDecoderCache decoderCache)
                         throws SocketException,
                                IOException

Creates a new AbstractSocketConnection.

Parameters:

server - The MongoDB server to connect to.

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

encoderCache - Cache used for encoding strings.

decoderCache - Cache used for decoding strings.

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

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.

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.

isAvailable

public boolean isAvailable()

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

True if the connection is open and not shutting down.

Specified by:

isAvailable in interface Connection

Returns:

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

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 connection has not been closed.

Specified by:

isOpen in interface Connection

Returns:

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

isShuttingDown

public boolean isShuttingDown()

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

Specified by:

isShuttingDown in interface Connection

Returns:

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

raiseErrors

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

Notifies the appropriate messages of the error.

Specified by:

raiseErrors in interface Connection

Parameters:

exception - The error condition.

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.

shutdown

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

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

Parameters:

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

start

public abstract void start()

Starts the connection.

stop

public void stop()

Stops the socket connection by calling shutdown(false).

toString

public String toString()

Overridden to return the socket information.

Overrides:

toString in class Object

tryReceive

public void tryReceive()

Tries to receive a message from the server. Every attempt should be made to not block.

If there is a pending flush then flushes.

If there is any available data then does a single receive.

Specified by:

tryReceive in interface Receiver

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.

doReceiveOne

protected void doReceiveOne()

Receives and process a single message.

doSend

protected void doSend(int messageId,
          RandomAccessOutputStream 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.

markReaderNeedsToFlush

protected void markReaderNeedsToFlush()

Should be called when the send of a message happens on the receive thread. The sender should not flush the myOutput. Instead the receive thread will flush() once it has consumed all of the pending messages to be received.

raiseError

protected void raiseError(Throwable exception,
              ReplyCallback 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,
         PendingMessage pendingMessage)

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

Parameters:

reply - The reply.

pendingMessage - The pending message.

send

protected final void send(PendingMessage pendingMessage,
        RandomAccessOutputStream message)
                   throws InterruptedException,
                          IOException

Sends a single message.

Parameters:

pendingMessage - The message to be sent.

message - The message that has already been encoded/serialized. This may be null in which case the message is streamed to the socket.

Throws:

InterruptedException - If the thread is interrupted waiting for a message to send.

IOException - On a failure sending the message.

shutdown

protected void shutdown(MongoDbException error,
            boolean receiveError)

Shutsdown the connection on an error.

Parameters:

error - The error causing the shutdown.

receiveError - If true then the socket experienced a receive error.

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.

validate

protected void validate(Message message1,
            Message message2)
                 throws DocumentToLargeException,
                        ServerVersionException

Ensures that the documents in the message do not exceed the maximum size allowed by MongoDB.

Parameters:

message1 - The message to be sent to the server.

message2 - The second message to be sent to the server.

Throws:

DocumentToLargeException - On a message being too large.

ServerVersionException - If one of the messages cannot be sent to the server version.