Skip to content

Commit

Permalink
chore: add a section for configuring timeouts
Browse files Browse the repository at this point in the history
  • Loading branch information
buraksezer committed Nov 11, 2020
1 parent ae1ddc4 commit f403e56
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ failure detection and simple anti-entropy services. So it can be used as an ordi
* [Client-Server Mode](#client-server-mode)
* [Network Configuration](#network-configuration)
* [Service discovery](#service-discovery)
* [Timeouts](#timeouts)
* [Architecture](#architecture)
* [Overview](#overview)
* [Consistency and Replication Model](#consistency-and-replication-model)
Expand Down Expand Up @@ -973,6 +974,18 @@ We currently have a bunch of service discovery plugins for automatic peer discov

In order to get more info about installation and configuration of the plugins, see their GitHub page.

### Timeouts

Olric nodes supports setting `KeepAlivePeriod` on TCP sockets.

Server-side:

* **config.KeepAlivePeriod**: KeepAlivePeriod denotes whether the operating system should send keep-alive messages on the connection.

Client-side:

* **config.DialTimeout**: Timeout for TCP dial.

## Architecture

### Overview
Expand Down
2 changes: 1 addition & 1 deletion internal/transport/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (
"github.com/buraksezer/olric/internal/bufpool"
"github.com/buraksezer/olric/internal/flog"
"github.com/buraksezer/olric/internal/protocol"
multierror "github.com/hashicorp/go-multierror"
"github.com/hashicorp/go-multierror"
"github.com/pkg/errors"
)

Expand Down

0 comments on commit f403e56

Please sign in to comment.