Class/Object

reactivemongo.api

MongoConnectionOptions

Related Docs: object MongoConnectionOptions | package api

Permalink

class MongoConnectionOptions extends Product with Serializable

Options for MongoConnection.

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

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. def appName: Option[String]

    Permalink

    The application name (custom or default)

    The application name (custom or default)

    Annotations
    @inline()
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def authMode: AuthenticationMode

    Permalink

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

    Permalink

    the name of the database used for authentication

  10. val authenticationMechanism: AuthenticationMode

    Permalink
  11. def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    MongoConnectionOptions → Equals
  12. def clone(): AnyRef

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

    Permalink

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

  14. def copy(connectTimeoutMS: Int = this.connectTimeoutMS, authenticationDatabase: Option[String] = this.authenticationDatabase, sslEnabled: Boolean = this.sslEnabled, sslAllowsInvalidCert: Boolean = this.sslAllowsInvalidCert, authenticationMechanism: AuthenticationMode = this.authenticationMechanism, tcpNoDelay: Boolean = this.tcpNoDelay, keepAlive: Boolean = this.keepAlive, nbChannelsPerNode: Int = this.nbChannelsPerNode, maxInFlightRequestsPerChannel: Option[Int] = this.maxInFlightRequestsPerChannel, writeConcern: commands.WriteConcern = this.writeConcern, readPreference: ReadPreference = this.readPreference, failoverStrategy: FailoverStrategy = this.failoverStrategy, heartbeatFrequencyMS: Int = this.heartbeatFrequencyMS, maxIdleTimeMS: Int = this.maxIdleTimeMS, maxHistorySize: Int = this.maxHistorySize, credentials: Map[String, Credential] = this.credentials, keyStore: Option[KeyStore] = this.keyStore, readConcern: ReadConcern = this.readConcern): MongoConnectionOptions

    Permalink
  15. val credentials: Map[String, Credential]

    Permalink

    the credentials per authentication database names

  16. 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
  17. 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
  18. 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
  19. 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
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    MongoConnectionOptions → Equals → AnyRef → Any
  22. val failoverStrategy: FailoverStrategy

    Permalink

    the default failover strategy

  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. 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()
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. def hashCode(): Int

    Permalink
    Definition Classes
    MongoConnectionOptions → AnyRef → Any
  27. val heartbeatFrequencyMS: Int

    Permalink

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

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. val keepAlive: Boolean

    Permalink

    TCP KeepAlive flag (ReactiveMongo-specific option).

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

  30. val keyStore: Option[KeyStore]

    Permalink

    an optional key store

  31. val maxHistorySize: Int

    Permalink

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

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

  33. val maxInFlightRequestsPerChannel: Option[Int]

    Permalink
  34. val nbChannelsPerNode: Int

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  38. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  39. def productPrefix: String

    Permalink
    Definition Classes
    Product
  40. val readConcern: ReadConcern

    Permalink

    the default read concern

  41. val readPreference: ReadPreference

    Permalink

    the default read preference

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

  43. val sslEnabled: Boolean

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  45. val tcpNoDelay: Boolean

    Permalink

    TCPNoDelay flag (ReactiveMongo-specific option).

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

  46. def toString(): String

    Permalink
    Definition Classes
    MongoConnectionOptions → AnyRef → Any
  47. final def wait(): Unit

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

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

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

    Permalink

    the default write concern

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

Deprecated Value Members

  1. def authSource: Option[String]

    Permalink

    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 copy(connectTimeoutMS: Int, authenticationDatabase: Option[String], sslEnabled: Boolean, sslAllowsInvalidCert: Boolean, authenticationMechanism: AuthenticationMode, tcpNoDelay: Boolean, keepAlive: Boolean, nbChannelsPerNode: Int, reconnectDelayMS: Int, writeConcern: commands.WriteConcern, readPreference: ReadPreference, failoverStrategy: FailoverStrategy, heartbeatFrequencyMS: Int, maxIdleTimeMS: Int, maxHistorySize: Int, credentials: Map[String, Credential], keyStore: Option[KeyStore], readConcern: ReadConcern): MongoConnectionOptions

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Use the other copy

  3. def monitorRefreshMS: Int

    Permalink
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.16.4) Use heartbeatFrequencyMS

  4. val productArity: Int

    Permalink
    Definition Classes
    MongoConnectionOptions → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Will no longer be a Product

  5. def productElement(n: Int): Any

    Permalink
    Definition Classes
    MongoConnectionOptions → Product
    Annotations
    @deprecated
    Deprecated

    (Since version 0.17.0) Will no longer be a Product

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