Socket Settings

On this page

Overview

Overview

In this guide, you can learn about how the Java driver manages socket settings.

You can specify settings for your sockets by using either a connection string or by passing a MongoClientSettings object to the MongoClients constructor. Select the Connection String or MongoClientSettings tab to see the options available:

Option Name	Type	Description
`connectTimeoutMS`	integer	Specifies the maximum amount of time, in milliseconds, the Java driver waits for a connection to open before timing out. A value of `0` instructs the driver to never time out while waiting for a connection to open. Default: `10000` (10 seconds)
`socketTimeoutMS`	integer	Specifies the maximum amount of time, in milliseconds, the Java driver will wait to send or receive a request before timing out. A value of `0` instructs the driver to never time out while waiting to send or receive a request. Default: `0`

This example specifies that the driver will time out after 15 seconds of waiting for a connection to open:

ConnectionString connectionString = "mongodb://<host>:<port>/?connectTimeoutMS=15000"
MongoClient mongoClient = MongoClients.create(connectionString)

For more information about these parameters, see the ConnectionString API documentation.

Chain the applyToSocketSettings() method to modify the driver's behavior when connecting and communicating with your MongoDB deployment.

The following table describes the methods you can chain to your settings to modify the driver's behavior:

Method	Description
`applyConnectionString()`	Uses the settings from a `ConnectionString` object.
`applySettings()`	Uses the socket settings specified in a `SocketSettings` object.
`connectTimeout()`	Sets the maximum time to connect to an available socket before throwing a timeout exception. Default: `10 seconds`
`readTimeout()`	Sets the maximum time to read from an available socket before throwing a timeout exception. Default: `0`, which indicates no timeout
`receiveBufferSize()`	Sets the socket's buffer size when receiving. Default: The operating system default
`sendBufferSize()`	Sets the socket's buffer size when sending. Default: The operating system default

Note

Connect to MongoDB by using a SOCKS5 Proxy

You can chain the applyToProxySettings() method to your socket settings to connect to MongoDB by using a SOCKS5 proxy. To learn how to use a SOCKS5 proxy and set proxy settings, see the Connect to MongoDB by Using a SOCKS5 Proxy guide.

This example specifies the following driver behavior in a MongoDB socket:

To connect to an available socket within 10 SECONDS
To read from an available socket within 15 SECONDS

MongoClient mongoClient = MongoClients.create(
    MongoClientSettings.builder()
    .applyConnectionString(new ConnectionString("<your connection string>"))
    .applyToSocketSettings(builder ->
        builder.connectTimeout(10, SECONDS)
        .readTimeout(15, SECONDS))
    .build());

For more information about the chained methods, see the MongoClientSettings.Builder API documentation.

Back

Server Settings

Configure Client-level CRUD Settings