JSDoc: Class: BoobstSocket

new BoobstSocket(options)

Boobst Socket

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Description
`port`	number	<optional>	port
`host`	string	<optional>	host

Properties:

Name	Type	Description
`callback`	function
`emit`	function

Source:

boobst.js, line 156

Extends

events.EventEmitter

Members

host :string

Host

Type:

string

Source:

boobst.js, line 183

id :number

Server's process id

Type:

number

Source:

boobst.js, line 161

onConnectionCallback :function

Type:

function

Source:

boobst.js, line 219

order

Returns next subscript based on current

Source:

boobst.js, line 645

port :number

Port

Type:

number

Source:

boobst.js, line 178

queue :Array

Commands queue

Type:

Array

Source:

boobst.js, line 173

saveObject

Save javascript-оbject in Cache'

Deprecated:

Source:

boobst.js, line 637

socket :net.Socket

Connection socket

Type:

net.Socket

Source:

boobst.js, line 194

version :number

Protocol varsion

Type:

number

Source:

boobst.js, line 167

Methods

blob(uri, stream, callbackopt)

Send binary data

Parameters:

Name	Type	Attributes	Description
`uri`	string		uri format is: file:// or global://
`stream`	Stream		data stream
`callback`	function	<optional>	callback

Source:

boobst.js, line 708

connect(callbackopt) → {boobst.BoobstSocket}

Connect to DB

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	callback

Source:

boobst.js, line 211

Returns:

Type: boobst.BoobstSocket

disconnect(callbackopt)

Disconnect from the db

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	callback

Source:

boobst.js, line 779

execute(name, outStreamopt, callback)

Execute routine

Parameters:

Name	Type	Attributes	Description
`name`	string		имя существующей команды
`outStream`	stream.Stream	<optional>	поток, в который пересылать ответ сервера
`callback`	function		callback

Source:

boobst.js, line 433

flush(callbackopt)

Clear the local namespace and set the server variables again

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	callback

Source:

boobst.js, line 729

get(name, subscriptopt, forceJSONopt, callback)

Get value

Parameters:

Name	Type	Attributes	Description
`name`	string		Name of variable or global node
`subscript`	Array.<string> \| boolean \| function	<optional>
`forceJSON`	boolean \| function	<optional>	force get JSON from node
`callback`	function		Callback-function (error, data)

Source:

boobst.js, line 484

kill(name, subscriptsopt, callbackopt)

Kill a global or a local

Parameters:

Name	Type	Attributes	Description
`name`	string
`subscripts`	Array.<string> \| function	<optional>
`callback`	function	<optional>	callback

Source:

boobst.js, line 688

ping(callbackopt)

Check server state

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>	callback

Source:

boobst.js, line 738

set(name, subscriptsopt, value, callbackopt, nullable) → {boobst.BoobstSocket|BoobstSocket}

Set the value of variable or global

Parameters:

Name	Type	Attributes	Description
`name`	string		variable or global name (global name starts with `^`)
`subscripts`	string \| Buffer \| Array.<string>	<optional>
`value`	string \| Buffer \| function \| number \| Date		variable value
`callback`	function	<optional> <nullable>	callback

Source:

boobst.js, line 536

Returns:

Type: boobst.BoobstSocket | BoobstSocket

xecute(xecute, outStreamopt, callback)

Evaluates any code on the server. Dangerous thing disabled on server by default

Parameters:

Name	Type	Attributes	Description
`xecute`	string		text to xecute
`outStream`	stream.Stream	<optional>	stream to send data
`callback`	function		callback

Source:

boobst.js, line 458

zn(name, callbackopt)

Changes namespace

Parameters:

Name	Type	Attributes	Description
`name`	string		existing namespace
`callback`	function	<optional>	callback

Source:

boobst.js, line 660