com.allanbank.mongodb.client.connection.socket

Class TwoThreadSocketConnection

java.lang.Object

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

com.allanbank.mongodb.client.connection.socket.TwoThreadSocketConnection

All Implemented Interfaces:

Receiver, Connection, Closeable, Flushable, AutoCloseable

public class TwoThreadSocketConnection
extends AbstractSocketConnection

Provides a blocking Socket based connection to a MongoDB server.

This version uses a pair of threads (1 send and 1 receive) to handle the messages going to and from MongoDB.

This implementation was the default for the driver through the 1.2.3 release. It is still used by the driver for communication sockets that are not know to be standard Java Sockets as it performs better when the communication path does not have built in buffering of messages.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TwoThreadSocketConnection.SendRunnable Runnable to push data out over the MongoDB connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferingBsonOutputStream	myBsonOut The writer for BSON documents.
protected PendingMessageQueue	myToSendQueue The queue of messages to be sent.

Fields inherited from class com.allanbank.mongodb.client.connection.socket.AbstractSocketConnection

HEADER_LENGTH, myBsonIn, myConfig, myEncoderCache, myEventSupport, myExecutor, myInput, myLog, myOpen, myOutput, myPendingQueue, myServer, myShutdown, mySocket

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

COMMAND_COLLECTION, OPEN_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
TwoThreadSocketConnection(Server server, MongoClientConfiguration config) Creates a new SocketConnection to a MongoDB server.
TwoThreadSocketConnection(Server server, MongoClientConfiguration config, StringEncoderCache encoderCache, StringDecoderCache decoderCache) Creates a new SocketConnection to a MongoDB server.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
int	getPendingCount() Returns the number of messages that are pending responses from the server.
boolean	isIdle() Determines if the connection is idle.
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	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	start() Starts the connections read and write threads.

Methods inherited from class com.allanbank.mongodb.client.connection.socket.AbstractSocketConnection

addPropertyChangeListener, doReceive, doReceiveOne, doSend, flush, getServerName, isAvailable, isOpen, isShuttingDown, markReaderNeedsToFlush, raiseError, readIntSuppressTimeoutOnNonFirstByte, removePropertyChangeListener, reply, send, shutdown, shutdown, stop, toString, tryReceive, updateSocketWithOptions, validate, waitForClosed

Methods inherited from class java.lang.Object

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

Field Detail

myBsonOut

protected final BufferingBsonOutputStream myBsonOut

The writer for BSON documents.

myToSendQueue

protected final PendingMessageQueue myToSendQueue

The queue of messages to be sent.

Constructor Detail

TwoThreadSocketConnection

public TwoThreadSocketConnection(Server 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.

TwoThreadSocketConnection

public TwoThreadSocketConnection(Server server,
                         MongoClientConfiguration config,
                         StringEncoderCache encoderCache,
                         StringDecoderCache decoderCache)
                          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.

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

close

public void close()
           throws IOException

Throws:

IOException

getPendingCount

public int getPendingCount()

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

Specified by:

getPendingCount in interface Connection

Overrides:

getPendingCount in class AbstractSocketConnection

Returns:

The number of messages pending responses from the server.

isIdle

public boolean isIdle()

Determines if the connection is idle.

True if the send and pending queues are empty.

True if the send and pending queues are empty.

Specified by:

isIdle in interface Connection

Overrides:

isIdle in class AbstractSocketConnection

Returns:

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

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.

Notifies the appropriate messages of the error.

Specified by:

raiseErrors in interface Connection

Overrides:

raiseErrors in class AbstractSocketConnection

Parameters:

exception - The error condition.

send

public 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

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

start

public void start()

Starts the connections read and write threads.

Specified by:

start in class AbstractSocketConnection