NetClient | @vertx/core

A TCP client.

Multiple connections to different servers can be made using the same instance.

This client supports a configurable number of connection attempts and a configurable delay between attempts.

Hierarchy

NetClient

Implements

Measured

Index

Methods

close

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

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6497
Close the client.

Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6505
Close the client.

Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

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

connect

connect(port: number, host: string): PromiseLike<NetSocket>
connect(port: number, host: string, connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>): NetClient
connect(port: number, host: string, serverName: string): PromiseLike<NetSocket>
connect(port: number, host: string, serverName: string, connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>): NetClient
connect(remoteAddress: SocketAddress): PromiseLike<NetSocket>
connect(remoteAddress: SocketAddress, connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>): NetClient
connect(remoteAddress: SocketAddress, serverName: string): PromiseLike<NetSocket>
connect(remoteAddress: SocketAddress, serverName: string, connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>): NetClient

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6437
Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- port: number
- host: string
Returns PromiseLike<NetSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6445
Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- port: number
- host: string
- connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>
Returns NetClient
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6453
Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- port: number
- host: string
- serverName: string
Returns PromiseLike<NetSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6461
Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- port: number
- host: string
- serverName: string
- connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>
Returns NetClient
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6468
Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- remoteAddress: SocketAddress
Returns PromiseLike<NetSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6475
Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- remoteAddress: SocketAddress
- connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>
Returns NetClient
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6482
Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- remoteAddress: SocketAddress
- serverName: string
Returns PromiseLike<NetSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:6489
Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters
- remoteAddress: SocketAddress
- serverName: string
- connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>
Returns NetClient

isMetricsEnabled

isMetricsEnabled(): boolean

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

Returns boolean

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:6511
Like {@link NetClient#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:6517
Like {@link NetClient#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

close

Returns PromiseLike<void>

Parameters

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

Returns void

connect

Parameters

port: number

host: string

Returns PromiseLike<NetSocket>

Parameters

port: number

host: string

connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>

Returns NetClient

Parameters

port: number

host: string

serverName: string

Returns PromiseLike<NetSocket>

Parameters

port: number

host: string

serverName: string

connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>

Returns NetClient

Parameters

remoteAddress: SocketAddress

Returns PromiseLike<NetSocket>

Parameters

remoteAddress: SocketAddress

connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>

Returns NetClient

Parameters

remoteAddress: SocketAddress

serverName: string

Returns PromiseLike<NetSocket>

Parameters

remoteAddress: SocketAddress

serverName: string

connectHandler: ((res: AsyncResult<NetSocket>) => void) | Handler<AsyncResult<NetSocket>>

Returns NetClient

isMetricsEnabled

Returns boolean

updateSSLOptions

Parameters

options: SSLOptions

Returns PromiseLike<void>

Parameters

options: SSLOptions

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

Returns void