final class AsyncDriver extends AnyRef

The asynchronous driver (see MongoConnection).

import scala.concurrent.Future
import reactivemongo.api.{ AsyncDriver, MongoConnection }

val driver = AsyncDriver()
val connection: Future[MongoConnection] =
  driver.connect("mongodb://node:27017")
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncDriver
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AsyncDriver(config: Option[Config] = None, classLoader: Option[ClassLoader] = None)

    config

    a custom configuration (otherwise the default options are used)

    classLoader

    a classloader used to load the actor system

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AsyncDriver toany2stringadd[AsyncDriver] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AsyncDriver, B)
    Implicit
    This member is added by an implicit conversion from AsyncDriver toArrowAssoc[AsyncDriver] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def askConnection(nodes: Seq[String], options: MongoConnectionOptions, name: Option[String]): Future[MongoConnection]

    Creates a new MongoConnection.

    Creates a new MongoConnection.

    nodes

    The list of node names (e.g. node1.foo.com:27017); Port is optional (27017 is used by default)

    options

    the options for the new connection pool

    name

    the name for the connection pool

    Attributes
    protected
  8. val classLoader: Option[ClassLoader]
    Attributes
    protected
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def close(timeout: FiniteDuration = FiniteDuration(2, SECONDS))(implicit ec: ExecutionContext): Future[Unit]

    Closes this driver (and all its connections and resources).

    Closes this driver (and all its connections and resources). Will wait until the timeout for proper closing of connections before forcing hard shutdown.

    import scala.concurrent.ExecutionContext

def afterClose(drv: reactivemongo.api.AsyncDriver)(
  implicit ec: ExecutionContext) = drv.close().andThen {
    case res => println("Close 'Try' result: " + res)
  }
  11. val config: Option[Config]
    Attributes
    protected
  12. def connect[T](parsedURI: URI[T]): Future[MongoConnection]

    Creates a new MongoConnection from URI.

    Creates a new MongoConnection from URI.

    parsedURI

    the URI parsed by reactivemongo.api.MongoConnection.fromString

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection, MongoConnection.ParsedURI

val driver = reactivemongo.api.AsyncDriver()

def con(uri: ParsedURI): Future[MongoConnection] = driver.connect(uri)
// with automatic name
  13. def connect[T](parsedURI: URI[T], name: Option[String], strictMode: Boolean): Future[MongoConnection]

    Creates a new MongoConnection from URI.

    Creates a new MongoConnection from URI.

    parsedURI

    The URI parsed by reactivemongo.api.MongoConnection.fromString

    name

    the name for the connection pool

    strictMode

    the flag to indicate whether the given URI must be a strict one (no ignored/invalid options)

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection, MongoConnection.ParsedURI

val driver = reactivemongo.api.AsyncDriver()

def con(uri: ParsedURI): Future[MongoConnection] =
  driver.connect(uri, name = Some("ConnectionName"))
  14. def connect[T](parsedURI: URI[T], name: Option[String]): Future[MongoConnection]

    Creates a new MongoConnection from URI.

    Creates a new MongoConnection from URI.

    parsedURI

    The URI parsed by reactivemongo.api.MongoConnection.fromString

    name

    the name for the connection pool

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection, MongoConnection.ParsedURI

val driver = reactivemongo.api.AsyncDriver()

def con(uri: ParsedURI): Future[MongoConnection] =
  driver.connect(uri, name = Some("ConnectionName"))
  15. def connect(uriStrict: String, name: Option[String]): Future[MongoConnection]

    Creates a new MongoConnection from URI.

    Creates a new MongoConnection from URI.

    uriStrict

    the strict URI, that will be parsed by reactivemongo.api.MongoConnection.fromString

    name

    the name for the connection pool

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection

val driver = reactivemongo.api.AsyncDriver()

