Skip to content

Commit

Permalink
Remove IMDG documentation references (#994)
Browse files Browse the repository at this point in the history
Replace IMDG documentation links to latest Hazelcast documentation
  • Loading branch information
JackPGreen authored Jul 18, 2024
1 parent e7a9621 commit 3b0a8a1
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion flake_id_generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion proxy_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions proxy_map.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion proxy_multi_map.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion proxy_pn_counter.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion proxy_queue.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion proxy_replicated_map.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion proxy_set.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions serialization/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 3b0a8a1

Please sign in to comment.