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
This SDK version is compatible with Kuzzle 1.0.0-beta.1 and higher
7
+
This SDK version is compatible with Kuzzle 1.0.0-RC5 and higher
8
+
9
+
Please use SDK v1.x for earlier versions of Kuzzle.
8
10
9
11
## About Kuzzle
10
12
@@ -13,18 +15,38 @@ For UI and linked objects developers, Kuzzle is an open-source solution that han
13
15
You can access the Kuzzle repository on [Github](https://github.com/kuzzleio/kuzzle)
14
16
15
17
*[SDK Documentation](#sdk-documentation)
18
+
*[Protocols used](#protocols-used)
16
19
*[Installation](#installation)
17
20
*[NodeJS](#nodejs)
18
21
*[Basic usage](#basic-usage-node)
19
22
*[Javascript](#javascript)
20
23
*[Basic usage](#basic-usage-js)
21
24
*[Building manually](#building-manually)
25
+
*[Migrating from SDK v1.x](#migrating-from-sdk-v1.x)
22
26
*[License](#license)
23
27
24
28
## SDK Documentation
25
29
26
30
The complete SDK documentation is available [here](http://kuzzleio.github.io/sdk-documentation)
27
31
32
+
## Protocols used
33
+
34
+
The SDK Javascript implements two network protocols: raw WebSocket, and [Socket.IO](http://socket.io/)
35
+
The main reason behind this is that while Socket.IO offers better compatibility with older web browsers, our raw WebSocket implementation is about 20% faster
36
+
37
+
For this reason, there is a slight difference with the [generic SDK documentation](http://kuzzleio.github.io/sdk-documentation): instead of 1 available `port` option, there are actually a `wsPort` and a `ioPort` options.
38
+
These options are defaulted to Kuzzle default protocol plugins.
39
+
40
+
What protocol is used when you connect to Kuzzle depends on multiple factors:
41
+
42
+
#### NodeJS
43
+
44
+
The protocol used is always raw WebSocket.
45
+
46
+
#### Web Browsers
47
+
48
+
The SDK will first try to use raw WebSocket to connect to Kuzzle. If the web browser does not support this protocol, then the SDK falls back to Socket.IO
49
+
28
50
## Installation
29
51
30
52
This SDK can be used either in NodeJS or in a browser.
Clone this github repository and run ``grunt``. A ``dist`` directory will be created, containing a plain browserified version of this SDK, and a minified version.
121
143
144
+
## Migrating from SDK v1.x
145
+
146
+
* Kuzzle constructor has been changed. Instead of an URL, you have to provide a resolvable server name, or an IP address. If you need to specify a port different than the provided default values, you can do so using these two new options: `wsPort` (WebSocket port) and `ioPort` (Socket.IO port)
0 commit comments