Interface Socket

Hierarchy

Socket

Index

Properties

bufferSize

Methods

Properties

bufferSize

bufferSize: Number

Number of buffered characters to be written

Methods

addListener

addListener(event: String, listener: Function): void

- Defined in socket.d.ts:10
installs a new listener function to be called when the specified event is triggered by the object on which it is applied

Parameters
- event: String
- listener: Function
Returns void

address

address(): Object

- Defined in socket.d.ts:14
returns an object containing two attributes, address and port, representing the address where the client socket is connected

Returns Object

connect

connect(port: Number, host?: String, callback?: Function): void

- Defined in socket.d.ts:18
opens the connection for the existing socket to which it is applied

Parameters
- port: Number
- Optional host: String
- Optional callback: Function
Returns void

destroy

destroy(): void

- Defined in socket.d.ts:22
closes the socket to which it is applied

Returns void

emit

emit(event: String, ...args: any[]): void

- Defined in socket.d.ts:26
triggers the event for the object, optionally passing arguments to the listener(s)

Parameters
- event: String
- Rest ...args: any[]
Returns void

end

end(): void

- Defined in socket.d.ts:30
closes the socket to which it is applied

Returns void

listeners

listeners(event: String): Array<Function>

- Defined in socket.d.ts:34
returns an array of listeners defined for the specified event in the object

Parameters
- event: String
Returns Array<Function>

on

on(event: String, listener: Function): void

- Defined in socket.d.ts:38
installs a new listener function to be called when the specified event is triggered by the object on which it is applied

Parameters
- event: String
- listener: Function
Returns void

once

once(event: String, listener: Function): void

- Defined in socket.d.ts:42
sets a new listener function to be called only once when the specified event is triggered for the first time by the object on which it is applied

Parameters
- event: String
- listener: Function
Returns void

pause

pause(): void

- Defined in socket.d.ts:46
pauses the 'data' event triggered for the given socket

Returns void

removeAllListeners

removeAllListeners(event?: String): void

- Defined in socket.d.ts:50
removes all the listeners of the specified event for the object to which it is applied

Parameters
- Optional event: String
Returns void

removeListener

removeListener(event: String, listener: Function): void

- Defined in socket.d.ts:54
removes the specified listener from the listener array of the event for the object to which it is applied

Parameters
- event: String
- listener: Function
Returns void

resume

resume(): void

- Defined in socket.d.ts:58
resumes a paused socket

Returns void

setEncoding

setEncoding(encoding: String): void

- Defined in socket.d.ts:62
sets the encoding for data received from the socket to which it is applied

Parameters
- encoding: String
Returns void

setMaxListeners

setMaxListeners(maxValue: Number): void

- Defined in socket.d.ts:66
defines the maximum number of listeners that can be added per event for the object to which it is applied

Parameters
- maxValue: Number
Returns void

setNoDelay

setNoDelay(noDelay: Boolean): void

- Defined in socket.d.ts:70
disables Nagle's algorithm for the socket to which it is applied

Parameters
- noDelay: Boolean
Returns void

write

write(data: WAKBufferInstance, encoding?: String): Boolean
write(data: String, encoding?: String): Boolean

- Defined in socket.d.ts:74
writes data to the socket to which it is applied

Parameters
- data: WAKBufferInstance
- Optional encoding: String
Returns Boolean
- Defined in socket.d.ts:78
writes data to the socket to which it is applied

Parameters
- data: String
- Optional encoding: String
Returns Boolean