MongoConnectionOptions

Options for MongoConnection.

connectTimeoutMS: The number of milliseconds to wait for a connection to be established before giving up.
authenticationDatabase: the name of the database used for authentication
sslEnabled: Enable SSL connection (required to be accepted on server-side).
sslAllowsInvalidCert: If sslEnabled is true, this one indicates whether to accept invalid certificates (e.g. self-signed).
tcpNoDelay: TCPNoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).
keepAlive: TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).
nbChannelsPerNode: Number of channels (connections) per node (ReactiveMongo-specific option).
writeConcern: the default write concern
readPreference: the default read preference
failoverStrategy: the default failover strategy
monitorRefreshMS: the interval in milliseconds used by monitor to refresh the node set (default: 10000 aka 10s)
maxIdleTimeMS: the maximum number of milliseconds that a channel can remain idle in the connection pool before being removed and closed (default: 0 to disable, as implemented using Netty IdleStateHandler); If not 0, must be greater or equal to #monitorRefreshMS
maxHistorySize: the maximum size of the pool history (default: 25)
credentials: the credentials per database names
keyStore: an optional key store

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new MongoConnectionOptions(connectTimeoutMS: Int = 0, authenticationDatabase: Option[String] = None, sslEnabled: Boolean = false, sslAllowsInvalidCert: Boolean = false, authenticationMechanism: AuthenticationMode = ScramSha1Authentication, tcpNoDelay: Boolean = false, keepAlive: Boolean = false, nbChannelsPerNode: Int = 10, writeConcern: WriteConcern = WriteConcern.Default, readPreference: ReadPreference = ReadPreference.primary, failoverStrategy: FailoverStrategy = FailoverStrategy.default, monitorRefreshMS: Int = 10000, maxIdleTimeMS: Int = 0, maxHistorySize: Int = 25, credentials: Map[String, Credential] = Map.empty, keyStore: Option[KeyStore] = Option.empty)

connectTimeoutMS
The number of milliseconds to wait for a connection to be established before giving up.
authenticationDatabase
the name of the database used for authentication
sslEnabled
Enable SSL connection (required to be accepted on server-side).
sslAllowsInvalidCert
If sslEnabled is true, this one indicates whether to accept invalid certificates (e.g. self-signed).
tcpNoDelay
TCPNoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).
keepAlive
TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).
nbChannelsPerNode
Number of channels (connections) per node (ReactiveMongo-specific option).
writeConcern
the default write concern
readPreference
the default read preference
failoverStrategy
the default failover strategy
monitorRefreshMS
the interval in milliseconds used by monitor to refresh the node set (default: 10000 aka 10s)
maxIdleTimeMS
the maximum number of milliseconds that a channel can remain idle in the connection pool before being removed and closed (default: 0 to disable, as implemented using Netty IdleStateHandler); If not 0, must be greater or equal to #monitorRefreshMS
maxHistorySize
the maximum size of the pool history (default: 25)
credentials
the credentials per database names
keyStore
an optional key store

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to any2stringadd[MongoConnectionOptions] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (MongoConnectionOptions, B)

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to ArrowAssoc[MongoConnectionOptions] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authMode: AuthenticationMode

The database source for authentication credentials (corresponds to the authenticationMechanism with MongoShell).
The database source for authentication credentials (corresponds to the authenticationMechanism with MongoShell).

Annotations
@inline()
val authenticationDatabase: Option[String]

the name of the database used for authentication
val authenticationMechanism: AuthenticationMode
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val connectTimeoutMS: Int

The number of milliseconds to wait for a connection to be established before giving up.
val credentials: Map[String, Credential]

the credentials per database names
def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean, msg: ⇒ Any): MongoConnectionOptions

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean): MongoConnectionOptions

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): MongoConnectionOptions

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): MongoConnectionOptions

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val failoverStrategy: FailoverStrategy

the default failover strategy
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to StringFormat[MongoConnectionOptions] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keepAlive: Boolean

TCP KeepAlive flag (ReactiveMongo-specific option).
TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).
val keyStore: Option[KeyStore]

an optional key store
val maxHistorySize: Int

the maximum size of the pool history (default: 25)
val maxIdleTimeMS: Int

the maximum number of milliseconds that a channel can remain idle in the connection pool before being removed and closed (default: 0 to disable, as implemented using Netty IdleStateHandler); If not 0, must be greater or equal to #monitorRefreshMS
val monitorRefreshMS: Int

the interval in milliseconds used by monitor to refresh the node set (default: 10000 aka 10s)
val nbChannelsPerNode: Int

Number of channels (connections) per node (ReactiveMongo-specific option).
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val readPreference: ReadPreference

the default read preference
val sslAllowsInvalidCert: Boolean

If sslEnabled is true, this one indicates whether to accept invalid certificates (e.g.
If sslEnabled is true, this one indicates whether to accept invalid certificates (e.g. self-signed).
val sslEnabled: Boolean

Enable SSL connection (required to be accepted on server-side).
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tcpNoDelay: Boolean

TCPNoDelay flag (ReactiveMongo-specific option).
TCPNoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val writeConcern: WriteConcern

the default write concern
def →[B](y: B): (MongoConnectionOptions, B)

Implicit information
This member is added by an implicit conversion from MongoConnectionOptions to ArrowAssoc[MongoConnectionOptions] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def authSource: Option[String]

The database source for authentication credentials (corresponds to the authenticationDatabase with MongoShell).
The database source for authentication credentials (corresponds to the authenticationDatabase with MongoShell).

Annotations
@deprecated @inline()
Deprecated
(Since version 0.12.7) Use authenticationDatabase

Related Docs: object MongoConnectionOptions | package api

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (MongoConnectionOptions, B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def authMode: AuthenticationMode

val authenticationDatabase: Option[String]

val authenticationMechanism: AuthenticationMode

def clone(): AnyRef

val connectTimeoutMS: Int

val credentials: Map[String, Credential]

def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean, msg: ⇒ Any): MongoConnectionOptions

def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean): MongoConnectionOptions

def ensuring(cond: Boolean, msg: ⇒ Any): MongoConnectionOptions

def ensuring(cond: Boolean): MongoConnectionOptions

final def eq(arg0: AnyRef): Boolean

val failoverStrategy: FailoverStrategy

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val keepAlive: Boolean

val keyStore: Option[KeyStore]

val maxHistorySize: Int

val maxIdleTimeMS: Int

val monitorRefreshMS: Int

val nbChannelsPerNode: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val readPreference: ReadPreference

val sslAllowsInvalidCert: Boolean

val sslEnabled: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

val tcpNoDelay: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val writeConcern: WriteConcern

def →[B](y: B): (MongoConnectionOptions, B)

Deprecated Value Members

def authSource: Option[String]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from MongoConnectionOptions to any2stringadd[MongoConnectionOptions]

Inherited by implicit conversion StringFormat from MongoConnectionOptions to StringFormat[MongoConnectionOptions]

Inherited by implicit conversion Ensuring from MongoConnectionOptions to Ensuring[MongoConnectionOptions]

Inherited by implicit conversion ArrowAssoc from MongoConnectionOptions to ArrowAssoc[MongoConnectionOptions]

Ungrouped