Skip to content

Commit 164e57f

Browse files
committed
document timeouts compiler option
1 parent 739e52d commit 164e57f

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

rsocket-rpc-futures/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
`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),
1212
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).
1313

14+
`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.
15+
1416
`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.
1517

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

rsocket-rpc-grpc/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
`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),
1212
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).
1313

14+
`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.
15+
1416
`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.
1517

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

rsocket-rpc-virtualthreads/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
`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),
1212
`external` (depends on `rsocket-rpc-metadata-idl`). Disabled by default (metadata is represented as raw byte buffers).
1313

14+
`timeouts` if present, generated client stubs will contain handler for response timeout configured with `Headers.timeout`. Requires `typed-metadata` option.
15+
1416
`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.
1517

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

0 commit comments

Comments
 (0)