Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding namespace.engine.generateId option #2880

Merged
merged 4 commits into from
Mar 29, 2017
Merged

Adding namespace.engine.generateId option #2880

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8985827
Adding namespace.engine.generateId option
efkan Feb 27, 2017
9051113
Update API.md
efkan Mar 2, 2017
f8358f1
minor fix
darrachequesne Mar 29, 2017
e8245dd
fix link
darrachequesne Mar 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [new Server(port[, options])](#new-serverport-options)
- [new Server(options)](#new-serveroptions)
- [server.sockets](#serversockets)
- [server.engine.generateId](#serverenginegenerateid)
- [server.serveClient([value])](#serverserveclientvalue)
- [server.path([value])](#serverpathvalue)
- [server.adapter([value])](#serveradaptervalue)
Expand Down Expand Up @@ -225,6 +226,18 @@ server.listen(PORT); // PORT is free to use
io = Server(server);
```

#### server.engine.generateId

Overwrites the default method to generate your custom socket id.

The function is called with a node request object (`http.IncomingMessage`) as first parameter.

```js
io.engine.generateId = function (req) {
return "custom:id:" + custom_id++; // custom id must be unique
}
```

### Namespace

Represents a pool of sockets connected under a given scope identified
Expand Down