Skip to content

Commit

Permalink
document timeouts compiler option
Browse files Browse the repository at this point in the history
  • Loading branch information
mostroverkhov committed Mar 12, 2024
1 parent 739e52d commit 164e57f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions rsocket-rpc-futures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
`typed-metadata` if present, generated stubs will contain metadata as Protocol Buffers defined in [rsocket-rpc-metadata-idl](https://github.com/jauntsdn/rsocket-jvm/tree/develop/rsocket-rpc-metadata-idl) instead of raw byte buffers; one of `internal` (default),
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).

`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.

`generate-service-descriptors` if present, generated server stubs will contain service descriptors for transcoding Protocol Buffers into another representation (e.g. http/json). Value format is "service_foo.proto;service_bar.proto", or empty to generate for all services.

`instrumentation` defines sources of instrumentation listeners in generated stubs: one of `all` (default) - both external (constructor) and provided (via MessageStreams implementation attribute),
Expand Down
2 changes: 2 additions & 0 deletions rsocket-rpc-grpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
`typed-metadata` if present, generated stubs will contain metadata as Protocol Buffers defined in [rsocket-rpc-metadata-idl](https://github.com/jauntsdn/rsocket-jvm/tree/develop/rsocket-rpc-metadata-idl) instead of raw byte buffers; one of `internal` (default),
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).

`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.

`generate-service-descriptors` if present, generated server stubs will contain service descriptors for transcoding Protocol Buffers into another representation (e.g. http/json). Value format is "service_foo.proto;service_bar.proto", or empty to generate for all services.

`instrumentation` defines sources of instrumentation listeners in generated stubs: one of `all` (default) - both external (constructor) and provided (via MessageStreams implementation attribute),
Expand Down
2 changes: 2 additions & 0 deletions rsocket-rpc-virtualthreads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
`typed-metadata` if present, generated stubs will contain metadata as Protocol Buffers defined in [rsocket-rpc-metadata-idl](https://github.com/jauntsdn/rsocket-jvm/tree/develop/rsocket-rpc-metadata-idl) instead of raw byte buffers; one of `internal` (default),
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).

`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.

`generate-service-descriptors` if present, generated server stubs will contain service descriptors for transcoding Protocol Buffers into another representation (e.g. http/json). Value format is "service_foo.proto;service_bar.proto", or empty to generate for all services.

`instrumentation` defines sources of instrumentation listeners in generated stubs: one of `all` (default) - both external (constructor) and provided (via MessageStreams implementation attribute),
Expand Down

0 comments on commit 164e57f

Please sign in to comment.