Skip to content

Commit

Permalink
fix: added additional method level documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Peterson <[email protected]>
  • Loading branch information
mattp-swirldslabs committed Jun 27, 2024
1 parent 59e60fc commit a03863f
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions protos/src/main/protobuf/blockstream.proto
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,19 @@ option java_outer_classname = "BlockStreamServiceGrpcProto";
* with the id of each block received.
*/
service BlockStreamGrpc {

/**
* StreamSink is a bidirectional streaming method that allows a producer to stream blocks
* to the Block Node server. The server will respond with a BlockResponse message for each
* block received.
*/
rpc StreamSink(stream Block) returns (stream BlockResponse) {}

/**
* StreamSource is a bidirectional streaming method that allows a consumer to request a
* stream of blocks from the server. The consumer is expected to respond with a BlockResponse
* message with the id of each block received.
*/
rpc StreamSource(stream BlockResponse) returns (stream Block) {}
}

Expand Down

0 comments on commit a03863f

Please sign in to comment.