Socket | typescript

Hierarchy

EventEmitter
- Socket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Socket(options?: EventEmitterOptions): Socket

Inherited from EventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- Optional options: EventEmitterOptions
Returns Socket

Properties

Static captureRejectionSymbol

captureRejectionSymbol: keyof symbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

addListener(event: string, listener: function): this
addListener(event: "close", listener: function): this
addListener(event: "connect", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "listening", listener: function): this
addListener(event: "message", listener: function): this

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:103
events.EventEmitter
1. close
2. connect
3. error
4. listening
5. message
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:104
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:105
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:106
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:107
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/dgram.d.ts:108
Parameters
- event: "message"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this

addMembership

addMembership(multicastAddress: string, multicastInterface?: string): void

- Defined in node_modules/@types/node/dgram.d.ts:42
Parameters
- multicastAddress: string
- Optional multicastInterface: string
Returns void

addSourceSpecificMembership

addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void

- Defined in node_modules/@types/node/dgram.d.ts:81
Tells the kernel to join a source-specific multicast channel at the given sourceAddress and groupAddress, using the multicastInterface with the IP_ADD_SOURCE_MEMBERSHIP socket option. If the multicastInterface argument is not specified, the operating system will choose one interface and will add membership to it. To add membership to every available interface, call socket.addSourceSpecificMembership() multiple times, once per interface.

Parameters
- sourceAddress: string
- groupAddress: string
- Optional multicastInterface: string
Returns void

address

address(): AddressInfo

- Defined in node_modules/@types/node/dgram.d.ts:43
Returns AddressInfo

bind

bind(port?: number, address?: string, callback?: function): void
bind(port?: number, callback?: function): void
bind(callback?: function): void
bind(options: BindOptions, callback?: function): void

- Defined in node_modules/@types/node/dgram.d.ts:44
Parameters
- Optional port: number
- Optional address: string
- Optional callback: function
  - - (): void
    - Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:45
Parameters
- Optional port: number
- Optional callback: function
  - - (): void
    - Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:46
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:47
Parameters
- options: BindOptions
- Optional callback: function
  - - (): void
    - Returns void
Returns void

close

close(callback?: function): void

- Defined in node_modules/@types/node/dgram.d.ts:48
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

connect

connect(port: number, address?: string, callback?: function): void
connect(port: number, callback: function): void

- Defined in node_modules/@types/node/dgram.d.ts:49
Parameters
- port: number
- Optional address: string
- Optional callback: function
  - - (): void
    - Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:50
Parameters
- port: number
- callback: function
  - - (): void
    - Returns void
Returns void

disconnect

disconnect(): void

- Defined in node_modules/@types/node/dgram.d.ts:51
Returns void

dropMembership

dropMembership(multicastAddress: string, multicastInterface?: string): void

- Defined in node_modules/@types/node/dgram.d.ts:52
Parameters
- multicastAddress: string
- Optional multicastInterface: string
Returns void

dropSourceSpecificMembership

dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void

- Defined in node_modules/@types/node/dgram.d.ts:93
Instructs the kernel to leave a source-specific multicast channel at the given sourceAddress and groupAddress using the IP_DROP_SOURCE_MEMBERSHIP socket option. This method is automatically called by the kernel when the socket is closed or the process terminates, so most apps will never have reason to call this.

If multicastInterface is not specified, the operating system will attempt to drop membership on all valid interfaces.

Parameters
- sourceAddress: string
- groupAddress: string
- Optional multicastInterface: string
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean
emit(event: "close"): boolean
emit(event: "connect"): boolean
emit(event: "error", err: Error): boolean
emit(event: "listening"): boolean
emit(event: "message", msg: Buffer, rinfo: RemoteInfo): boolean

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:110
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:111
Parameters
- event: "close"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:112
Parameters
- event: "connect"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:113
Parameters
- event: "error"
- err: Error
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:114
Parameters
- event: "listening"
Returns boolean
Overrides EventEmitter.emit
- Defined in node_modules/@types/node/dgram.d.ts:115
Parameters
- event: "message"
- msg: Buffer
- rinfo: RemoteInfo
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getRecvBufferSize

getRecvBufferSize(): number

- Defined in node_modules/@types/node/dgram.d.ts:53
Returns number

getSendBufferSize

getSendBufferSize(): number

- Defined in node_modules/@types/node/dgram.d.ts:54
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: function): this
on(event: "close", listener: function): this
on(event: "connect", listener: function): this
on(event: "error", listener: function): this
on(event: "listening", listener: function): this
on(event: "message", listener: function): this

Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:117
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:118
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:119
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:120
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:121
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.on
- Defined in node_modules/@types/node/dgram.d.ts:122
Parameters
- event: "message"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this

once

