Skip to content

Commit f2415a2

Browse files
DOC-634: 1st pass at client protocol doc conversion and import [v/5.6] (#1951)
Backport of #1947 Converts internal .md template into .adoc and manually removes version history and copyright notice (changes should be made in source doc for future). No copy review. Co-authored-by: Oliver Howell <[email protected]>
1 parent 38a443c commit f2415a2

File tree

3 files changed

+27539
-1
lines changed

3 files changed

+27539
-1
lines changed

docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,7 @@
514514
515515
.Clients and APIs
516516
* xref:clients:client-overview.adoc[Overview]
517+
** xref:clients:client-protocol.adoc[]
517518
* Clients
518519
** xref:clients:java.adoc[]
519520
** xref:clients:dotnet.adoc[]

docs/modules/clients/pages/client-overview.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ see the link:https://hazelcast.com/developers/clients/?utm_source=docs-website[c
1212

1313
Hazelcast provides clients and programming language APIs to interact with Hazelcast clusters and leverage their distributed computing capabilities. The choice between using a client or an API depends on your specific use case, performance requirements, and the programming languages you're using in your project. The following examines the key differences and considerations.
1414

15-
NOTE: *Clients* refer to the Hazelcast _libraries_ used to connect to a Hazelcast cluster and exchange data. Clients use a binary protocol for communication with the cluster and encode the data in various formats such as Compact, JSON, etc. Clients are available in various programming languages.
15+
NOTE: *Clients* refer to the Hazelcast _libraries_ used to connect to a Hazelcast cluster and exchange data. Clients use a xref:clients:client-protocol.adoc[binary protocol] for communication with the cluster and encode the data in various formats such as Compact, JSON, etc. Clients are available in various programming languages.
1616
*APIs*, by comparison, are the _interfaces_ with the Hazelcast platform. These do not require the use of specific libraries to connect and are generally text based — for example, the REST interface.
1717

1818
=== Clients
1919

2020
Hazelcast clients must be installed locally to communicate with the server.
2121

22+
NOTE: For detailed information on the client protocol used, see xref:clients:client-protocol.adoc[].
23+
2224
==== Benefits of using Hazelcast clients
2325

2426
* Language flexibility: Hazelcast offers clients in multiple programming languages, allowing you to use Hazelcast in various environments.
@@ -86,4 +88,5 @@ For detailed information and code samples for each client, see:
8688
For help getting started with the Hazelcast clients, see the client tutorials in xref:clients:hazelcast-clients.adoc[Get started with a Hazelcast Client].
8789

8890
For details about using Memcache to communicate directly with a Hazelcast cluster, see xref:memcache.adoc[Memcache].
91+
8992
For information about using the REST API for simple operations, see: xref:rest.adoc[REST].

0 commit comments

Comments
 (0)