Skip to content

Commit 054a04e

Browse files
onobcdsyer
authored andcommitted
Regenerate the config props doc
This re-generates the common application properties section of the docs to pickup the recently added properties for in-process channel and factory. Signed-off-by: Chris Bono <[email protected]>
1 parent f6a0484 commit 054a04e

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@
1616
|spring.grpc.client.default-channel.max-inbound-metadata-size | `+++8192B+++` | Maximum metadata size allowed to be received by the channel (default 8KiB). Set to '-1' to use the highest possible limit (not recommended).
1717
|spring.grpc.client.default-channel.negotiation-type | `+++plaintext+++` | The negotiation type for the channel.
1818
|spring.grpc.client.default-channel.secure | `+++true+++` | Flag to say that strict SSL checks are not enabled (so the remote certificate could be anonymous).
19+
|spring.grpc.client.default-channel.service-config | | Map representation of the service config to use for the channel
1920
|spring.grpc.client.default-channel.ssl.bundle | | SSL bundle name.
2021
|spring.grpc.client.default-channel.ssl.enabled | | Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise.
2122
|spring.grpc.client.default-channel.user-agent | | The custom User-Agent for the channel.
2223
|spring.grpc.client.enabled | `+++true+++` | Whether to enable client autoconfiguration.
24+
|spring.grpc.client.inprocess.enabled | `+++true+++` | Whether to configure the in-process channel factory.
25+
|spring.grpc.client.inprocess.exclusive | `+++true+++` | Whether the inprocess channel factory should be the only channel factory available. When the value is true, no other channel factory will be configured.
2326
|spring.grpc.client.observations.enabled | `+++true+++` | Whether to enable Observations on the client.
2427
|spring.grpc.server.address | | The address to bind to. could be a host:port combination or a pseudo URL like static://host:port. Can not be set if host or port are set independently.
2528
|spring.grpc.server.enabled | `+++true+++` | Whether to enable server autoconfiguration.
@@ -31,6 +34,8 @@
3134
|spring.grpc.server.health.actuator.update-rate | `+++5s+++` | How often to update the health status.
3235
|spring.grpc.server.health.enabled | `+++true+++` | Whether to auto-configure Health feature on the gRPC server.
3336
|spring.grpc.server.host | `+++*+++` | Server address to bind to. The default is any IP address ('*').
37+
|spring.grpc.server.inprocess.exclusive | | Whether the inprocess server factory should be the only server factory available. When the value is true no other server factory will be configured.
38+
|spring.grpc.server.inprocess.name | | The name of the in-process server or null to not start the in-process server.
3439
|spring.grpc.server.keep-alive.max-age | | Maximum time a connection may exist before being gracefully terminated (default infinite).
3540
|spring.grpc.server.keep-alive.max-age-grace | | Maximum time for graceful connection termination (default infinite).
3641
|spring.grpc.server.keep-alive.max-idle | | Maximum time a connection can remain idle before being gracefully terminated (default infinite).

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/client/GrpcClientProperties.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,11 @@ public Health getHealth() {
150150
return this.health;
151151
}
152152

153-
private final Map<String, ?> serviceConfig = new HashMap<>();
154-
155153
/**
156-
* The service config to use for the channel.
157-
* @return the service config
154+
* Map representation of the service config to use for the channel
158155
*/
156+
private final Map<String, ?> serviceConfig = new HashMap<>();
157+
159158
public Map<String, ?> getServiceConfig() {
160159
return this.serviceConfig;
161160
}

0 commit comments

Comments
 (0)