Skip to content

Commit

Permalink
README: improved getters/setters docs and added Adaptor section
Browse files Browse the repository at this point in the history
  • Loading branch information
rauchg committed Dec 18, 2012
1 parent b4f12ea commit 2e5fdb6
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,22 @@ io.on('connection', function(){ // … });
io.attach(http);
```
If no arguments are supplied this method returns the current value.
### Server#path(v:String):Server
Sets the path `v` under which `engine.io` and the static files will be
served. Defaults to `/socket.io`.
If no arguments are supplied this method returns the current value.
### Server#adaptor(v:Adaptor):Server
Sets the adaptor `v`. Defaults to an instance of the `Adaptor` that
ships with socket.io which is memory based (see below).
If no arguments are supplied this method returns the current value.
### Server#sockets:Namespace
The default (`/`) namespace.
Expand Down Expand Up @@ -165,6 +176,15 @@ io.on('connection', function(){ // … });
connection. A `Client` can be associated with many multiplexed `Socket`
that belong to different `Namespace`s.
### Adaptor
The `Adaptor` is in charge of keeping track of what rooms each socket
is connected to, and passing messages to them.
By default the `Adaptor` is memory based. In order to pass messages
across multiple processes, make sure to use an appropriate adaptor
(configurable through `Server#adaptor`).
## License
MIT

0 comments on commit 2e5fdb6

Please sign in to comment.