Client.connect(address [,params])

suggest edits

Opens a connection to a gRPC server; will block until a connection is made or a connection error is thrown. Cannot be called during the init phase.

See Client.close() to close the connection.

Parameter	Type	Description
address	string	The address of the gRPC server. Should be in the form: host:port with no protocol prefix e.g. grpc.k6.io:443. The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name e.g. :443 or :https. If the host is a literal IPv6 address it must be enclosed in square brackets, as in [2001:db8::1]:80 or [fe80::1%zone]:80.
params (optional)	object	ConnectParams object containing additional connect parameters.

ConnectParams

Name	Type	Description
ConnectParams.plaintext	bool	If true will connect to the gRPC server using plaintext i.e. insecure. Defaults to false i.e. secure via TLS.
ConnectParams.reflect	boolean	Whether to use the gRPC server reflection protocol when connecting.
ConnectParams.timeout	string / number	Connection timeout to use. Default timeout is "60s". The type can also be a number, in which case k6 interprets it as milliseconds, e.g., 60000 is equivalent to "60s".

Examples

import grpc from 'k6/net/grpc';

const client = new grpc.Client();

export default () => {
  client.connect('localhost:8080');
};

import grpc from 'k6/net/grpc';

const client = new grpc.Client();

export default () => {
  client.connect('localhost:8080', { plaintext: true });
};

Init context

k6

k6/crypto

k6/data

k6/encoding

k6/execution

k6/experimental

k6/html

k6/http

k6/metrics

k6/net/grpc

k6/ws

Error Codes

Client.connect(address [,params])

ConnectParams

Examples

Product

Resources

Community

About