Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
scottslewis authored Oct 15, 2021
1 parent ec123e2 commit 1103947
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ service HealthCheck {

## Service API Generation

NEW: The service generation now supports generating code that uses either the ReactiveX 2 OR ReactiveX 3 APIs. See the org.eclipse.ecf.examples.provider.grpc.rx3.health.api, .impl, and .consumer projects in the examples directory to see the ReactiveX 3 generator output.
Using protoc and the three following protoc plugins: [grpc-java compiler](https://github.com/grpc/grpc-java), [reactive-grpc](https://github.com/salesforce/reactive-grpc), and the [grpc-osgi-generator](https://github.com/ECF/grpc-osgi-generator) plugin protoc will **generate the complete service api** in a single maven generate-sources phase. See the docs for [grpc-osgi-generator](https://github.com/ECF/grpc-osgi-generator) for explanation of how to invoke protoc and these protoc plugins via maven.

The directory [here](https://github.com/ECF/grpc-RemoteServicesProvider/tree/master/examples/org.eclipse.ecf.examples.provider.grpc.health.api/src/main/java/io/grpc/health/v1) has Java classes generated by using the protobuf-maven-plugin with protoc, grpc-java, and grpc-osgi-generator. Note that there are classes generated by protoc (HealthCheckRequest, HealthCheckResponse), classes generated by grpc-java (HealthCheckGrpc), classes generated by reactive-grpc (RxHealthCheckGrpc), and classes generated by grpc-osgi-generator (HealthCheckService interface). All of these classes are generated via the protoc and plugins compile/generation against [src/main/proto/health.proto](https://github.com/ECF/grpc-RemoteServicesProvider/blob/master/examples/org.eclipse.ecf.examples.provider.grpc.health.api/src/main/proto/health.proto).
Expand Down

0 comments on commit 1103947

Please sign in to comment.