Skip to content

Commit d8d975e

Browse files
docs: update links to the Socket.IO website
Some links were broken due to recent updates.
1 parent 08bc462 commit d8d975e

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

src/site/markdown/emitting_events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Emitting events
22

3-
See also: https://socket.io/docs/v3/emitting-events/
3+
See also: https://socket.io/docs/v4/emitting-events/
44

55
**Table of content**
66

src/site/markdown/initialization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Socket socket = IO.socket("wss://example.com"); // OK, similar to the example ab
2525
Socket socket = IO.socket("192.168.0.1:1234"); // NOT OK, missing the scheme part
2626
```
2727

28-
The path represents the [Namespace](https://socket.io/docs/v3/namespaces/), and not the actual path (see [below](#path)) of the HTTP requests:
28+
The path represents the [Namespace](https://socket.io/docs/v4/namespaces/), and not the actual path (see [below](#path)) of the HTTP requests:
2929

3030
```java
3131
Socket socket = IO.socket(URI.create("https://example.com")); // the main namespace
@@ -76,7 +76,7 @@ Whether to create a new Manager instance.
7676

7777
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.
7878

79-
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).
79+
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).
8080

8181
A single Manager can be attached to several Socket instances.
8282

@@ -131,7 +131,7 @@ IO.Options options = IO.Options.builder()
131131
Socket socket = IO.socket(URI.create("https://example.com"), options);
132132
```
133133

134-
Note: in that case, sticky sessions are not required on the server side (more information [here](https://socket.io/docs/v3/using-multiple-nodes/)).
134+
Note: in that case, sticky sessions are not required on the server side (more information [here](https://socket.io/docs/v4/using-multiple-nodes/)).
135135

136136
#### `upgrade`
137137

@@ -177,7 +177,7 @@ IO.Options options = IO.Options.builder()
177177
Socket socket = IO.socket(URI.create("https://example.com"), options);
178178
```
179179

180-
Please note that this is different from the path in the URI, which represents the [Namespace](https://socket.io/docs/v3/namespaces/).
180+
Please note that this is different from the path in the URI, which represents the [Namespace](https://socket.io/docs/v4/namespaces/).
181181

182182
Example:
183183

@@ -274,7 +274,7 @@ These settings are specific to the given Socket instance.
274274

275275
Default value: -
276276

277-
Credentials that are sent when accessing a namespace (see also [here](https://socket.io/docs/v3/middlewares/#Sending-credentials)).
277+
Credentials that are sent when accessing a namespace (see also [here](https://socket.io/docs/v4/middlewares/#sending-credentials)).
278278

279279
Example:
280280

src/site/markdown/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Client version | Socket.IO server |
44
| -------------- | ---------------- |
55
| 0.9.x | 1.x |
6-
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-initialization/#allowEIO3)) |
6+
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) |
77
| 2.x | 3.x / 4.x |
88

99
## Installation

src/site/markdown/listening_to_events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Listening to events
22

3-
See also: https://socket.io/docs/v3/listening-to-events/
3+
See also: https://socket.io/docs/v4/listening-to-events/
44

55
**Table of content**
66

src/site/markdown/migrating_from_1_x.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Here is the compatibility table:
77
| Java client version | Socket.IO server |
88
| -------------- | ---------------- |
99
| 0.9.x | 1.x |
10-
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-initialization/#allowEIO3)) |
10+
| 1.x | 2.x (or 3.1.x / 4.x with [`allowEIO3: true`](https://socket.io/docs/v4/server-options/#alloweio3)) |
1111
| 2.x | 3.x / 4.x |
1212

1313
**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
1414

15-
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:
15+
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:
1616

1717
- [A middleware error will now emit an Error object](#A_middleware_error_will_now_emit_an_Error_object)
1818
- [The Socket `query` option is renamed to `auth`](#The_Socket_query_option_is_renamed_to_auth)

src/site/markdown/socket_instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ socket.on("data", new Emitter.Listener() {
113113

114114
### `Socket.EVENT_CONNECT_ERROR`
115115

116-
This event is fired when the server does not accept the connection (in a [middleware function](https://socket.io/docs/v3/middlewares/#Sending-credentials)).
116+
This event is fired when the server does not accept the connection (in a [middleware function](https://socket.io/docs/v4/middlewares/#sending-credentials)).
117117

118118
You need to manually reconnect. You might need to update the credentials:
119119

@@ -144,7 +144,7 @@ Here is the list of possible reasons:
144144

145145
Reason | Description
146146
------ | -----------
147-
`io server disconnect` | The server has forcefully disconnected the socket with [socket.disconnect()](https://socket.io/docs/v3/server-api/#socket-disconnect-close)
147+
`io server disconnect` | The server has forcefully disconnected the socket with [socket.disconnect()](https://socket.io/docs/v4/server-api/#socketdisconnectclose)
148148
`io client disconnect` | The socket was manually disconnected using `socket.disconnect()`
149149
`ping timeout` | The server did not respond in the `pingTimeout` range
150150
`transport close` | The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)

0 commit comments

Comments
 (0)