WebCola
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Address
Info
Bind
Options
Remote
Info
Socket
default
Max
Listeners
add
Listener
add
Membership
address
bind
close
drop
Membership
emit
event
Names
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
ref
remove
All
Listeners
remove
Listener
send
set
Broadcast
set
Max
Listeners
set
Multicast
Loopback
set
MulticastTTL
setTTL
unref
listener
Count
Socket
Options
create
Socket
Hierarchy
EventEmitter
Socket
Index
Properties
default
Max
Listeners
Methods
add
Listener
add
Membership
address
bind
close
drop
Membership
emit
event
Names
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
ref
remove
All
Listeners
remove
Listener
send
set
Broadcast
set
Max
Listeners
set
Multicast
Loopback
set
MulticastTTL
setTTL
unref
listener
Count
Properties
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
add
Listener
(
event
:
"close"
, listener
:
function
)
add
Listener
(
event
:
"error"
, listener
:
function
)
add
Listener
(
event
:
"listening"
, listener
:
function
)
add
Listener
(
event
:
"message"
, listener
:
function
)
events.EventEmitter
close
error
listening
message
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"listening"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"message"
listener:
function
(
msg
:
Buffer
, rinfo
:
AddressInfo
)
:
void
Parameters
msg:
Buffer
rinfo:
AddressInfo
Returns
void
add
Membership
add
Membership
(
multicastAddress
:
string
, multicastInterface
?:
string
)
:
void
Parameters
multicastAddress:
string
Optional
multicastInterface:
string
Returns
void
address
address
(
)
:
AddressInfo
Returns
AddressInfo
bind
bind
(
port
?:
number
, address
?:
string
, callback
?:
function
)
:
void
bind
(
options
:
BindOptions
, callback
?:
Function
)
:
void
Parameters
Optional
port:
number
Optional
address:
string
Optional
callback:
function
(
)
:
void
Returns
void
Returns
void
Parameters
options:
BindOptions
Optional
callback:
Function
Returns
void
close
close
(
callback
?:
function
)
:
void
Parameters
Optional
callback:
function
(
)
:
void
Returns
void
Returns
void
drop
Membership
drop
Membership
(
multicastAddress
:
string
, multicastInterface
?:
string
)
:
void
Parameters
multicastAddress:
string
Optional
multicastInterface:
string
Returns
void
emit
emit
(
event
:
string
,
...
args
:
any
[]
)
:
boolean
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
emit
(
event
:
"listening"
)
:
boolean
emit
(
event
:
"message"
, msg
:
Buffer
, rinfo
:
AddressInfo
)
:
boolean
Parameters
event:
string
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
Parameters
event:
"listening"
Returns
boolean
Parameters
event:
"message"
msg:
Buffer
rinfo:
AddressInfo
Returns
boolean
event
Names
event
Names
(
)
:
string
|
symbol
Returns
string
|
symbol
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
:
"close"
, listener
:
function
)
on
(
event
:
"error"
, listener
:
function
)
on
(
event
:
"listening"
, listener
:
function
)
on
(
event
:
"message"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"listening"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"message"
listener:
function
(
msg
:
Buffer
, rinfo
:
AddressInfo
)
:
void
Parameters
msg:
Buffer
rinfo:
AddressInfo
Returns
void
once
once
(
event
:
string
, listener
:
Function
)
once
(
event
:
"close"
, listener
:
function
)
once
(
event
:
"error"
, listener
:
function
)
once
(
event
:
"listening"
, listener
:
function
)
once
(
event
:
"message"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"listening"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"message"
listener:
function
(
msg
:
Buffer
, rinfo
:
AddressInfo
)
:
void
Parameters
msg:
Buffer
rinfo:
AddressInfo
Returns
void
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
Function
)
prepend
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Listener
(
event
:
"listening"
, listener
:
function
)
prepend
Listener
(
event
:
"message"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"listening"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"message"
listener:
function
(
msg
:
Buffer
, rinfo
:
AddressInfo
)
:
void
Parameters
msg:
Buffer
rinfo:
AddressInfo
Returns
void
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"error"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"listening"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"message"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Parameters
event:
"listening"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"message"
listener:
function
(
msg
:
Buffer
, rinfo
:
AddressInfo
)
:
void
Parameters
msg:
Buffer
rinfo:
AddressInfo
Returns
void
ref
ref
(
)
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
send
send
(
msg
:
Buffer
|
String
|
any
[]
, port
:
number
, address
:
string
, callback
?:
function
)
:
void
send
(
msg
:
Buffer
|
String
|
any
[]
, offset
:
number
, length
:
number
, port
:
number
, address
:
string
, callback
?:
function
)
:
void
Parameters
msg:
Buffer
|
String
|
any
[]
port:
number
address:
string
Optional
callback:
function
(
error
:
Error
, bytes
:
number
)
:
void
Parameters
error:
Error
bytes:
number
Returns
void
Returns
void
Parameters
msg:
Buffer
|
String
|
any
[]
offset:
number
length:
number
port:
number
address:
string
Optional
callback:
function
(
error
:
Error
, bytes
:
number
)
:
void
Parameters
error:
Error
bytes:
number
Returns
void
Returns
void
set
Broadcast
set
Broadcast
(
flag
:
boolean
)
:
void
Parameters
flag:
boolean
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
Parameters
n:
number
set
Multicast
Loopback
set
Multicast
Loopback
(
flag
:
boolean
)
:
void
Parameters
flag:
boolean
Returns
void
set
MulticastTTL
set
MulticastTTL
(
ttl
:
number
)
:
void
Parameters
ttl:
number
Returns
void
setTTL
setTTL
(
ttl
:
number
)
:
void
Parameters
ttl:
number
Returns
void
unref
unref
(
)
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
events.EventEmitter