Skip to content

Commit 676c5ab

Browse files
committed
readme: move description of multiple connections to comment
Part of #123
1 parent 785b718 commit 676c5ab

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -171,21 +171,6 @@ To contact `go-tarantool` developers on any problems, create an issue at
171171
The developers of the [Tarantool server](http://github.com/tarantool/tarantool)
172172
will also be happy to provide advice or receive feedback.
173173

174-
## Multi connections
175-
176-
You can use multiple connections config with tarantool/multi.
177-
178-
Main features:
179-
180-
- Check active connection with configurable time interval and on connection fail switch to next in pool.
181-
- Get addresses list from server and reconfigure to use in MultiConnection.
182-
183-
Additional options (configurable via `ConnectWithOpts`):
184-
185-
* `CheckTimeout` - time interval to check for connection timeout and try to switch connection
186-
* `ClusterDiscoveryTime` - time interval to ask server for updated address list (works on with `NodesGetFunctionName` set)
187-
* `NodesGetFunctionName` - server lua function name to call for getting address list
188-
189174
## Tests
190175

191176
You need to [install Tarantool](https://www.tarantool.io/en/download/) to run tests.

multi/multi.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
// Package with methods to work with a Tarantool cluster.
2+
//
3+
// Main features:
4+
//
5+
// - Check the active connection with a configurable time interval and switch
6+
// to the next connection in the pool if there is a connection failure.
7+
//
8+
// - Get the address list from the server and reconfigure it for use in
9+
// MultiConnection.
10+
//
11+
// Since: 1.5
112
package multi
213

314
import (

0 commit comments

Comments
 (0)