com.couchbase.client.dcp.config

Class DcpControl

java.lang.Object

com.couchbase.client.dcp.config.DcpControl

public class DcpControl
extends Object

This class is used during bootstrap to configure all the possible DCP negotiation parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DcpControl.Names All the possible control options available.

Constructor Summary

Constructors

Constructor and Description
DcpControl() Creates a new DcpControl instance with no params set upfront.

Method Summary

Modifier and Type	Method and Description
boolean	bufferAckEnabled() Shorthand getter to check if buffer acknowledgements are enabled.
void	compression(CompressionMode compressionMode) Set the compression mode to use.
CompressionMode	compression(Version version) Returns the requested compression mode, or the fallback mode if the server does not support the requested mode.
String	get(DcpControl.Names name) Returns a param if set, otherwise null is returned.
Map<String,String>	getControls(Version serverVersion) Returns the control settings, adjusted for the actual Couchbase Server version.
boolean	noopEnabled() Shorthand getter to check if noops are enabled.
int	noopIntervalSeconds() Shorthand getter for the NOOP interval.
DcpControl	put(DcpControl.Names name, String value) Store/Override a control parameter.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DcpControl

public DcpControl()

Creates a new DcpControl instance with no params set upfront.

Method Detail

compression

public void compression(CompressionMode compressionMode)

Set the compression mode to use. If not specified, defaults to CompressionMode.DISABLED.

compression

public CompressionMode compression(Version version)

Returns the requested compression mode, or the fallback mode if the server does not support the requested mode.

put

public DcpControl put(DcpControl.Names name,
                      String value)

Store/Override a control parameter.

Parameters:

name - the name of the control parameter.

value - the stringified version what it should be set to.

Returns:

the DcpControl instance for chainability.

get

public String get(DcpControl.Names name)

Returns a param if set, otherwise null is returned.

Parameters:

name - the name of the param.

Returns:

the stringified value if set, null otherwise.

bufferAckEnabled

public boolean bufferAckEnabled()

Shorthand getter to check if buffer acknowledgements are enabled.

noopEnabled

public boolean noopEnabled()

Shorthand getter to check if noops are enabled.

noopIntervalSeconds

public int noopIntervalSeconds()

Shorthand getter for the NOOP interval.

getControls

public Map<String,String> getControls(Version serverVersion)

Returns the control settings, adjusted for the actual Couchbase Server version.

toString

public String toString()

Overrides:

toString in class Object