Search
Preparing search index...
The search index is not available
Detritus Client
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
ClusterProcessChild
Class ClusterProcessChild
Hierarchy
EventSpewer
ClusterProcessChild
Implements
EventEmitter
Index
Constructors
constructor
Properties
_shards
Identifying
cluster
cluster
Count
cluster
Id
Methods
add
Listener
broadcast
Eval
emit
event
Names
get
Max
Listeners
has
Event
Listener
listener
Count
listeners
off
on
on
Message
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
All
Subscriptions
remove
Listener
remove
Subscription
send
sendIPC
sendIPCOr
Warn
set
Max
Listeners
subscribe
Constructors
constructor
new
Cluster
Process
Child
(
cluster
:
ClusterClient
)
:
ClusterProcessChild
Parameters
cluster:
ClusterClient
Returns
ClusterProcessChild
Properties
_shards
Identifying
_shards
Identifying
:
BaseSet
<
number
>
= new BaseSet<number>()
cluster
cluster
:
ClusterClient
cluster
Count
cluster
Count
:
number
= 1
cluster
Id
cluster
Id
:
number
= -1
Methods
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
broadcast
Eval
broadcast
Eval
(
code
:
Function
|
string
,
...
args
:
any
[]
)
:
Promise
<
Array
<
any
>
>
Parameters
code:
Function
|
string
Rest
...
args:
any
[]
Returns
Promise
<
Array
<
any
>
>
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
has
Event
Listener
has
Event
Listener
(
name
:
string
|
symbol
)
:
boolean
Parameters
name:
string
|
symbol
Returns
boolean
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
[]
off
off
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
on
on
(
event
:
string
|
symbol
, listener
:
function
)
:
this
on
(
event
:
"ipc"
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"ipc"
listener:
function
(
message
:
any
)
:
any
Parameters
message:
any
Returns
any
Returns
this
on
Message
on
Message
(
message
:
IPCMessage
|
any
)
:
Promise
<
void
>
Parameters
message:
IPCMessage
|
any
Returns
Promise
<
void
>
once
once
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
remove
All
Listeners
remove
All
Listeners
(
name
?:
string
|
symbol
)
:
this
Parameters
Optional
name:
string
|
symbol
Returns
this
remove
All
Subscriptions
remove
All
Subscriptions
(
)
:
this
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
remove
Subscription
remove
Subscription
(
subscription
:
EventSubscription
)
:
void
Parameters
subscription:
EventSubscription
Returns
void
send
send
(
message
:
IPCMessage
|
any
)
:
Promise
<
void
>
Parameters
message:
IPCMessage
|
any
Returns
Promise
<
void
>
sendIPC
sendIPC
(
op
:
number
, data
?:
any
, request
?:
boolean
, shard
?:
undefined
|
number
)
:
Promise
<
void
>
Parameters
op:
number
Default value
data:
any
= null
Default value
request:
boolean
= false
Optional
shard:
undefined
|
number
Returns
Promise
<
void
>
sendIPCOr
Warn
sendIPCOr
Warn
(
op
:
number
, data
?:
any
, request
?:
boolean
, shard
?:
undefined
|
number
)
:
Promise
<
void
>
Parameters
op:
number
Default value
data:
any
= null
Default value
request:
boolean
= false
Optional
shard:
undefined
|
number
Returns
Promise
<
void
>
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
subscribe
subscribe
(
name
:
string
|
symbol
, listener
:
function
)
:
EventSubscription
Parameters
name:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
EventSubscription
Globals
Cluster
Process
Child
constructor
_shards
Identifying
cluster
cluster
Count
cluster
Id
add
Listener
broadcast
Eval
emit
event
Names
get
Max
Listeners
has
Event
Listener
listener
Count
listeners
off
on
on
Message
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
All
Subscriptions
remove
Listener
remove
Subscription
send
sendIPC
sendIPCOr
Warn
set
Max
Listeners
subscribe
Generated using
TypeDoc