Package com.mongodb.connection
Class SocketSettings
-
- com.mongodb.connection.SocketSettings
-
@Immutable public class SocketSettings extends
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 ofSocketSettings
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static SocketSettings.Builder
builder()
Gets a builder for an instance ofSocketSettings
.static SocketSettings.Builder
builder(SocketSettings socketSettings)
Creates a builder instance.boolean
o)
int
timeUnit)
Gets the timeout for socket connect.int
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.toString()
-
-
-
Method Detail
-
builder
public static SocketSettings.Builder builder()
Gets a builder for an instance ofSocketSettings
.- 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)
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)
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
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:
-
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( o)
- Overrides:
in class
-
hashCode
public int hashCode()
- Overrides:
in class
-
toString
public toString()
- Overrides:
in class
-
-