Package com.mongodb.connection

Class SocketSettings.Builder

java.lang.Object

com.mongodb.connection.SocketSettings.Builder

Enclosing class:

SocketSettings

public static final class SocketSettings.Builder
extends Object

A builder for an instance of SocketSettings.

Method Summary

Modifier and Type	Method	Description
SocketSettings.Builder	applyConnectionString(ConnectionString connectionString)	Takes the settings from the given ConnectionString and applies them to the builder
SocketSettings.Builder	applySettings(SocketSettings socketSettings)	Applies the socketSettings to the 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.
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

Method Detail

applySettings

public SocketSettings.Builder applySettings(SocketSettings socketSettings)

Applies the socketSettings to the builder

Note: Overwrites all existing settings

Parameters:

socketSettings - the socketSettings

Returns:

this

Since:

3.7

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)

Takes the settings from the given ConnectionString and applies them to the builder

Parameters:

connectionString - the connection string containing details of how to connect to MongoDB

Returns:

this

See Also:

ConnectionString.getConnectTimeout(), ConnectionString.getSocketTimeout()

build

public SocketSettings build()

Build an instance of SocketSettings.

Returns:

the socket settings for this builder