once(event: string, listener: function): this
once(event: "close", listener: function): this
once(event: "connect", listener: function): this
once(event: "error", listener: function): this
once(event: "listening", listener: function): this
once(event: "message", listener: function): this

Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:124
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:125
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:126
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:127
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:128
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.once
- Defined in node_modules/@types/node/dgram.d.ts:129
Parameters
- event: "message"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this

prependListener

prependListener(event: string, listener: function): this
prependListener(event: "close", listener: function): this
prependListener(event: "connect", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "listening", listener: function): this
prependListener(event: "message", listener: function): this

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:131
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:132
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:133
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:134
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:135
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/dgram.d.ts:136
Parameters
- event: "message"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string, listener: function): this
prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "connect", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "listening", listener: function): this
prependOnceListener(event: "message", listener: function): this

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:138
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:139
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:140
Parameters
- event: "connect"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:141
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:142
Parameters
- event: "listening"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/dgram.d.ts:143
Parameters
- event: "message"
- listener: function
  - - (msg: Buffer, rinfo: RemoteInfo): void
    - Parameters
      - msg: Buffer
      - rinfo: RemoteInfo
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

ref

ref(): this

- Defined in node_modules/@types/node/dgram.d.ts:55
Returns this

remoteAddress

remoteAddress(): AddressInfo

- Defined in node_modules/@types/node/dgram.d.ts:56
Returns AddressInfo

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(msg: string | Uint8Array | ReadonlyArray<any>, port?: number, address?: string, callback?: function): void
send(msg: string | Uint8Array | ReadonlyArray<any>, port?: number, callback?: function): void
send(msg: string | Uint8Array | ReadonlyArray<any>, callback?: function): void
send(msg: string | Uint8Array, offset: number, length: number, port?: number, address?: string, callback?: function): void
send(msg: string | Uint8Array, offset: number, length: number, port?: number, callback?: function): void
send(msg: string | Uint8Array, offset: number, length: number, callback?: function): void

- Defined in node_modules/@types/node/dgram.d.ts:57
Parameters
- msg: string | Uint8Array | ReadonlyArray<any>
- Optional port: number
- Optional address: string
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:58
Parameters
- msg: string | Uint8Array | ReadonlyArray<any>
- Optional port: number
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:59
Parameters
- msg: string | Uint8Array | ReadonlyArray<any>
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:60
Parameters
- msg: string | Uint8Array
- offset: number
- length: number
- Optional port: number
- Optional address: string
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:61
Parameters
- msg: string | Uint8Array
- offset: number
- length: number
- Optional port: number
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void
- Defined in node_modules/@types/node/dgram.d.ts:62
Parameters
- msg: string | Uint8Array
- offset: number
- length: number
- Optional callback: function
  - - (error: Error | null, bytes: number): void
    - Parameters
      - error: Error | null
      - bytes: number
      Returns void
Returns void

setBroadcast

setBroadcast(flag: boolean): void

- Defined in node_modules/@types/node/dgram.d.ts:63
Parameters
- flag: boolean
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setMulticastInterface

setMulticastInterface(multicastInterface: string): void

- Defined in node_modules/@types/node/dgram.d.ts:64
Parameters
- multicastInterface: string
Returns void

setMulticastLoopback

setMulticastLoopback(flag: boolean): void

- Defined in node_modules/@types/node/dgram.d.ts:65
Parameters
- flag: boolean
Returns void

setMulticastTTL

setMulticastTTL(ttl: number): void

- Defined in node_modules/@types/node/dgram.d.ts:66
Parameters
- ttl: number
Returns void

setRecvBufferSize

setRecvBufferSize(size: number): void

- Defined in node_modules/@types/node/dgram.d.ts:67
Parameters
- size: number
Returns void

setSendBufferSize

setSendBufferSize(size: number): void

- Defined in node_modules/@types/node/dgram.d.ts:68
Parameters
- size: number
Returns void

setTTL

setTTL(ttl: number): void

- Defined in node_modules/@types/node/dgram.d.ts:69
Parameters
- ttl: number
Returns void

unref

unref(): this

- Defined in node_modules/@types/node/dgram.d.ts:70
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns Socket

Properties

Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static errorMonitor

Methods

addListener

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "connect"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "listening"

listener: function

Returns void

Returns this

Parameters

event: "message"

listener: function

Parameters

msg: Buffer

rinfo: RemoteInfo

Returns void

Returns this

addMembership

Parameters

multicastAddress: string

Optional multicastInterface: string

Returns void

addSourceSpecificMembership

Parameters

sourceAddress: string

groupAddress: string

Optional multicastInterface: string

Returns void

address

Returns AddressInfo

bind

Parameters

Optional port: number

Optional address: string

Optional callback: function

Returns void

Returns void

Parameters

Optional port: number

Optional callback: function

Returns void

Returns void

Parameters