Skip to content

Commit a44b50d

Browse files
committed
readme: move description of multiple connections to comment
Part of #123
1 parent 3e084d4 commit a44b50d

File tree

2 files changed

+10
-15
lines changed

2 files changed

+10
-15
lines changed

README.md

-15
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

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
// Package with methods to work with a Tarantool cluster.
2+
//
3+
// Main features:
4+
//
5+
// - Check active connection with configurable time interval and on connection
6+
// fail switch to next in pool.
7+
//
8+
// - Get addresses list from server and reconfigure to use in MultiConnection.
9+
//
10+
// Since: 1.5
111
package multi
212

313
import (

0 commit comments

Comments
 (0)