Package com.mongodb.connection
Class SocketSettings
java.lang.Object
com.mongodb.connection.SocketSettings
An immutable class representing socket settings used for connections to a MongoDB server.
- Since:
- 3.0
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder for an instance ofSocketSettings
. -
Method Summary
Modifier and TypeMethodDescriptionstatic SocketSettings.Builder
builder()
Gets a builder for an instance ofSocketSettings
.static SocketSettings.Builder
builder
(SocketSettings socketSettings) Creates a builder instance.boolean
int
getConnectTimeout
(TimeUnit timeUnit) Gets the timeout for socket connect.int
getReadTimeout
(TimeUnit timeUnit) Gets the timeout for socket reads.int
Gets the receive buffer size.int
Gets the send buffer size.int
hashCode()
toString()
-
Method Details
-
builder
Gets a builder for an instance ofSocketSettings
.- Returns:
- the builder
-
builder
Creates a builder instance.- Parameters:
socketSettings
- existing SocketSettings to default the builder settings on.- Returns:
- a builder
- Since:
- 3.7
-
getConnectTimeout
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
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
-
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
-
hashCode
public int hashCode() -
toString
-