Namespace socketbug
Socketbug Server
- Version v0.2.0 ( 6/29/2011 )
- Defined in: socketbug_server.js
Constructor Attributes | Constructor Name and Description |
---|---|
Socketbug - Web Socket Remote Debugging
Copyright (c) 2011 Manifest Interactive, LLC
Licensed under the LGPL v3 licenses.
|
Field Attributes | Field Name and Description |
---|---|
<private> <inner> |
Socketbug Configuration
|
<inner> |
Basic Functionality to Manage GUID's
|
<inner> |
Node.js Requirements
|
<inner> |
Setup Socket.io to Listen to Server
|
<inner> |
Build a Socket to Isolate the Application Layer
|
<inner> |
Build a Socket to Isolate the Application Layer
|
<inner> |
Build a Socket to Isolate the Application Layer
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
<inner> |
authorization(session_id)
Check Authorization of Session ID
|
<inner> |
authorize_application(socket, application)
Check Authorization of Application ID
|
<inner> |
authorize_group(socket, group)
Check Authorization of Group ID
|
Namespace Detail
socketbug
Socketbug - Web Socket Remote Debugging
Copyright (c) 2011 Manifest Interactive, LLC
Licensed under the LGPL v3 licenses.
Author: Website, Video Tutorials ( HD ), Twitter, Source Code, Support & Feature Requests.
Author: Website, Video Tutorials ( HD ), Twitter, Source Code, Support & Feature Requests.
Field Detail
<private> <inner>
{Object}
_socketbug
Socketbug Configuration
_socketbug._config._server_port ( Number ): 8080 This is your Socketbugs Server Port Number Where Socket.IO is Running
_socketbug._config._authorized_only._groups ( Boolean ): true Should Group Authentication Be Required? If this is set to true then all connections will have their Group ID authenticated on whatever server you specify below
_socketbug._config._authorized_only._applications ( Boolean ): true Should Application Authentication Be Required? If this is set to true then all connections will have their Application ID authenticated on whatever server you specify below
_socketbug._config._authorize._host ( String ): www.mywebsite.com Host URL ( NOTE: do not add http:// or a trailing / ) to Authentication Script. This can be any server. It does not have to be on the same server that Socketbug is installed on.
_socketbug._config._authorize._port ( Number ): 80 Port Number for your Authentication Script
_socketbug._config._authorize._path ( String ): /path/to/my/auth.script Path from root of Authentication Script. Basically, this gets appended to _socketbug._config._authorize._host to make a complete URL. ( NOTE: This should start with a / )
_socketbug._config._encryption_salt ( String ): Go0dp4$sW0rd SALT you would like to use for MD5 Hashing. This is the SAME SALT you will use throughout your Socketbug Communications.
_socketbug._groups ( Object ) Object to Store Socketbug Groups. You will not need to mess with this, it's just for storing connection info on Socketbug.
_socketbug._applications ( Object ) Object to Store Socketbug Applications. You will not need to mess with this, it's just for storing connection info on Socketbug.
_socketbug._clients ( Object ) Object to Store Socketbug Clients. You will not need to mess with this, it's just for storing connection info on Socketbug.
<inner>
GUID
Basic Functionality to Manage GUID's
<inner>
http
Node.js Requirements
<inner>
io
Setup Socket.io to Listen to Server
<inner>
sb_application
Build a Socket to Isolate the Application Layer
<inner>
sb_console
Build a Socket to Isolate the Application Layer
<inner>
sb_manager
Build a Socket to Isolate the Application Layer
Method Detail
-
<inner> authorization(session_id)Check Authorization of Session ID
- Parameters:
- {String} session_id
- This is the Socket.IO Session ID for Socketbug
- Returns:
- Boolean
-
<inner> authorize_application(socket, application)Check Authorization of Application ID
- Parameters:
- {Object} socket
- This is the Socket used by Socketbug
- {String} application
- This is the Application ID for Socketbug
-
<inner> authorize_group(socket, group)Check Authorization of Group ID
- Parameters:
- {Object} socket
- This is the Socket used by Socketbug
- {String} group
- This is the Group ID for Socketbug