frostfs-api/proto-docs/session.md
Leonard Lyubich cbd5605dc9 session: change Create rpc signature
This commit:

  * makes Create rpc call to be unary message;

  * changes CreateRequest structure;

  * changes CreateResponse structure.
2020-05-07 18:44:23 +03:00

3.9 KiB

Protocol Documentation

Table of Contents

Top

session/service.proto

Service "session.Session"

rpc Create(CreateRequest) returns (CreateResponse);

Method Create

Create opens new session between the client and the server

Name Input Output
Create CreateRequest CreateResponse

Message CreateRequest

CreateRequest carries an information necessary for opening a session

Field Type Label Description
OwnerID bytes OwnerID carries an identifier of a session initiator
Lifetime service.TokenLifetime Lifetime carries a lifetime of the session
Meta service.RequestMetaHeader RequestMetaHeader contains information about request meta headers (should be embedded into message)
Verify service.RequestVerificationHeader RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)

Message CreateResponse

CreateResponse carries an information about the opened session

Field Type Label Description
ID bytes ID carries an identifier of session token
SessionKey bytes SessionKey carries a session public key

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double float
float float float float
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
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
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str