docs: update links to the Socket.IO website
Some links were broken due to recent updates.
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# Emitting events
|
# Emitting events
|
||||||
|
|
||||||
See also: https://socket.io/docs/v3/emitting-events/
|
See also: https://socket.io/docs/v4/emitting-events/
|
||||||
|
|
||||||
**Table of content**
|
**Table of content**
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Socket socket = IO.socket("wss://example.com"); // OK, similar to the example ab
|
|||||||
Socket socket = IO.socket("192.168.0.1:1234"); // NOT OK, missing the scheme part
|
Socket socket = IO.socket("192.168.0.1:1234"); // NOT OK, missing the scheme part
|
||||||
```
|
```
|
||||||
|
|
||||||
The path represents the [Namespace](https://socket.io/docs/v3/namespaces/), and not the actual path (see [below](#path)) of the HTTP requests:
|
The path represents the [Namespace](https://socket.io/docs/v4/namespaces/), and not the actual path (see [below](#path)) of the HTTP requests:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
Socket socket = IO.socket(URI.create("https://example.com")); // the main namespace
|
Socket socket = IO.socket(URI.create("https://example.com")); // the main namespace
|
||||||
@@ -76,7 +76,7 @@ Whether to create a new Manager instance.
|
|||||||
|
|
||||||
A Manager instance is in charge of the low-level connection to the server (established with HTTP long-polling or WebSocket). It handles the reconnection logic.
|
A Manager instance is in charge of the low-level connection to the server (established with HTTP long-polling or WebSocket). It handles the reconnection logic.
|
||||||
|
|
||||||
A Socket instance is the interface which is used to sends events to — and receive events from — the server. It belongs to a given [namespace](https://socket.io/docs/v3/namespaces).
|
A Socket instance is the interface which is used to sends events to — and receive events from — the server. It belongs to a given [namespace](https://socket.io/docs/v4/namespaces).
|
||||||
|
|
||||||
A single Manager can be attached to several Socket instances.
|
A single Manager can be attached to several Socket instances.
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ IO.Options options = IO.Options.builder()
|
|||||||
Socket socket = IO.socket(URI.create("https://example.com"), options);
|
Socket socket = IO.socket(URI.create("https://example.com"), options);
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: in that case, sticky sessions are not required on the server side (more information [here](https://socket.io/docs/v3/using-multiple-nodes/)).
|
Note: in that case, sticky sessions are not required on the server side (more information [here](https://socket.io/docs/v4/using-multiple-nodes/)).
|
||||||
|
|
||||||
#### `upgrade`
|
#### `upgrade`
|
||||||
|
|
||||||
@@ -177,7 +177,7 @@ IO.Options options = IO.Options.builder()
|
|||||||
Socket socket = IO.socket(URI.create("https://example.com"), options);
|
Socket socket = IO.socket(URI.create("https://example.com"), options);
|
||||||
```
|
```
|
||||||
|
|
||||||
Please note that this is different from the path in the URI, which represents the [Namespace](https://socket.io/docs/v3/namespaces/).
|
Please note that this is different from the path in the URI, which represents the [Namespace](https://socket.io/docs/v4/namespaces/).
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
@@ -274,7 +274,7 @@ These settings are specific to the given Socket instance.
|
|||||||
|
|
||||||
Default value: -
|
Default value: -
|
||||||
|
|
||||||
Credentials that are sent when accessing a namespace (see also [here](https://socket.io/docs/v3/middlewares/#Sending-credentials)).
|
Credentials that are sent when accessing a namespace (see also [here](https://socket.io/docs/v4/middlewares/#sending-credentials)).
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
| Client version | Socket.IO server |
|
| Client version | Socket.IO server |
|
||||||
| -------------- | ---------------- |
|
| -------------- | ---------------- |
|
||||||
| 0.9.x | 1.x |
|
| 0.9.x | 1.x |
|
||||||
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-initialization/#allowEIO3)) |
|
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) |
|
||||||
| 2.x | 3.x / 4.x |
|
| 2.x | 3.x / 4.x |
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Listening to events
|
# Listening to events
|
||||||
|
|
||||||
See also: https://socket.io/docs/v3/listening-to-events/
|
See also: https://socket.io/docs/v4/listening-to-events/
|
||||||
|
|
||||||
**Table of content**
|
**Table of content**
|
||||||
|
|
||||||
|
|||||||
@@ -7,12 +7,12 @@ Here is the compatibility table:
|
|||||||
| Java client version | Socket.IO server |
|
| Java client version | Socket.IO server |
|
||||||
| -------------- | ---------------- |
|
| -------------- | ---------------- |
|
||||||
| 0.9.x | 1.x |
|
| 0.9.x | 1.x |
|
||||||
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-initialization/#allowEIO3)) |
|
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) |
|
||||||
| 2.x | 3.x / 4.x |
|
| 2.x | 3.x / 4.x |
|
||||||
|
|
||||||
**Important note:** due to the backward incompatible changes to the Socket.IO protocol, a 2.x Java client will not be able to reach a 2.x server, and vice-versa
|
**Important note:** due to the backward incompatible changes to the Socket.IO protocol, a 2.x Java client will not be able to reach a 2.x server, and vice-versa
|
||||||
|
|
||||||
Since the Java client matches the Javascript client quite closely, most of the changes listed in the migration guide [here](https://socket.io/docs/v3/migrating-from-2-x-to-3-0) also apply to the Java client:
|
Since the Java client matches the Javascript client quite closely, most of the changes listed in the migration guide [here](https://socket.io/docs/v4/migrating-from-2-x-to-3-0) also apply to the Java client:
|
||||||
|
|
||||||
- [A middleware error will now emit an Error object](#A_middleware_error_will_now_emit_an_Error_object)
|
- [A middleware error will now emit an Error object](#A_middleware_error_will_now_emit_an_Error_object)
|
||||||
- [The Socket `query` option is renamed to `auth`](#The_Socket_query_option_is_renamed_to_auth)
|
- [The Socket `query` option is renamed to `auth`](#The_Socket_query_option_is_renamed_to_auth)
|
||||||
|
|||||||
@@ -113,7 +113,7 @@ socket.on("data", new Emitter.Listener() {
|
|||||||
|
|
||||||
### `Socket.EVENT_CONNECT_ERROR`
|
### `Socket.EVENT_CONNECT_ERROR`
|
||||||
|
|
||||||
This event is fired when the server does not accept the connection (in a [middleware function](https://socket.io/docs/v3/middlewares/#Sending-credentials)).
|
This event is fired when the server does not accept the connection (in a [middleware function](https://socket.io/docs/v4/middlewares/#sending-credentials)).
|
||||||
|
|
||||||
You need to manually reconnect. You might need to update the credentials:
|
You need to manually reconnect. You might need to update the credentials:
|
||||||
|
|
||||||
@@ -144,7 +144,7 @@ Here is the list of possible reasons:
|
|||||||
|
|
||||||
Reason | Description
|
Reason | Description
|
||||||
------ | -----------
|
------ | -----------
|
||||||
`io server disconnect` | The server has forcefully disconnected the socket with [socket.disconnect()](https://socket.io/docs/v3/server-api/#socket-disconnect-close)
|
`io server disconnect` | The server has forcefully disconnected the socket with [socket.disconnect()](https://socket.io/docs/v4/server-api/#socketdisconnectclose)
|
||||||
`io client disconnect` | The socket was manually disconnected using `socket.disconnect()`
|
`io client disconnect` | The socket was manually disconnected using `socket.disconnect()`
|
||||||
`ping timeout` | The server did not respond in the `pingTimeout` range
|
`ping timeout` | The server did not respond in the `pingTimeout` range
|
||||||
`transport close` | The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)
|
`transport close` | The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)
|
||||||
|
|||||||
Reference in New Issue
Block a user