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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. 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

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. 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

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated 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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

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

    Annotations
    @deprecated
    Deprecated

    (Since version 3.13.0) This method may be removed in a future version of the SDK. Netty classes might not always be part of the SDK's public API, and a future version might use a different I/O engine. There is no direct replacement. To change how many threads the SDK uses for I/O, please use eventLoopThreadCount instead.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped