generated from cybozu-go/neco-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add gRPC protocol definition for necoperf
Signed-off-by: zeroalphat <[email protected]>
- Loading branch information
1 parent
82f4c77
commit 78af1be
Showing
6 changed files
with
498 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,3 +18,4 @@ | |
# Generated files | ||
/bin | ||
/docs/book | ||
/include |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# Protocol Documentation | ||
<a name="top"></a> | ||
|
||
## Table of Contents | ||
|
||
- [pkg/rpc/necoperf.proto](#pkg_rpc_necoperf-proto) | ||
- [PerfProfileRequest](#necoperf-PerfProfileRequest) | ||
- [PerfProfileResponse](#necoperf-PerfProfileResponse) | ||
|
||
- [NecoPerf](#necoperf-NecoPerf) | ||
|
||
- [Scalar Value Types](#scalar-value-types) | ||
|
||
|
||
|
||
<a name="pkg_rpc_necoperf-proto"></a> | ||
<p align="right"><a href="#top">Top</a></p> | ||
|
||
## pkg/rpc/necoperf.proto | ||
|
||
|
||
|
||
<a name="necoperf-PerfProfileRequest"></a> | ||
|
||
### PerfProfileRequest | ||
|
||
|
||
|
||
| Field | Type | Label | Description | | ||
| ----- | ---- | ----- | ----------- | | ||
| container_id | [string](#string) | | | | ||
| timeout_seconds | [int64](#int64) | | | | ||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="necoperf-PerfProfileResponse"></a> | ||
|
||
### PerfProfileResponse | ||
|
||
|
||
|
||
| Field | Type | Label | Description | | ||
| ----- | ---- | ----- | ----------- | | ||
| data | [bytes](#bytes) | | | | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="necoperf-NecoPerf"></a> | ||
|
||
### NecoPerf | ||
|
||
|
||
| Method Name | Request Type | Response Type | Description | | ||
| ----------- | ------------ | ------------- | ------------| | ||
| Profile | [PerfProfileRequest](#necoperf-PerfProfileRequest) | [PerfProfileResponse](#necoperf-PerfProfileResponse) stream | | | ||
|
||
|
||
|
||
|
||
|
||
## Scalar Value Types | ||
|
||
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | | ||
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | | ||
| <a name="double" /> double | | double | double | float | float64 | double | float | Float | | ||
| <a name="float" /> float | | float | float | float | float32 | float | float | Float | | ||
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | ||
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | | ||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | | ||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | | ||
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | ||
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | | ||
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | | ||
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | | ||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | | ||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | | ||
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | | ||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | | ||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
syntax = "proto3"; | ||
|
||
option go_package = "pkg/rpc"; | ||
|
||
package necoperf; | ||
|
||
service NecoPerf { | ||
rpc Profile(PerfProfileRequest) returns (stream PerfProfileResponse); | ||
} | ||
|
||
message PerfProfileRequest { | ||
string container_id = 1; | ||
int64 timeout_seconds = 2; | ||
} | ||
|
||
message PerfProfileResponse { | ||
bytes data = 1; | ||
} |
Oops, something went wrong.