Skip to content

Commit c2189e8

Browse files
authored
Minor godoc updates (#24)
1 parent 3f5dbe5 commit c2189e8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

coherence/doc.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Coherence Cluster using Google's gRPC framework for the network transport.
1111
Your cluster must be running Coherence Community Edition (CE) 22.06.4+ or Coherence commercial
1212
version 14.1.1.2206.4+ and must be running a gRPC Proxy.
1313
14-
This API provides two types of caches, [NamedMap] and [NamedCache]. [NamedCache] is syntactically identical in behaviour to a [NamedMap],
14+
Two interfaces, [NamedMap] and [NamedCache], are available to access Coherence caches. [NamedCache] is syntactically identical in behaviour to a [NamedMap],
1515
but additionally implements the PutWithExpiry operation.
1616
1717
# Introduction
@@ -29,11 +29,11 @@ The Coherence Go client provides the following features:
2929
3030
For more information on Coherence caches, please see the [Coherence Documentation].
3131
32-
# Supported Go Versions
32+
# Supported Go versions
3333
3434
This API fully supports Go Generics and is only supported for use with Go versions 1.19 and above.
3535
36-
# Obtaining an instance of a NamedMap
36+
# Obtaining a NamedMap or NamedCache
3737
3838
New [NamedMap] instances are constructed using the Session APIs.
3939
@@ -77,7 +77,7 @@ If you wish to create a [NamedCache], which supports expiry, you can use the fol
7777
7878
See [SessionOptions] which lists all the options supported by the [Session] API.
7979
80-
# Storing/retrieving/removing a value to/from a NamedMap
80+
# Basic CRUD operations
8181
8282
Note: See the [examples] on GitHub for detailed examples.
8383
@@ -167,7 +167,7 @@ if you wish to store structs as native Java objects, then please see the section
167167
}
168168
fmt.Println("Person is", *person)
169169
170-
# Working with streaming filtered and un-filtered results using channels
170+
# Querying and filtering using channels
171171
172172
Channels are used to deal with individual keys, values or entries
173173
streamed from the backend using a filter or an open query. Depending
@@ -239,7 +239,7 @@ run various scenarios to increase peoples salary by using a [processors.Multiply
239239
}
240240
}
241241
242-
# Aggregating results
242+
# Aggregating cache data
243243
244244
Aggregators can be used to perform operations against a subset of entries to obtain a single result.
245245
Entry aggregation occurs in parallel across the grid to provide map-reduce support when working with
@@ -271,7 +271,7 @@ run various scenarios to perform aggregations.
271271
salaryResult, err = coherence.AggregateFilter[int, Person, []Person](ctx, namedMap, filters.Greater(age, 40),
272272
aggregators.TopN[float32, Person](extractors.Extract[float32]("salary"), false, 2))
273273
274-
# Responding to Map events
274+
# Responding to cache events
275275
276276
he Coherence Go Client provides the ability to add a [MapListener] that will receive events (inserts, updates, deletes)
277277
that occur against a [NamedMap] or [NamedCache]. You can listen for all events, events based upon a filter or
@@ -334,7 +334,7 @@ vents based upon a key.
334334
log.Fatal("unable to add listener", listener, err)
335335
}
336336
337-
# Responding to Cache Lifecycle events
337+
# Responding to cache lifecycle events
338338
339339
The Coherence Go Client provides the ability to add a [MapLifecycleListener] that will receive events (truncated and destroyed)
340340
that occur against a [NamedMap] or [NamedCache].
@@ -377,7 +377,7 @@ that occur against a [NamedMap] or [NamedCache].
377377
// Cache size is 1 truncating cache
378378
// **EVENT=Truncated: value=NamedMap{name=people, format=json}
379379
380-
# Responding to Session Lifecycle events
380+
# Responding to session lifecycle events
381381
382382
The Coherence Go Client provides the ability to add a [SessionLifecycleListener] that will receive events (connected, closed,
383383
disconnected or reconnected) that occur against the [Session].
@@ -422,7 +422,7 @@ in your main code, create a new [Session] and register the listener
422422
// 2023/01/31 11:15:38 closed session 59f3ec81-dda1-41b7-92de-70aad3d26615
423423
// **EVENT=session_closed: source=SessionID=59f3ec81-dda1-41b7-92de-70aad3d26615, closed=true, caches=0, maps=0
424424
425-
# Serializing to Java Objects on the Server
425+
# Serializing to Java objects on the server
426426
427427
By default, the Coherence Go client serializes any keys and values to JSON and then stores them as JsonObjects in Coherence.
428428
This is usually sufficient for most applications where you are only accessing your data via the Go Client.

0 commit comments

Comments
 (0)