NetServer | @vertx/core

Represents a TCP server

Hierarchy

NetServer

Implements

Measured

Index

Methods

actualPort

actualPort(): number

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6598
The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port

Returns number

close

close(): PromiseLike<void>
close(completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6587
Like {@link NetServer#close} but supplying a handler that will be notified when close is complete.

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6592
Like {@link NetServer#close} but supplying a handler that will be notified when close is complete.

Parameters
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

connectHandler

connectHandler(handler: ((res: NetSocket) => void) | Handler<NetSocket> | null | undefined): NetServer

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6542
Supply a connect handler for this server. The server can only have at most one connect handler at any one time. As the server accepts TCP or SSL connections it creates an instance of NetSocket and passes it to the connect handler.

Parameters
- handler: ((res: NetSocket) => void) | Handler<NetSocket> | null | undefined
Returns NetServer

connectStream

connectStream(): ReadStream<NetSocket>

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6535
Return the connect stream for this server. The server can only have at most one handler at any one time. As the server accepts TCP or SSL connections it creates an instance of NetSocket and passes it to the connect stream .

Returns ReadStream<NetSocket>

isMetricsEnabled

isMetricsEnabled(): boolean

Implementation of Measured.isMetricsEnabled
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6528
Whether the metrics are enabled for this measured object

Returns boolean

listen

listen(): PromiseLike<NetServer>
listen(listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>): NetServer
listen(port: number, host: string): PromiseLike<NetServer>
listen(port: number, host: string, listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>): NetServer
listen(port: number): PromiseLike<NetServer>
listen(port: number, listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>): NetServer
listen(localAddress: SocketAddress): PromiseLike<NetServer>
listen(localAddress: SocketAddress, listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>): NetServer

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6547
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Returns PromiseLike<NetServer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6552
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>
Returns NetServer
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6557
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- port: number
- host: string
Returns PromiseLike<NetServer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6562
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- port: number
- host: string
- listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>
Returns NetServer
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6567
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- port: number
Returns PromiseLike<NetServer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6572
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- port: number
- listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>
Returns NetServer
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6577
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- localAddress: SocketAddress
Returns PromiseLike<NetServer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6582
Like {@link NetServer#listen} but providing a handler that will be notified when the server is listening, or fails.

Parameters
- localAddress: SocketAddress
- listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>
Returns NetServer

updateSSLOptions

updateSSLOptions(options: SSLOptions): PromiseLike<void>
updateSSLOptions(options: SSLOptions, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6604
Like {@link NetServer#updateSSLOptions} but supplying a handler that will be called when the update happened (or has failed).

Parameters
- options: SSLOptions
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6610
Like {@link NetServer#updateSSLOptions} but supplying a handler that will be called when the update happened (or has failed).

Parameters
- options: SSLOptions
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

Hierarchy

Implements

Index

Methods

Methods

actualPort

Returns number

close

Returns PromiseLike<void>

Parameters

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

connectHandler

Parameters

handler: ((res: NetSocket) => void) | Handler<NetSocket> | null | undefined

Returns NetServer

connectStream

Returns ReadStream<NetSocket>

isMetricsEnabled

Returns boolean

listen

Returns PromiseLike<NetServer>

Parameters

listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>

Returns NetServer

Parameters

port: number

host: string

Returns PromiseLike<NetServer>

Parameters

port: number

host: string

listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>

Returns NetServer

Parameters

port: number

Returns PromiseLike<NetServer>

Parameters

port: number

listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>

Returns NetServer

Parameters

localAddress: SocketAddress

Returns PromiseLike<NetServer>

Parameters

localAddress: SocketAddress

listenHandler: ((res: AsyncResult<NetServer>) => void) | Handler<AsyncResult<NetServer>>

Returns NetServer

updateSSLOptions

Parameters

options: SSLOptions

Returns PromiseLike<void>

Parameters

options: SSLOptions

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void