Documentation

This commit is contained in:
Peter 'Pita' Martischka 2011-05-30 15:53:11 +01:00
parent 88297a99ef
commit f7b46f6e69
22 changed files with 368 additions and 447 deletions

View file

@ -1,48 +1,28 @@
#MessageHandler
# MessageHandler
`require("./MessageHandler");`
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The MessageHandler handles all Messages that comes from Socket.IO and controls the sessions
##Functions
## Functions
###handleConnect (client)
### handleConnect (client)
Handles the connection of a new user
* **client** the new client
###handleDisconnect (client)
### handleDisconnect (client)
Handles the disconnection of a user
* **client** the client that leaves
###handleMessage (client, message)
### handleMessage (client, message)
Handles a message from a user
* **client** the client that send this message
* **message** the message from the client
###setSocketIO (socket_io)
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### setSocketIO (socket_io)
A associative array that translates a session to a pad
* **socket_io** The Socket
##Variables