From 3b0a8a1089e1eca9165e1b75e1fc2effdb899c1a Mon Sep 17 00:00:00 2001 From: Jack Green Date: Thu, 18 Jul 2024 15:02:29 +0100 Subject: [PATCH] Remove IMDG documentation references (#994) Replace IMDG documentation links to latest Hazelcast documentation --- flake_id_generator.go | 2 +- proxy_list.go | 2 +- proxy_map.go | 4 ++-- proxy_multi_map.go | 2 +- proxy_pn_counter.go | 2 +- proxy_queue.go | 2 +- proxy_replicated_map.go | 2 +- proxy_set.go | 2 +- serialization/doc.go | 8 ++++---- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/flake_id_generator.go b/flake_id_generator.go index 8885136f0..337e2fa1d 100644 --- a/flake_id_generator.go +++ b/flake_id_generator.go @@ -35,7 +35,7 @@ FlakeIDGenerator is a cluster-wide unique ID generator. Generated IDs are are k-ordered (roughly ordered) and in the range [0, math.MaxInt64]. They can be negative only if members are explicitly configured with a future epoch start value. -For details, see: https://docs.hazelcast.com/imdg/latest/data-structures/flake-id-generator.html +For details, see: https://docs.hazelcast.com/hazelcast/latest/data-structures/flake-id-generator Instead of asking cluster for each ID, they are fetched in batches and then served. Batch size and expiry duration can be configured via FlakeIDGeneratorConfig. diff --git a/proxy_list.go b/proxy_list.go index 55636af63..0df472368 100644 --- a/proxy_list.go +++ b/proxy_list.go @@ -36,7 +36,7 @@ List is not a partitioned Hazelcast data structure. So all the contents of the List are stored in a single machine (and in the backup). So, a single List will not scale by adding more members in the cluster. -For details, see https://docs.hazelcast.com/imdg/latest/data-structures/map.html +For details, see https://docs.hazelcast.com/hazelcast/latest/data-structures/map */ type List struct { *proxy diff --git a/proxy_map.go b/proxy_map.go index 7640f8ead..67a284590 100644 --- a/proxy_map.go +++ b/proxy_map.go @@ -37,7 +37,7 @@ import ( /* Map is a distributed map. Hazelcast Go client enables you to perform operations like reading and writing from/to a Hazelcast Map with methods like Get and Put. -For details, see https://docs.hazelcast.com/imdg/latest/data-structures/map.html +For details, see https://docs.hazelcast.com/hazelcast/latest/data-structures/map # Listening for Map Events @@ -75,7 +75,7 @@ Adding an event listener returns a subscription ID, which you can later use to r You can lock entries in a Map. When an entry is locked, only the owner of that lock can access that entry in the cluster until it is unlocked by the owner of force unlocked. -See https://docs.hazelcast.com/imdg/latest/data-structures/map.html#locking-maps for details. +See https://docs.hazelcast.com/hazelcast/latest/data-structures/locking-maps for details. Locks are reentrant. The owner of a lock can acquire the lock again without waiting for the lock to be unlocked. diff --git a/proxy_multi_map.go b/proxy_multi_map.go index ead0ebc66..301f919ee 100644 --- a/proxy_multi_map.go +++ b/proxy_multi_map.go @@ -35,7 +35,7 @@ For details, see https://docs.hazelcast.com/hazelcast/latest/data-structures/mul You can lock entries in a MultiMap. When an entry is locked, only the owner of that lock can access that entry in the cluster until it is unlocked by the owner of force unlocked. -See https://docs.hazelcast.com/imdg/latest/data-structures/map.html#locking-maps for details, usage is identical. +See https://docs.hazelcast.com/hazelcast/latest/data-structures/locking-maps for details, usage is identical. Locks are reentrant. The owner of a lock can acquire the lock again without waiting for the lock to be unlocked. diff --git a/proxy_pn_counter.go b/proxy_pn_counter.go index ac1282f6e..557db1188 100644 --- a/proxy_pn_counter.go +++ b/proxy_pn_counter.go @@ -54,7 +54,7 @@ If you have called the Reset function, a new session is started with the next in Note that The CRDT state is kept entirely on non-lite (data) members. If there aren't any and the methods here are invoked on a lite member, they will fail with hzerrors.ErrNoDataMember. -For details see https://docs.hazelcast.com/imdg/latest/data-structures/pn-counter.html +For details see https://docs.hazelcast.com/hazelcast/latest/data-structures/pn-counter */ type PNCounter struct { *proxy diff --git a/proxy_queue.go b/proxy_queue.go index 55b7fed8d..4f0a1b469 100644 --- a/proxy_queue.go +++ b/proxy_queue.go @@ -35,7 +35,7 @@ Queue is not a partitioned data-structure. All of the Queue content is stored in a single machine (and in the backup). Queue will not scale by adding more members in the cluster. -For details see https://docs.hazelcast.com/imdg/latest/data-structures/queue.html +For details see https://docs.hazelcast.com/hazelcast/latest/data-structures/queue */ type Queue struct { *proxy diff --git a/proxy_replicated_map.go b/proxy_replicated_map.go index 3f6a3fca4..0ac141566 100644 --- a/proxy_replicated_map.go +++ b/proxy_replicated_map.go @@ -34,7 +34,7 @@ import ( ReplicatedMap is a distributed key-value data structure where the data is replicated to all members in the cluster. It provides full replication of entries to all members for high speed access. -See https://docs.hazelcast.com/imdg/latest/data-structures/replicated-map.html for details. +See https://docs.hazelcast.com/hazelcast/latest/data-structures/replicated-map for details. */ type ReplicatedMap struct { *proxy diff --git a/proxy_set.go b/proxy_set.go index 9cdc146d7..f5f2487df 100644 --- a/proxy_set.go +++ b/proxy_set.go @@ -30,7 +30,7 @@ import ( Set is a concurrent, distributed set implementation. Hazelcast Set is a distributed set which does not allow duplicate elements. -For details, see: https://docs.hazelcast.com/imdg/latest/data-structures/set.html +For details, see: https://docs.hazelcast.com/hazelcast/latest/data-structures/set */ type Set struct { *proxy diff --git a/serialization/doc.go b/serialization/doc.go index f19f9c124..aaba610d5 100644 --- a/serialization/doc.go +++ b/serialization/doc.go @@ -246,7 +246,7 @@ For more information about compact serialization, check out https://docs.hazelca # Identified Data Serialization Hazelcast recommends implementing the Identified Data serialization for faster serialization of values. -See https://docs.hazelcast.com/imdg/latest/serialization/implementing-dataserializable.html#identifieddataserializable for details. +See https://docs.hazelcast.com/hazelcast/latest/serialization/implementing-identifieddataserializable for details. In order to be able to serialize/deserialize a custom type using Identified Data serialization, the type has to implement the serialization.IdentifiedDataSerializable interface and a factory which creates values of that type. The same factory can be used to create values of all Identified Data Serializable types with the same factory ID. @@ -311,7 +311,7 @@ Hazelcast stores meta information and uses the correct one to serialize and dese That enables rolling upgrades without shutting down the cluster. Also note that portable serialization is totally language independent and is used as the binary protocol between Hazelcast server and clients. -See https://docs.hazelcast.com/imdg/latest/serialization/implementing-portable-serialization.html for details. +See https://docs.hazelcast.com/hazelcast/latest/serialization/implementing-identifieddataserializable for details. In order to be able to serialize/deserialize a custom type using Portable serialization, the type has to implement the serialization.Portable interface and a factory which creates values of that type. The same factory can be used to create values of all Portable types with the same factory ID. @@ -366,7 +366,7 @@ In order to use the factory, you have to register it: Hazelcast has first class support for JSON. You can put/get JSON values and use them in queries. -See https://docs.hazelcast.com/imdg/latest/query/how-distributed-query-works.html#querying-json-strings for details. +See https://docs.hazelcast.com/hazelcast/latest/query/predicate-overview#querying-json-strings for details. The data type which is used during serializing/deserializing JSON data is serialization.JSON. It is in fact defined as []byte, but having a separate type helps the client to use the correct type ID when serializing/deserializing the value. @@ -397,7 +397,7 @@ Just make sure the retrieved value is of type serialization.JSON. # Custom Serialization Hazelcast lets you plug a custom serializer to be used for serialization of values. -See https://docs.hazelcast.com/imdg/latest/serialization/custom-serialization.html for details. +See https://docs.hazelcast.com/hazelcast/latest/serialization/custom-serialization for details. In order to use a custom serializer for a type, the type should implement serialization.Serializer interface. Here is an example: