You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove duplicate content from C++ Ref Manual & Readme
Following on from DOC-470 which moved install and getting started info
into the main docs site, this will remove the duplicate information from
the C++ Ref Manual & Readme files, and point to the docs for this
information
Copy file name to clipboardExpand all lines: README.md
+8-116Lines changed: 8 additions & 116 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,132 +32,24 @@ A cluster of Hazelcast nodes share both the data storage and computational load
32
32
When you add new nodes to the cluster, the data is automatically rebalanced across the cluster, and currently running
33
33
computational tasks (known as jobs) snapshot their state and scale with processing guarantees.
34
34
35
-
For more info, check out Hazelcast [repository](https://github.com/hazelcast/hazelcast).
35
+
For more information, see the Hazelcast [repository](https://github.com/hazelcast/hazelcast).
36
36
37
37
38
38
# Hazelcast C++ Client
39
39
40
-
hazelcast-cpp-client is the official C++ library API for using the Hazelcast in-memory database platform. It requires C++11 support.
40
+
hazelcast-cpp-client is the official C++ library API for using the Hazelcast in-memory database platform. It requires C++11 support.
41
41
42
+
For an introduction to the C++ client for Hazelcast, and information on how to install and get started with the client, see the [Hazelcast documentation](https://docs.hazelcast.com/hazelcast/latest/clients/cplusplus).
42
43
43
-
## Installation
44
-
### Hazelcast
45
-
Hazelcast C++ client requires a working Hazelcast cluster to run. This cluster handles the storage and
46
-
manipulation of the user data.
47
44
48
-
A Hazelcast cluster consists of one or more cluster members. These members generally run on multiple virtual or
49
-
physical machines and are connected to each other via the network. Any data put on the cluster is partitioned to
50
-
multiple members transparent to the user. It is therefore very easy to scale the system by adding new members as
51
-
the data grows. Hazelcast cluster also offers resilience. Should any hardware or software problem causes a crash
52
-
to any member, the data on that member is recovered from backups and the cluster continues to operate without any
53
-
downtime.
54
-
55
-
The quickest way to start a single member cluster for development purposes is to use our
You can also use our ZIP or TAR [distributions](https://hazelcast.com/open-source-projects/downloads/)
66
-
as described [here](Reference_Manual.md#12-starting-a-hazelcast-cluster).
67
-
68
-
### Client
69
-
70
-
#### Vcpkg Users
71
-
Hazelcast C++ client package is available for [Vcpkg](https://github.com/microsoft/vcpkg) users. The package name is `hazelcast-cpp-client`.
72
-
73
-
Please see [getting started](https://github.com/microsoft/vcpkg#getting-started) on how to use Vcpkg package manager with your application. In summary,
The above code snippet will install `hazelcast-cpp-client` with its `boost` and `openssl` dependencies.
91
-
92
-
After the installation, the library is available for usage. For example, if you are using CMake for your builds, you can use the following cmake build command with the `CMAKE_TOOLCHAIN_FILE` cmake option to be the `vcpkg.cmake`.
93
-
```bat
94
-
cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
95
-
cmake --build [build directory]
96
-
```
97
-
98
-
##### Other Methods
99
-
100
-
You can also install the hazelcast-cpp-client with [conan](https://conan.io/) and from source code. You can more information from [Reference Manual](Reference_Manual.md#11-installing).
101
-
102
-
## Overview
103
-
104
-
### Usage
105
-
106
-
There is an example project in the [sample_project](sample_project) directory. You can run the example as below:
107
-
108
-
If you use Linux or Mac:
109
-
110
-
```sh
111
-
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
112
-
cmake --build build
113
-
./build/client
114
-
```
115
-
116
-
If you use Windows:
117
-
118
-
```bat
119
-
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]\scripts\buildsystems\vcpkg.cmake && ^
120
-
cmake --build build && ^
121
-
.\build\Debug\client
122
-
```
123
-
124
-
The sample code creates a client, the client automatically connects to the cluster.
125
-
It creates a map named `personnel_map` and puts the records inside it.
126
-
It then gets all the entries from the cluster and prints them.
127
-
```c++
128
-
#include<hazelcast/client/hazelcast_client.h>
129
-
intmain() {
130
-
auto hz = hazelcast::new_client().get(); // Connects to the cluster
45
+
## Documentation
131
46
132
-
auto personnel = hz.get_map("personnel_map").get();
std::cout << "Added IT personnel. Logging all known personnel" << std::endl;
137
-
for (const auto &entry : personnel->entry_set<std::string, std::string>().get()) {
138
-
std::cout << entry.first << " is in " << entry.second << " department." << std::endl;
139
-
}
140
-
141
-
return 0;
142
-
}
143
-
```
144
-
145
-
## Features
146
-
147
-
* Distributed, partitioned and queryable in-memory key-value store implementation, called [Map](examples/distributed-map/basic/FillMap.cpp)
148
-
* Eventually consistent cache implementation to store a subset of the Map data locally in the memory of the client, called [Near Cache](examples/distributed-map/near-cache)
149
-
* Additional data structures and simple messaging constructs such as [Set](examples/distributed-collections/set), [MultiMap](examples/distributed-map/multimap/MultimapPut.cpp), [Queue](examples/distributed-collections/blockingqueue), [Topic](examples/distributed-topic)
150
-
* Cluster-wide unique ID generator, called [FlakeIdGenerator](examples/learning-basics/unique-names)
151
-
* Distributed, CRDT based counter, called [PNCounter](examples/distributed-primitives/crdt-pncounter)
152
-
* Distributed concurrency primitives from CP Subsystem such as [FencedLock](examples/cp/fenced_lock.cpp), [Semaphore](examples/cp/counting_semphore.cpp), [AtomicLong](examples/cp/atomic_long.cpp)
153
-
* Integration with [Viridian](https://viridian.hazelcast.com/) (Hazelcast Cloud)
154
-
* Support for serverless and traditional web service architectures with **Unisocket** and **Smart** operation modes
155
-
* Ability to listen to client lifecycle, cluster state and distributed data structure events
156
-
* and [many more](https://hazelcast.com/clients/cplusplus/#client-features).
47
+
For information about:
157
48
158
-
## Documentation
49
+
* how to install and get started with the client, see the [Hazelcast documentation](https://docs.hazelcast.com/hazelcast/latest/clients/cplusplus)
50
+
* how to configure and use the C++ client, see the [Reference Manual](https://github.com/hazelcast/hazelcast-cpp-client/blob/master/Reference_Manual.md)
51
+
* the API, see the [API reference](https://hazelcast.github.io/hazelcast-cpp-client/api-index.html)
159
52
160
-
You can find the detailed documentation at the [documentation site](https://hazelcast.github.io/hazelcast-cpp-client/doc-index.html) and the [API reference](https://hazelcast.github.io/hazelcast-cpp-client/api-index.html).
0 commit comments