com.allanbank.mongodb.client.connection.socket

Class SocketConnection

java.lang.Object

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

com.allanbank.mongodb.client.connection.socket.SocketConnection

All Implemented Interfaces:

Receiver, Connection, Closeable, Flushable, AutoCloseable

public class SocketConnection
extends AbstractSocketConnection

Provides a blocking Socket based connection to a MongoDB server.

This version uses single receive thread. Sending of messages is done by the application thread sending the message.

This implementation does not perform as well as the TwoThreadSocketConnection when the Socket implementation does not have built in buffering of messages or requires acknowledgment of messages before releasing a write request. For that reason this implementation is only used with the normal Java Socket implementations.

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 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
SocketConnection(Server server, MongoClientConfiguration config) Creates a new SocketConnection to a MongoDB server.
SocketConnection(Server server, MongoClientConfiguration config, StringEncoderCache encoderCache, StringDecoderCache decoderCache, ThreadLocal<Reference<BufferingBsonOutputStream>> buffers) 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	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, raiseErrors, 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

Constructor Detail

SocketConnection

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

SocketConnection

public SocketConnection(Server server,
                MongoClientConfiguration config,
                StringEncoderCache encoderCache,
                StringDecoderCache decoderCache,
                ThreadLocal<Reference<BufferingBsonOutputStream>> buffers)
                 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.

buffers - The buffers used each connection. Each buffer is shared by all connections but there can be up to 1 buffer per application thread.

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.

True if the send and pending queues are empty.

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.

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