Package com.couchbase.client.core.env
Class IoEnvironment
- java.lang.Object
-
- com.couchbase.client.core.env.IoEnvironment
-
public class IoEnvironment extends Object
TheIoEnvironment
holds all IO-related configuration and state.- Since:
- 2.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IoEnvironment.Builder
-
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_NATIVE_IO_ENABLED
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
analyticsEventLoopGroup()
Returns theEventLoopGroup
to be used for analytics traffic.static IoEnvironment.Builder
analyticsEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup analyticsEventLoopGroup)
static IoEnvironment.Builder
builder()
static IoEnvironment
create()
Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
kvEventLoopGroup()
Returns theEventLoopGroup
to be used for Key/Value traffic.static IoEnvironment.Builder
kvEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup kvEventLoopGroup)
Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
managerEventLoopGroup()
Returns theEventLoopGroup
to be used for config traffic.static IoEnvironment.Builder
managerEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup managerEventLoopGroup)
boolean
nativeIoEnabled()
Returns true if native IO is enabled and can be used if supported.Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
queryEventLoopGroup()
Returns theEventLoopGroup
to be used for N1QL Query traffic.static IoEnvironment.Builder
queryEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup queryEventLoopGroup)
Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
searchEventLoopGroup()
Returns theEventLoopGroup
to be used for search traffic.static IoEnvironment.Builder
searchEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup searchEventLoopGroup)
Mono<Void>
shutdown(Duration timeout)
Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup>
viewEventLoopGroup()
Returns theEventLoopGroup
to be used for view traffic.static IoEnvironment.Builder
viewEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup viewEventLoopGroup)
-
-
-
Field Detail
-
DEFAULT_NATIVE_IO_ENABLED
public static final boolean DEFAULT_NATIVE_IO_ENABLED
- See Also:
- Constant Field Values
-
-
Method Detail
-
create
public static IoEnvironment create()
-
builder
public static IoEnvironment.Builder builder()
-
managerEventLoopGroup
public static IoEnvironment.Builder managerEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup managerEventLoopGroup)
-
kvEventLoopGroup
public static IoEnvironment.Builder kvEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup kvEventLoopGroup)
-
queryEventLoopGroup
public static IoEnvironment.Builder queryEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup queryEventLoopGroup)
-
analyticsEventLoopGroup
public static IoEnvironment.Builder analyticsEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup analyticsEventLoopGroup)
-
searchEventLoopGroup
public static IoEnvironment.Builder searchEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup searchEventLoopGroup)
-
viewEventLoopGroup
public static IoEnvironment.Builder viewEventLoopGroup(com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup viewEventLoopGroup)
-
managerEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> managerEventLoopGroup()
Returns theEventLoopGroup
to be used for config traffic.- Returns:
- the selected event loop group.
-
kvEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> kvEventLoopGroup()
Returns theEventLoopGroup
to be used for Key/Value traffic.- Returns:
- the selected event loop group.
-
queryEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> queryEventLoopGroup()
Returns theEventLoopGroup
to be used for N1QL Query traffic.- Returns:
- the selected event loop group.
-
analyticsEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> analyticsEventLoopGroup()
Returns theEventLoopGroup
to be used for analytics traffic.- Returns:
- the selected event loop group.
-
searchEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> searchEventLoopGroup()
Returns theEventLoopGroup
to be used for search traffic.- Returns:
- the selected event loop group.
-
viewEventLoopGroup
public Supplier<com.couchbase.client.core.deps.io.netty.channel.EventLoopGroup> viewEventLoopGroup()
Returns theEventLoopGroup
to be used for view traffic.- Returns:
- the selected event loop group.
-
nativeIoEnabled
public boolean nativeIoEnabled()
Returns true if native IO is enabled and can be used if supported.- Returns:
- true if enabled.
-
-