22
33gRPCClient.jl aims to be a production grade gRPC client emphasizing performance and reliability.
44
5+ A pure markdown version of this documentation is available here: [llms.txt](llms.txt)
6+
57## Features
68
79- Unary+Streaming RPC
@@ -79,7 +81,7 @@ client = TestService_TestRPC_Client("172.238.177.88", 8001; grpc=grpc_myapp)
7981grpc_shutdown(grpc_myapp)
8082```
8183
82- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/gRPC.jl#L10-L28)
84+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/gRPC.jl#L10-L28)
8385
8486```
8587gRPCClient.grpc_shutdown — Method.
@@ -93,7 +95,7 @@ Shuts down the `gRPCCURL`. This neatly cleans up all active connections and requ
9395development with Revise. Unless specifying the `gRPCCURL`, the global one provided by `grpc_global_handle()` is
9496shutdown.
9597
96- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/gRPC.jl#L32-L36)
98+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/gRPC.jl#L32-L36)
9799
98100```
99101gRPCClient.grpc_global_handle — Method.
@@ -106,7 +108,7 @@ grpc_global_handle()
106108Returns the global `gRPCCURL` state which contains a libCURL multi handle. By default all gRPC clients use this multi in
107109order to ensure that HTTP/2 multiplexing happens where possible.
108110
109- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/gRPC.jl#L3-L7)
111+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/gRPC.jl#L3-L7)
110112
111113### Generated ServiceClient Constructors
112114
@@ -199,7 +201,7 @@ for request in requests
199201end
200202```
201203
202- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Unary.jl#L3-L31)
204+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Unary.jl#L3-L31)
203205
204206```
205207gRPCClient.grpc_async_request — Method.
@@ -239,7 +241,7 @@ for i in 1:N
239241end
240242```
241243
242- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Unary.jl#L70-L101)
244+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Unary.jl#L70-L101)
243245
244246```
245247gRPCClient.grpc_async_await — Method.
@@ -252,7 +254,7 @@ grpc_async_await(client::gRPCServiceClient{TRequest,false,TResponse,false}, requ
252254Wait for the request to complete and return the response when it is ready. Throws any exceptions that were encountered
253255during handling of the request.
254256
255- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Unary.jl#L145-L149)
257+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Unary.jl#L145-L149)
256258
257259```
258260gRPCClient.grpc_sync_request — Method.
@@ -280,7 +282,7 @@ response = grpc_sync_request(client, TestRequest(1, zeros(UInt64, 1)))
280282@info response
281283```
282284
283- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Unary.jl#L156-L176)
285+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Unary.jl#L156-L176)
284286
285287#### Streaming
286288
@@ -318,7 +320,7 @@ close(request_c)
318320test_response = grpc_async_await(client, req)
319321```
320322
321- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Streaming.jl#L110-L138)
323+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Streaming.jl#L110-L138)
322324
323325```
324326gRPCClient.grpc_async_request — Method.
354356grpc_async_await(req)
355357```
356358
357- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Streaming.jl#L167-L195)
359+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Streaming.jl#L167-L195)
358360
359361```
360362gRPCClient.grpc_async_request — Method.
@@ -396,7 +398,7 @@ close(request_c)
396398grpc_async_await(req)
397399```
398400
399- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Streaming.jl#L231-L265)
401+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Streaming.jl#L231-L265)
400402
401403```
402404gRPCClient.grpc_async_await — Method.
@@ -408,7 +410,7 @@ grpc_async_await(client::gRPCServiceClient{TRequest,true,TResponse,false},reques
408410
409411Raise any exceptions encountered during the streaming request.
410412
411- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/Streaming.jl#L299-L303)
413+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/Streaming.jl#L299-L303)
412414
413415### Exceptions
414416
@@ -424,7 +426,7 @@ This exception type has two fields:
4244261. `grpc_status::Int` - See [here](https://grpc.io/docs/guides/status-codes/) for an indepth explanation of each status.
4254272. `message::String`
426428
427- [source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa /src/gRPCClient.jl#L21-L29)
429+ [source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6 /src/gRPCClient.jl#L21-L29)
428430
429431## gRPCClientUtils.jl
430432
0 commit comments