val con: Future[MongoConnection] = driver.connect("mongodb://user123:passwd123@host1:27018,host2:27019,host3:27020/somedb?foo=bar&authenticationMechanism=scram-sha1", name = Some("ConnectionName"))
  16. def connect(uriStrict: String): Future[MongoConnection]

    Creates a new MongoConnection from URI.

    Creates a new MongoConnection from URI.

    uriStrict

    the strict URI, that will be parsed by reactivemongo.api.MongoConnection.fromString

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection

val driver = reactivemongo.api.AsyncDriver()

val con: Future[MongoConnection] = driver.connect("mongodb://user123:passwd123@host1:27018,host2:27019,host3:27020/somedb?foo=bar&authenticationMechanism=scram-sha1")
// with automatic name
  17. def connect(nodes: Seq[String], options: MongoConnectionOptions, name: String): Future[MongoConnection]

    Creates a new MongoConnection.

    Creates a new MongoConnection.

    nodes

    The list of node names (e.g. node1.foo.com:27017); Port is optional (27017 is used by default)

    options

    the options for the new connection pool

    name

    the name for the connection pool

    import scala.concurrent.Future
import reactivemongo.api.{ MongoConnection, MongoConnectionOptions }

val driver = reactivemongo.api.AsyncDriver()

val con: Future[MongoConnection] = driver.connect(
  nodes = Seq("node1:27017", "node2:27017", "node3:27017"),
  options = MongoConnectionOptions.default.copy(nbChannelsPerNode = 10),
  name = "ConnectionName")
  18. def connect(nodes: Seq[String], options: MongoConnectionOptions): Future[MongoConnection]

    Creates a new MongoConnection.

    Creates a new MongoConnection.

    nodes

    The list of node names (e.g. node1.foo.com:27017); Port is optional (27017 is used by default)

    options

    the options for the new connection pool

    import scala.concurrent.Future
import reactivemongo.api.{ MongoConnection, MongoConnectionOptions }

val driver = reactivemongo.api.AsyncDriver()

val con: Future[MongoConnection] = driver.connect(
  nodes = Seq("node1:27017", "node2:27017", "node3:27017"),
  options = MongoConnectionOptions.default.copy(nbChannelsPerNode = 10))
// with automatic name
  19. def connect(nodes: Seq[String]): Future[MongoConnection]

    Creates a new MongoConnection.

    Creates a new MongoConnection.

    nodes

    The list of node names (e.g. node1.foo.com:27017); Port is optional (27017 is used by default)

    import scala.concurrent.Future
import reactivemongo.api.MongoConnection

val driver = reactivemongo.api.AsyncDriver()

val con: Future[MongoConnection] = driver.connect(
  Seq("node1:27017", "node2:27017", "node3:27017"))
// with default options and automatic name
  20. final val connectionMonitors: Map[ActorRef, MongoConnection]
    Attributes
    protected
  21. def ensuring(cond: (AsyncDriver) => Boolean, msg: => Any): AsyncDriver
    Implicit
    This member is added by an implicit conversion from AsyncDriver toEnsuring[AsyncDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (AsyncDriver) => Boolean): AsyncDriver
    Implicit
    This member is added by an implicit conversion from AsyncDriver toEnsuring[AsyncDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: => Any): AsyncDriver
    Implicit
    This member is added by an implicit conversion from AsyncDriver toEnsuring[AsyncDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): AsyncDriver
    Implicit
    This member is added by an implicit conversion from AsyncDriver toEnsuring[AsyncDriver] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final val supervisorName: String
    Attributes
    protected
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AsyncDriver toStringFormat[AsyncDriver] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (AsyncDriver, B)
    Implicit
    This member is added by an implicit conversion from AsyncDriver toArrowAssoc[AsyncDriver] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAsyncDriver to any2stringadd[AsyncDriver]

Inherited by implicit conversion StringFormat fromAsyncDriver to StringFormat[AsyncDriver]

Inherited by implicit conversion Ensuring fromAsyncDriver to Ensuring[AsyncDriver]

Inherited by implicit conversion ArrowAssoc fromAsyncDriver to ArrowAssoc[AsyncDriver]

Ungrouped