case class IoEnvironment(managerEventLoopGroup: Option[EventLoopGroup] = None, kvEventLoopGroup: Option[EventLoopGroup] = None, queryEventLoopGroup: Option[EventLoopGroup] = None, analyticsEventLoopGroup: Option[EventLoopGroup] = None, searchEventLoopGroup: Option[EventLoopGroup] = None, viewEventLoopGroup: Option[EventLoopGroup] = None, nativeIoEnabled: Option[Boolean] = None, eventLoopThreadCount: Option[Int] = None) extends Product with Serializable

Holds all IO-related configuration and state.

Since

1.0.0

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IoEnvironment
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IoEnvironment(managerEventLoopGroup: Option[EventLoopGroup] = None, kvEventLoopGroup: Option[EventLoopGroup] = None, queryEventLoopGroup: Option[EventLoopGroup] = None, analyticsEventLoopGroup: Option[EventLoopGroup] = None, searchEventLoopGroup: Option[EventLoopGroup] = None, viewEventLoopGroup: Option[EventLoopGroup] = None, nativeIoEnabled: Option[Boolean] = None, eventLoopThreadCount: Option[Int] = None)

Value Members

  1. def analyticsEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for analytics traffic.

    Sets the EventLookGroup to be used for analytics traffic.

    returns

    this, for chaining

  2. def enableNativeIo(nativeIoEnabled: Boolean): IoEnvironment

    If set to false (enabled by default) will force using the JVM NIO based IO transport.

    If set to false (enabled by default) will force using the JVM NIO based IO transport.

    Usually the native transports used (epoll on linux and kqueue on OSX) are going to be faster and more efficient than the generic NIO one. We recommend to only set this to false if you experience issues with the native transports or instructed by couchbase support to do so for troubleshooting reasons.

    nativeIoEnabled

    if native IO should be enabled or disabled.

    returns

    this, for chaining

  3. def eventLoopThreadCount(eventLoopThreadCount: Int): IoEnvironment

    Overrides the number of threads used per event loop.

    Overrides the number of threads used per event loop.

    If not manually overridden, a fair thread count is calculated.

    Note that the count provided will only be used by event loops that the SDK creates. If you configure a custom event loop (i.e. through .kvEventLoopGroup you are responsible for sizing it appropriately on your own.

    eventLoopThreadCount

    the number of event loops to use per pool.

    returns

    this, for chaining

  4. def kvEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for key/value traffic.

    Sets the EventLookGroup to be used for key/value traffic.

    returns

    this, for chaining

  5. def managerEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for config traffic.

    Sets the EventLookGroup to be used for config traffic.

    returns

    this, for chaining

  6. def productElementNames: Iterator[String]
    Definition Classes
    Product
  7. def queryEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for query traffic.

    Sets the EventLookGroup to be used for query traffic.

    returns

    this, for chaining

  8. def searchEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for search traffic.

    Sets the EventLookGroup to be used for search traffic.

    returns

    this, for chaining

  9. def viewEventLoopGroup(value: EventLoopGroup): IoEnvironment

    Sets the EventLookGroup to be used for view traffic.

    Sets the EventLookGroup to be used for view traffic.

    returns

    this, for chaining