qpb/qpb.proto

   1 /*
   2  * qpb.proto
   3  *
   4  * @copyright Copyright (C) 2016 Sproute Networks, Inc.
   5  *
   6  * @author Avneesh Sachdev <avneesh@sproute.com>
   7  *
   8  * Permission to use, copy, modify, and/or distribute this software
   9  * for any purpose with or without fee is hereby granted, provided
  10  * that the above copyright notice and this permission notice appear
  11  * in all copies.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  14  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  16  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
  18  * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  19  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  20  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  21  */
  22
  23 /*
  24  * Protobuf definitions pertaining to the Quagga Protobuf component.
  25  */
  26 package qpb;
  27
  28 enum AddressFamily {
  29   UNKNOWN_AF = 0;
  30   IPV4 = 1;             // IP version 4
  31   IPV6 = 2;             // IP version 6
  32 };
  33
  34 enum SubAddressFamily {
  35   UNKNOWN_SAF = 0;
  36   UNICAST = 1;
  37   MULTICAST = 2;
  38 };
  39
  40 //
  41 // An IP version 4 address, such as 10.1.1.1.
  42 //
  43 message Ipv4Address {
  44   required fixed32 value = 1 ;
  45 };
  46
  47 message Ipv6Address {
  48
  49   // 16 bytes.
  50   required bytes bytes = 1;
  51 };
  52
  53 //
  54 // An IP version 4 or IP version 6 address.
  55 //
  56 message L3Address {
  57   optional Ipv4Address v4 = 1;
  58   optional Ipv6Address v6 = 2;
  59 };
  60
  61 //
  62 // An IP prefix, such as 10.1/16.
  63 // We use the message below to represent both IPv4 and IPv6 prefixes.
  64 message L3Prefix {
  65   required uint32 length = 1;
  66   required bytes bytes = 2;
  67 };
  68
  69 //
  70 // Something that identifies an interface on a machine. It can either
  71 // be a name (for instance, 'eth0') or a number currently.
  72 //
  73 message IfIdentifier {
  74   optional uint32 index = 1;
  75   optional string name = 2;
  76 };
  77
  78 enum Protocol {
  79   UNKNOWN_PROTO = 0;
  80   LOCAL = 1;
  81   CONNECTED = 2;
  82   KERNEL = 3;
  83   STATIC = 4;
  84   RIP = 5;
  85   RIPNG = 6;
  86   OSPF = 7;
  87   ISIS = 8;
  88   BGP = 9;
  89   OTHER = 10;
  90 }