Skip to content

Commit

Permalink
[docs] Add server.engine.generateId attribute (socketio#2880)
Browse files Browse the repository at this point in the history
  • Loading branch information
efkan authored and darrachequesne committed Mar 29, 2017
1 parent e4adb0e commit a3e5731
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/API.md
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

0 comments on commit a3e5731

Please sign in to comment.