reactivemongo.api

MongoConnectionOptions

case class MongoConnectionOptions(connectTimeoutMS: Int = 0, authenticationDatabase: Option[String] = scala.None, sslEnabled: Boolean = false, sslAllowsInvalidCert: Boolean = false, authenticationMechanism: AuthenticationMode = ScramSha1Authentication, tcpNoDelay: Boolean = false, keepAlive: Boolean = false, nbChannelsPerNode: Int = 10, reconnectDelayMS: Int = 1000, writeConcern: commands.WriteConcern = ..., readPreference: ReadPreference = ReadPreference.primary, failoverStrategy: FailoverStrategy = FailoverStrategy.default, heartbeatFrequencyMS: Int = 10000, maxIdleTimeMS: Int = 0, maxHistorySize: Int = 25, credentials: Map[String, Credential] = ..., keyStore: Option[KeyStore] = scala.Option.empty[Nothing], readConcern: ReadConcern = ReadConcern.default) extends Product with Serializable

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

heartbeatFrequencyMS

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 #heartbeatFrequencyMS

maxHistorySize

the maximum size of the pool history (default: 25)

credentials

the credentials per authentication database names

keyStore

an optional key store

readConcern

the default read concern

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MongoConnectionOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    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

    heartbeatFrequencyMS

    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 #heartbeatFrequencyMS

    maxHistorySize

    the maximum size of the pool history (default: 25)

    credentials

    the credentials per authentication database names

    keyStore

    an optional key store

    readConcern

    the default read concern

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. 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()
  10. val authenticationDatabase: Option[String]

    the name of the database used for authentication

  11. val authenticationMechanism: AuthenticationMode

  12. def clone(): AnyRef

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

    The number of milliseconds to wait for a connection to be established before giving up.

  14. val credentials: Map[String, Credential]

    the credentials per authentication database names

  15. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean): MongoConnectionOptions

    Implicit information
    This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): MongoConnectionOptions

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

    Definition Classes
    AnyRef
  20. val failoverStrategy: FailoverStrategy

    the default failover strategy

  21. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  24. val heartbeatFrequencyMS: Int

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

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. val keepAlive: Boolean

    TCP KeepAlive flag (ReactiveMongo-specific option).

    TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).

  27. val keyStore: Option[KeyStore]

    an optional key store

  28. val maxHistorySize: Int

    the maximum size of the pool history (default: 25)

  29. 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 #heartbeatFrequencyMS

  30. val nbChannelsPerNode: Int

    Number of channels (connections) per node (ReactiveMongo-specific option).

  31. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  34. val readConcern: ReadConcern

    the default read concern

  35. val readPreference: ReadPreference

    the default read preference

  36. val sslAllowsInvalidCert: Boolean

    If sslEnabled is true, this one indicates whether to accept invalid certificates (e.

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

  37. val sslEnabled: Boolean

    Enable SSL connection (required to be accepted on server-side).

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

    Definition Classes
    AnyRef
  39. val tcpNoDelay: Boolean

    TCPNoDelay flag (ReactiveMongo-specific option).

    TCPNoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).

  40. final def wait(): Unit

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

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

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

    the default write concern

  44. def [B](y: B): (MongoConnectionOptions, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from MongoConnectionOptions to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (mongoConnectionOptions: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from MongoConnectionOptions to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (mongoConnectionOptions: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

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

  2. def monitorRefreshMS: Int

    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.16.4) Use heartbeatFrequencyMS

  3. val reconnectDelayMS: Int

    Annotations
    @deprecated
    Deprecated

    (Since version 0.16.4) Unused, see heartbeatFrequencyMS

  4. def x: MongoConnectionOptions

    Implicit information
    This member is added by an implicit conversion from MongoConnectionOptions to ArrowAssoc[MongoConnectionOptions] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (mongoConnectionOptions: ArrowAssoc[MongoConnectionOptions]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  5. def x: MongoConnectionOptions

    Implicit information
    This member is added by an implicit conversion from MongoConnectionOptions to Ensuring[MongoConnectionOptions] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (mongoConnectionOptions: Ensuring[MongoConnectionOptions]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from MongoConnectionOptions to StringFormat

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

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

Ungrouped