Skip to content

Commit 932b5b9

Browse files
olegbespalovolegbespalov
committed
Deprecation of the exerimental grpc
1 parent 8a753d7 commit 932b5b9

16 files changed

+43
-6
lines changed

‎docs/sources/next/javascript-api/k6-experimental/grpc/_index.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
---
2-
title: "grpc"
3-
excerpt: "Experimental GRPC module"
4-
weight: 02
2+
title: 'grpc'
3+
excerpt: 'Experimental GRPC module'
54
weight: 02
65
---
76

87
# grpc
98

10-
{{< docs/shared source="k6" lookup="experimental-module.md" version="<K6_VERSION>" >}}
9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
1110

1211
The `k6/experimental/grpc` module is an extension of the [`k6/net/grpc`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc). It provides a [gRPC](https://grpc.io/) client for Remote Procedure Calls (RPC) over HTTP/2.
1312

14-
The key-difference between the two modules is new `Stream` class, which provides client and server streaming support. Our long-term goal is to make this module part of k6 core, and long-term to replace the [`k6/net/grpc`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc) module.
13+
Prior k6 `v0.49` the key-difference between the two modules was streaming support, but it has been added to the `k6/net/grpc` module as well. We recommend using the `k6/net/grpc` module.
1514

1615
| Class/Method | Description |
1716
| ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/_index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 10
66

77
# Client
88

9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
10+
911
`Client` is a gRPC client that can interact with a gRPC server.
1012

1113
| Method | Description |

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/client-close.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 40
66

77
# Client.close()
88

9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
10+
911
Close the connection to the gRPC service. Tear down all underlying connections.
1012

1113
### Examples

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/client-connect-connect-address-params.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ weight: 20
77

88
# Client.connect(address [,params])
99

10+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
11+
1012
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](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-lifecycle).
1113

1214
See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/grpc/client/client-close) to close the connection.

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/client-invoke.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 30
66

77
# Client.invoke(url, request [,params])
88

9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
10+
911
Invokes an unary RPC request to the given method.
1012

1113
The given method to invoke must have its RPC schema previously loaded via the [Client.load()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/grpc/client/client-load) function, otherwise an

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/client-load-protoset.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ weight: 11
77

88
# Client.loadProtoset(protosetPath)
99

10+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
11+
1012
Loads and parses the protoset file (serialized FileDescriptor set) so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.
1113

1214
Must be called within the [`init` phase](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-lifecycle).

‎docs/sources/next/javascript-api/k6-experimental/grpc/client/client-load.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 10
66

77
# Client.load(importPaths, ...protoFiles)
88

9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
10+
911
Loads and parses the protocol buffer descriptors so they are available to the client to marshal/unmarshal the correct request and response data structures for the RPC schema.
1012

1113
Must be called within the [`init` phase](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-lifecycle).

‎docs/sources/next/javascript-api/k6-experimental/grpc/constants.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ weight: 40
66

77
# Constants
88

9+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
10+
911
Define constants to distinguish between [gRPC Response](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/grpc/response) statuses.
1012

1113
| Constant | Description |

‎docs/sources/next/javascript-api/k6-experimental/grpc/params.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ weight: 20
77

88
# Params
99

10+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
11+
1012
_Params_ is an object used by the gRPC methods that generate RPC requests. _Params_ contains request-specific options like headers that should be inserted into the request.
1113

1214
| Name | Type | Description |

‎docs/sources/next/javascript-api/k6-experimental/grpc/response.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ weight: 30
77

88
# Response
99

10+
{{< docs/shared source="k6" lookup="experimental-grpc-module.md" version="<K6_VERSION>" >}}
11+
1012
| Name | Type | Description |
1113
| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1214
| `Response.status` | number | The response gRPC status code. Use the gRPC [status constants](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/grpc/constants) to check equality. |

0 commit comments

Comments
 (0)