com.allanbank.mongodb

Enum ConnectionModel

java.lang.Object

java.lang.Enum<ConnectionModel>

com.allanbank.mongodb.ConnectionModel

All Implemented Interfaces:

Serializable, Comparable<ConnectionModel>

public enum ConnectionModel
extends Enum<ConnectionModel>

ConnectionModel provides an enumeration of the connection models that the driver supports. Currently this is related to the number of threads used by the socket connections to the server.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECEIVER_THREAD Each sender thread writes the message to the socket connection directly.
SENDER_RECEIVER_THREAD Each socket uses a pair of threads: sender and receiver.

Method Summary

Methods

Modifier and Type	Method and Description
static ConnectionModel	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConnectionModel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECEIVER_THREAD

public static final ConnectionModel RECEIVER_THREAD

Each sender thread writes the message to the socket connection directly. A single receive thread is used per connection to receive the replies. While a sender writes each message to the socket the driver still has the ability to batch multiple send requests in a packet but batching is limited to concurrent senders. A single threaded application will not batch requests.

This is the default ConnectionModel.

In a multi-threaded application this ConnectionModel should perform as well as if not better than the SENDER_RECEIVER_THREAD model. This is achieved by completely avoiding cross thread passing of the message on a send.

SENDER_RECEIVER_THREAD

public static final ConnectionModel SENDER_RECEIVER_THREAD

Each socket uses a pair of threads: sender and receiver.

This was the default ConnectionModel versions prior to 1.3.0.

This ConnectionModel is most useful for connections where a single write() to the socket implementation is slow and the application only uses a single write thread.

Since:

1.0.0

Method Detail

values

public static ConnectionModel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConnectionModel c : ConnectionModel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConnectionModel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null