com.mongodb.connection

Class SocketSettings.Builder

java.lang.Object

com.mongodb.connection.SocketSettings.Builder

Enclosing class:

SocketSettings

public static class SocketSettings.Builder
extends Object

A builder for an instance of SocketSettings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SocketSettings.Builder	applyConnectionString(ConnectionString connectionString) Apply any socket settings specified in the connection string to this builder.
SocketSettings	build() Build an instance of SocketSettings.
SocketSettings.Builder	connectTimeout(int connectTimeout, TimeUnit timeUnit) Sets the socket connect timeout.
SocketSettings.Builder	keepAlive(boolean keepAlive) Deprecated. configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
SocketSettings.Builder	readTimeout(int readTimeout, TimeUnit timeUnit) Sets the socket read timeout.
SocketSettings.Builder	receiveBufferSize(int receiveBufferSize) Sets the receive buffer size.
SocketSettings.Builder	sendBufferSize(int sendBufferSize) Sets the send buffer size.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

connectTimeout

public SocketSettings.Builder connectTimeout(int connectTimeout,
                                             TimeUnit timeUnit)

Sets the socket connect timeout.

Parameters:

connectTimeout - the connect timeout

timeUnit - the time unit

Returns:

this

readTimeout

public SocketSettings.Builder readTimeout(int readTimeout,
                                          TimeUnit timeUnit)

Sets the socket read timeout.

Parameters:

readTimeout - the read timeout

timeUnit - the time unit

Returns:

this

keepAlive

@Deprecated
public SocketSettings.Builder keepAlive(boolean keepAlive)

Deprecated. configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.

Sets keep-alive.

Parameters:

keepAlive - false if keep-alive should be disabled

Returns:

this

See Also:

Does TCP keep-alive time affect MongoDB Deployments?

receiveBufferSize

public SocketSettings.Builder receiveBufferSize(int receiveBufferSize)

Sets the receive buffer size.

Parameters:

receiveBufferSize - the receive buffer size

Returns:

this

sendBufferSize

public SocketSettings.Builder sendBufferSize(int sendBufferSize)

Sets the send buffer size.

Parameters:

sendBufferSize - the send buffer size

Returns:

this

applyConnectionString

public SocketSettings.Builder applyConnectionString(ConnectionString connectionString)

Apply any socket settings specified in the connection string to this builder.

Parameters:

connectionString - the connection string

Returns:

this

See Also:

ConnectionString.getConnectTimeout(), ConnectionString.getSocketTimeout()

build

public SocketSettings build()

Build an instance of SocketSettings.

Returns:

the socket settings for this builder