protocol/avdl/keybase1/block.avdl - master - githubmirror/client

protocol/avdl/keybase1/block.avdl
117 строк3 KB
Song Gao
don't compress for block related RPCs (#23941)
24 апр 2020, 23:04
24 апр 2020, 23:045916c56
@namespace("keybase.1")
@compression_type("gzip")

protocol block {
  import idl "backend_common.avdl";

  enum BlockStatus {
    UNKNOWN_0,
    LIVE_1,
    ARCHIVED_2
  }

  record GetBlockRes {
    string blockKey;
    bytes buf;
    int size;
    BlockStatus status;
  }

  record GetBlockSizesRes {
    array<int> sizes;
    array<BlockStatus> statuses;
  }

  // Fixed-size nonce to identify a reference to a block
  fixed BlockRefNonce(8);

  record BlockReference {
    BlockIdCombo bid;
    BlockRefNonce nonce;
    UserOrTeamID chargedTo;
  }

  record BlockReferenceCount{
    BlockReference ref;
    int liveCount;
  }

  record DowngradeReferenceRes{
    array<BlockReferenceCount> completed;
    BlockReference failed;
  }


  @lint("ignore")
  record BlockIdCount{
    BlockIdCombo id;
    int liveCount;
  }

  record ReferenceCountRes{
    array<BlockIdCount> counts;
  }

  record BlockPingResponse {
    // In the future, we might want to respond with timestamps or
    // ping intervals.
  }


  ChallengeInfo getSessionChallenge();
  void authenticateSession(string signature);

  // Block contents are encrypted and barely compressible, so just skip
  // compression to save CPU and RAM on bserver.
  @compression_type("none")
  void putBlock(BlockIdCombo bid, string folder, string blockKey, bytes buf);
  @compression_type("none")
  void putBlockAgain(string folder, BlockReference ref, string blockKey, bytes buf);
  @compression_type("none")
  GetBlockRes getBlock(BlockIdCombo bid, string folder, boolean sizeOnly);
  GetBlockSizesRes getBlockSizes(array<BlockIdCombo> bids, string folder);

  void addReference(string folder, BlockReference ref);
  void delReference(string folder, BlockReference ref);
  array<BlockReference> archiveReference(string folder, array<BlockReference> refs);

  DowngradeReferenceRes delReferenceWithCount(string folder, array<BlockReference> refs);
  DowngradeReferenceRes archiveReferenceWithCount(string folder, array<BlockReference> refs);
  ReferenceCountRes getReferenceCount(string folder, array<BlockIdCombo> ids, BlockStatus status);

  bytes getUserQuotaInfo();
  bytes getTeamQuotaInfo(TeamID tid);

  record UsageStatRecord {
    int64 write;
    int64 archive;
    int64 read;
    int64 mdWrite;
    int64 gitWrite;
    int64 gitArchive;
  }

  record UsageStat {
    UsageStatRecord bytes;
    UsageStatRecord blocks;
    Time mtime;
  }

  record FolderUsageStat{
    string folderID;
    UsageStat stats;
  }

  record BlockQuotaInfo{
    array<FolderUsageStat> folders;
    UsageStat total;
    int64 limit;
    int64 gitLimit;
  }

  BlockQuotaInfo getUserQuotaInfo2(boolean includeFolders);

  BlockQuotaInfo getTeamQuotaInfo2(TeamID tid, boolean includeFolders);

  BlockPingResponse blockPing();
}