WebCola
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Worker
Address
Cluster
Worker
is
Master
is
Worker
settings
worker
workers
default
Max
Listeners
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
listener
Count
Cluster
Settings
Cluster
Setup
Master
Settings
is
Master
is
Worker
settings
worker
workers
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
Hierarchy
EventEmitter
Cluster
Index
Properties
Worker
is
Master
is
Worker
settings
worker
workers
default
Max
Listeners
Methods
add
Listener
disconnect
emit
event
Names
fork
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
remove
All
Listeners
remove
Listener
set
Max
Listeners
setup
Master
listener
Count
Properties
Worker
Worker
:
Worker
is
Master
is
Master
:
boolean
is
Worker
is
Worker
:
boolean
settings
settings
:
ClusterSettings
worker
worker
:
Worker
workers
workers
:
object
Type declaration
[
index:
string
]:
Worker
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
add
Listener
(
event
:
"disconnect"
, listener
:
function
)
add
Listener
(
event
:
"exit"
, listener
:
function
)
add
Listener
(
event
:
"fork"
, listener
:
function
)
add
Listener
(
event
:
"listening"
, listener
:
function
)
add
Listener
(
event
:
"message"
, listener
:
function
)
add
Listener
(
event
:
"online"
, listener
:
function
)
add
Listener
(
event
:
"setup"
, listener
:
function
)
events.EventEmitter
disconnect
exit
fork
listening
message
online
setup
Parameters
event:
string
listener:
Function
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
disconnect
disconnect
(
callback
?:
Function
)
:
void
Parameters
Optional
callback:
Function
Returns
void
emit
emit
(
event
:
string
, listener
:
Function
)
:
boolean
emit
(
event
:
"disconnect"
, listener
:
function
)
:
boolean
emit
(
event
:
"exit"
, listener
:
function
)
:
boolean
emit
(
event
:
"fork"
, listener
:
function
)
:
boolean
emit
(
event
:
"listening"
, listener
:
function
)
:
boolean
emit
(
event
:
"message"
, listener
:
function
)
:
boolean
emit
(
event
:
"online"
, listener
:
function
)
:
boolean
emit
(
event
:
"setup"
, listener
:
function
)
:
boolean
Parameters
event:
string
listener:
Function
Returns
boolean
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
boolean
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Returns
boolean
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
boolean
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Returns
boolean
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Returns
boolean
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Returns
boolean
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
Returns
boolean
event
Names
event
Names
(
)
:
string
|
symbol
Returns
string
|
symbol
fork
fork
(
env
?:
any
)
:
Worker
Parameters
Optional
env:
any
Returns
Worker
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
on
on
(
event
:
string
, listener
:
Function
)
on
(
event
:
"disconnect"
, listener
:
function
)
on
(
event
:
"exit"
, listener
:
function
)
on
(
event
:
"fork"
, listener
:
function
)
on
(
event
:
"listening"
, listener
:
function
)
on
(
event
:
"message"
, listener
:
function
)
on
(
event
:
"online"
, listener
:
function
)
on
(
event
:
"setup"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
once
once
(
event
:
string
, listener
:
Function
)
once
(
event
:
"disconnect"
, listener
:
function
)
once
(
event
:
"exit"
, listener
:
function
)
once
(
event
:
"fork"
, listener
:
function
)
once
(
event
:
"listening"
, listener
:
function
)
once
(
event
:
"message"
, listener
:
function
)
once
(
event
:
"online"
, listener
:
function
)
once
(
event
:
"setup"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
Function
)
prepend
Listener
(
event
:
"disconnect"
, listener
:
function
)
prepend
Listener
(
event
:
"exit"
, listener
:
function
)
prepend
Listener
(
event
:
"fork"
, listener
:
function
)
prepend
Listener
(
event
:
"listening"
, listener
:
function
)
prepend
Listener
(
event
:
"message"
, listener
:
function
)
prepend
Listener
(
event
:
"online"
, listener
:
function
)
prepend
Listener
(
event
:
"setup"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
prepend
Once
Listener
(
event
:
"disconnect"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"exit"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"fork"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"listening"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"message"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"online"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"setup"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"disconnect"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"exit"
listener:
function
(
worker
:
Worker
, code
:
number
, signal
:
string
)
:
void
Parameters
worker:
Worker
code:
number
signal:
string
Returns
void
Parameters
event:
"fork"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"listening"
listener:
function
(
worker
:
Worker
, address
:
Address
)
:
void
Parameters
worker:
Worker
address:
Address
Returns
void
Parameters
event:
"message"
listener:
function
(
worker
:
Worker
, message
:
any
, handle
:
Socket
|
Server
)
:
void
Parameters
worker:
Worker
message:
any
handle:
Socket
|
Server
Returns
void
Parameters
event:
"online"
listener:
function
(
worker
:
Worker
)
:
void
Parameters
worker:
Worker
Returns
void
Parameters
event:
"setup"
listener:
function
(
settings
:
any
)
:
void
Parameters
settings:
any
Returns
void
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
Parameters
Optional
event:
string
|
symbol
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
Function
)
Parameters
event:
string
|
symbol
listener:
Function
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
Parameters
n:
number
setup
Master
setup
Master
(
settings
?:
ClusterSetupMasterSettings
)
:
void
Parameters
Optional
settings:
ClusterSetupMasterSettings
Returns
void
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
events.EventEmitter