Package com.mongodb.connection

Class SocketSettings

java.lang.Object

com.mongodb.connection.SocketSettings

@Immutable
public class SocketSettings
extends Object

An immutable class representing socket settings used for connections to a MongoDB server.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SocketSettings.Builder	A builder for an instance of SocketSettings.

Method Summary

Modifier and Type	Method	Description
static SocketSettings.Builder	builder()	Gets a builder for an instance of SocketSettings.
static SocketSettings.Builder	builder(SocketSettings socketSettings)	Creates a builder instance.
boolean	equals(Object o)
int	getConnectTimeout(TimeUnit timeUnit)	Gets the timeout for socket connect.
int	getReadTimeout(TimeUnit timeUnit)	Gets the timeout for socket reads.
int	getReceiveBufferSize()	Gets the receive buffer size.
int	getSendBufferSize()	Gets the send buffer size.
int	hashCode()
boolean	isKeepAlive()	Deprecated. configuring keep-alive has been deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SocketSettings.Builder builder()

Gets a builder for an instance of SocketSettings.

Returns:

the builder

builder

public static SocketSettings.Builder builder(SocketSettings socketSettings)

Creates a builder instance.

Parameters:

socketSettings - existing SocketSettings to default the builder settings on.

Returns:

a builder

Since:

3.7

getConnectTimeout

public int getConnectTimeout(TimeUnit timeUnit)

Gets the timeout for socket connect. Defaults to 10 seconds.

Parameters:

timeUnit - the time unit to get the timeout in

Returns:

the connect timeout in the requested time unit.

getReadTimeout

public int getReadTimeout(TimeUnit timeUnit)

Gets the timeout for socket reads. Defaults to 0, which indicates no timeout

Parameters:

timeUnit - the time unit to get the timeout in

Returns:

the read timeout in the requested time unit, or 0 if there is no timeout

isKeepAlive

@Deprecated
public boolean isKeepAlive()

Deprecated.

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

Gets whether keep-alive is enabled. Defaults to true.

Returns:

true if keep-alive is enabled.

See Also:

Does TCP keep-alive time affect MongoDB Deployments?

getReceiveBufferSize

public int getReceiveBufferSize()

Gets the receive buffer size. Defaults to the operating system default.

Returns:

the receive buffer size

getSendBufferSize

public int getSendBufferSize()

Gets the send buffer size. Defaults to the operating system default.

Returns:

the send buffer size

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object