Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation

Client.invoke(url, request [,params])

Open source

Client.invoke(url, request [,params])

Invokes an unary RPC request to the given method.

The given method to invoke must have its RPC schema previously loaded via the Client.load() function, otherwise an error will be thrown.

Client.connect() must be called first before invoking a request, otherwise an error will be thrown.

Parameter	Type	Description
url	string	The gRPC method url to invoke, in the form `/package.Service/Method`, e.g. `/google.cloud.language.v1.LanguageService/AnalyzeSentiment`. The leading slash `/` is optional.
request	object	The canonical request object, as-per the Protobuf JSON Mapping.
params (optional)	object	Params object containing additional request parameters.

Returns

Type	Description
`Response`	gRPC Response object.

Examples

import grpc from 'k6/net/grpc';
import { check } from 'k6';

const client = new grpc.Client();
client.load([], 'routeguide.proto');

export default () => {
  client.connect('localhost:10000', { plaintext: true });
  const response = client.invoke('main.RouteGuide/GetFeature', {
    latitude: 410248224,
    longitude: -747127767,
  });
  check(response, { 'status is OK': (r) => r && r.status === grpc.StatusOK });
  console.log(response.message.name);
  // output: 3 Hasta Way, Newton, NJ 07860, USA

  client.close();
};