Class/Object

reactivemongo.api

MongoConnectionOptions

Related Docs: object MongoConnectionOptions | package api

Permalink

case class MongoConnectionOptions(connectTimeoutMS: Int = 0, authSource: Option[String] = None, sslEnabled: Boolean = false, sslAllowsInvalidCert: Boolean = false, authMode: 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) extends Product with Serializable

Options for MongoConnection.

connectTimeoutMS

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

authSource

The database source for authentication credentials.

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

authMode

Either CrAuthentication or ScramSha1Authentication

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

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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoConnectionOptions(connectTimeoutMS: Int = 0, authSource: Option[String] = None, sslEnabled: Boolean = false, sslAllowsInvalidCert: Boolean = false, authMode: 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)

    Permalink

    connectTimeoutMS

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

    authSource

    The database source for authentication credentials.

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

    authMode

    Either CrAuthentication or ScramSha1Authentication

    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

Value Members

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

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

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

    Permalink
    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
  4. def ->[B](y: B): (MongoConnectionOptions, B)

    Permalink
    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()
  5. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  7. val authMode: AuthenticationMode

    Permalink

    Either CrAuthentication or ScramSha1Authentication

  8. val authSource: Option[String]

    Permalink

    The database source for authentication credentials.

  9. def clone(): AnyRef

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

    Permalink

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

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

    Permalink
    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
  12. def ensuring(cond: (MongoConnectionOptions) ⇒ Boolean): MongoConnectionOptions

    Permalink
    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
  13. def ensuring(cond: Boolean, msg: ⇒ Any): MongoConnectionOptions

    Permalink
    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
  14. def ensuring(cond: Boolean): MongoConnectionOptions

    Permalink
    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
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. val failoverStrategy: FailoverStrategy

    Permalink

    the default failover strategy

  17. def finalize(): Unit

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

    Permalink
    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()
  19. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    Any
  21. val keepAlive: Boolean

    Permalink

    TCP KeepAlive flag (ReactiveMongo-specific option).

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

  22. val maxIdleTimeMS: Int

    Permalink

    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

  23. val monitorRefreshMS: Int

    Permalink

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

  24. val nbChannelsPerNode: Int

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. val readPreference: ReadPreference

    Permalink

    the default read preference

  29. val sslAllowsInvalidCert: Boolean

    Permalink

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

  30. val sslEnabled: Boolean

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  32. val tcpNoDelay: Boolean

    Permalink

    TCPNoDelay flag (ReactiveMongo-specific option).

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

  33. final def wait(): Unit

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

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

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

    Permalink

    the default write concern

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

    Permalink
    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

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