From 0eaa020a6ef7ac6cdef18b07bf36290f2e4eb6dc Mon Sep 17 00:00:00 2001 From: Cai Yudong Date: Fri, 1 Oct 2021 01:06:23 +0800 Subject: [PATCH] [skip ci] Update comment for alloc id (#8926) Signed-off-by: yudong.cai --- internal/types/types.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/internal/types/types.go b/internal/types/types.go index 0a5e1c43c3..d3fae1bf25 100644 --- a/internal/types/types.go +++ b/internal/types/types.go @@ -304,6 +304,15 @@ type RootCoord interface { // `Timestamp` is the first available timestamp allocated // error is always nil AllocTimestamp(ctx context.Context, req *rootcoordpb.AllocTimestampRequest) (*rootcoordpb.AllocTimestampResponse, error) + + // AllocID notifies RootCoord to alloc IDs + // + // ctx is the context to control request deadline and cancellation + // req contains the count of IDs need to be allocated + // + // The `Status` in response struct `AllocTimestampResponse` indicates if this operation is processed successfully or fail cause; + // `ID` is the first available id allocated + // error is always nil AllocID(ctx context.Context, req *rootcoordpb.AllocIDRequest) (*rootcoordpb.AllocIDResponse, error) UpdateChannelTimeTick(ctx context.Context, req *internalpb.ChannelTimeTickMsg) (*commonpb.Status, error)