Skip to content

Commit d916de5

Browse files
committed
Fixed javadoc for connection liveness check timeout
Changed "session" to "connection" because config should only contain settings for the connection pool. There is no such thing as session pool.
1 parent e00cd6a commit d916de5

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

driver/src/main/java/org/neo4j/driver/v1/Config.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public int maxIdleConnectionPoolSize()
123123
}
124124

125125
/**
126-
* Pooled sessions that have been idle in the pool for longer than this timeout
126+
* Pooled connections that have been idle in the pool for longer than this timeout
127127
* will be tested before they are used again, to ensure they are still live.
128128
*
129129
* @return idle time in milliseconds
@@ -277,16 +277,15 @@ public ConfigBuilder withSessionLivenessCheckTimeout( long timeout )
277277
}
278278

279279
/**
280-
* Pooled sessions that have been idle in the pool for longer than this timeout
280+
* Pooled connections that have been idle in the pool for longer than this timeout
281281
* will be tested before they are used again, to ensure they are still live.
282282
* <p>
283283
* If this option is set too low, an additional network call will be
284-
* incurred when acquiring a session, which causes a performance hit.
284+
* incurred when acquiring a connection, which causes a performance hit.
285285
* <p>
286-
* If this is set high, you may receive sessions that are no longer live,
286+
* If this is set high, you may receive sessions that are backed by no longer live connections,
287287
* which will lead to exceptions in your application. Assuming the
288-
* database is running, these exceptions will go away if you retry acquiring
289-
* sessions.
288+
* database is running, these exceptions will go away if you retry acquiring sessions.
290289
* <p>
291290
* Hence, this parameter tunes a balance between the likelihood of your
292291
* application seeing connection problems, and performance.

0 commit comments

Comments
 (0)