kitsune2_api 0.5.0-dev.1

p2p / dht communication framework api
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

syntax = "proto3";

package kitsune2.wire;

// A Kitsune2 wire protocol message.
//
// This is the top-level encoding
// that will be transferred between Kitsune2 peers. Most communications
// between peers to make Kitsune2 actually function will be encoded
// separately inside the payload of TY_MODULE type messages.
message K2Proto {
  // Enumeration of the types of messages that can be sent between peers.
  //
  // We are using this enum field to distinguish between top-level messages,
  // rather than protobuf's oneof because of the downsides of upgrading oneofs.
  enum K2WireType {
    // The "UNSPECIFIED" type for future message types.
    //
    // In general, peers should ignore unspecified messages, but
    // should still count them toward any ratelimiting metrics.
    UNSPECIFIED = 0;

    // This message is preflight data.
    //
    // The implementor is responsible for encoding any module-specific
    // requirements within the data payload of this message type.
    // For example, if peers are required to include the "dht_v1" module
    // to communicate with each other, they should reject preflight to
    // peers that do not include that module.
    PREFLIGHT = 1;

    // This is a notification or fire-and-forget message from a peer.
    //
    // This type requires that a "space_id" be specified.
    NOTIFY = 2;

    // This is a module communication.
    //
    // Most of Kitsune2's communications will likely proceed between
    // Kitsune2's modules.
    //
    // This type requires that a "space_id" be specified.
    // This type requires that a "module_id" be specified.
    MODULE = 3;

    // This message indicates a general disconnect, with the reason
    // or context specified in the data payload.
    //
    // We may add additional specific disconnect codes in the future.
    DISCONNECT = 15;
  }

  // The type of this message.
  K2WireType ty = 1;

  // The payload or content of this message.
  bytes data = 2;

  // If the Ty requires that a space be specified, this is it.
  //
  // Kitsune is divided up into multiple dht "spaces" and peers
  // join and communicate over these spaces. These bytes identify
  // the space within which this message is communicating.
  optional bytes space_id = 3;

  // If the Ty requires a module impl be specified, this is it.
  //
  // Modules include specific sub-protocols to communicate with each other,
  // so those messages must be routed to the correct module.
  //
  // This string is the module routing info. E.g. "gossip", "fetch", "sharding".
  optional string module_id = 4;
}