From 75d5a8e94a716e496cd8ab435f61013a6fddaa0a Mon Sep 17 00:00:00 2001 From: Burak Sezer Date: Sat, 3 Dec 2022 18:09:00 +0300 Subject: [PATCH] chore: Update README.md --- README.md | 27 +++++++++++++++++---------- olric.go | 2 +- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 97fa4bab..753fa710 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ See [Docker](#docker) and [Samples](#samples) sections to get started! Join our [Discord server!](https://discord.gg/ahK7Vjr8We) -The current production version is [v0.4.9](https://github.com/buraksezer/olric/tree/release/v0.4.0#olric-) +The current production version is [v0.5.0](https://github.com/buraksezer/olric/tree/release/v0.5.0#olric-) ### About versions @@ -31,8 +31,6 @@ Olric v0.4.x tree is going to receive bug fixes and security updates forever, bu This document only covers `v0.5`. See v0.4.x documents [here](https://github.com/buraksezer/olric/tree/release/v0.4.0#olric-). -**Important note**: Documenting `v0.5` is an ongoing effort. So some parts of this document may be wrong or inaccurate. - ## At a glance * Designed to share some transient, approximate, fast-changing data between servers, @@ -70,7 +68,8 @@ It's good at distributed caching and publish/subscribe messaging. * [Operation Modes](#operation-modes) * [Embedded Member](#embedded-member) * [Client-Server](#client-server) -* [Golang client](#golang-client) +* [Golang Client](#golang-client) +* [Cluster Events](#cluster-events) * [Commands](#commands) * [Distributed Map](#distributed-map) * [DM.PUT](#dmput) @@ -284,6 +283,20 @@ a better performance due to localization of the queries. See the client documentation on [pkg.go.dev](https://pkg.go.dev/github.com/buraksezer/olric@v0.5.0-rc.1) +## Cluster Events + +Olric can send push cluster events to `cluster.events` channel. Available cluster events: + +* node-join-event +* node-left-event +* fragment-migration-event +* fragment-received-even + +If you want to receive these events, set `true` to `EnableClusterEventsChannel` and subscribe to `cluster.events` channel. +The default is `false`. + +See [events/cluster_events.go](events/cluster_events.go) file to get more information about events. + ## Commands Olric uses Redis protocol and supports Redis-style commands to query the database. You can use any Redis client, including @@ -982,12 +995,6 @@ timeout and 0 for default. The default is config.DefaultReadTimeout Timeout for socket writes. If reached, commands will fail with a timeout instead of blocking. The default is config.DefaultWriteTimeout -##### config.KeepAlive - -KeepAlive specifies the interval between keep-alive probes for an active network connection. If zero, keep-alive probes -are sent with a default value (currently 15 seconds), if supported by the protocol and operating system. Network protocols -or operating systems that do not support keep-alives ignore this field. If negative, keep-alive probes are disabled. - ## Architecture ### Overview diff --git a/olric.go b/olric.go index a4fd2eb7..2882582a 100644 --- a/olric.go +++ b/olric.go @@ -57,7 +57,7 @@ import ( ) // ReleaseVersion is the current stable version of Olric -const ReleaseVersion string = "0.5.0-rc.1" +const ReleaseVersion string = "0.5.0" var ( // ErrOperationTimeout is returned when an operation times out.