Class: Client

Spacebrew. Client

new Client

Spacebrew client!
Parameters:
Name Type Description
server String (Optional) Address of Spacebrew server. Checks "server" query string if not passed; defaults to localhost
name String (Optional) Name of app. Checks "name" query string if not passed; defaults to window.location.href
description String (Optional) Description of app. Defaults to "";
Source:
  • sb.js, line 35

Members

description :String

Description of your app
Source:
  • sb.js, line 61

isConnected :Boolean

Are we connected to a Spacebrew server?
Source:
  • sb.js, line 71

name :String

Name of app
Source:
  • sb.js, line 55

socket :WebSocket

Reference to WebSocket
Source:
  • sb.js, line 40

Methods

addPublish

Add a route you are publishing on
Parameters:
Name Type Description
name String Name of incoming route
type String "boolean", "range", or "string"
def String default value
Source:
  • sb.js, line 125

addSubscribe

[addSubscriber description]
Parameters:
Name Type Description
name String Name of outgoing route
type String "boolean", "range", or "string"
Source:
  • sb.js, line 137

connect

Connect to Spacebrew
Source:
  • sb.js, line 78

onBooleanMessage

Override in your app to receive "boolean" messages, e.g. sb.onBooleanMessage = yourBoolFunction
Parameters:
Name Type Description
name String Name of incoming route
value String [description]
Source:
  • sb.js, line 106

onRangeMessage

Override in your app to receive "range" messages, e.g. sb.onRangeMessage = yourRangeFunction
Parameters:
Name Type Description
name String Name of incoming route
value String [description]
Source:
  • sb.js, line 97

onStringMessage

Override in your app to receive "string" messages, e.g. sb.onStringMessage = yourStringFunction
Parameters:
Name Type Description
name String Name of incoming route
value String [description]
Source:
  • sb.js, line 115

send

Send a route to Spacebrew
Parameters:
Name Type Description
name String Name of outgoing route (must match something in addPublish)
type String "boolean", "range", or "string"
value String Value to send
Source:
  • sb.js, line 159