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 syntax = "proto2";
  24
  25 /*
  26  * Protobuf definitions pertaining to the Quagga/FRR Protobuf component.
  27  */
  28 package qpb;
  29
  30 enum AddressFamily {
  31   UNKNOWN_AF = 0;
  32   IPV4 = 1;             // IP version 4
  33   IPV6 = 2;             // IP version 6
  34 };
  35
  36 enum SubAddressFamily {
  37   UNKNOWN_SAF = 0;
  38   UNICAST = 1;
  39   MULTICAST = 2;
  40 };
  41
  42 //
  43 // An IP version 4 address, such as 10.1.1.1.
  44 //
  45 message Ipv4Address {
  46   required fixed32 value = 1 ;
  47 };
  48
  49 message Ipv6Address {
  50
  51   // 16 bytes.
  52   required bytes bytes = 1;
  53 };
  54
  55 //
  56 // An IP version 4 or IP version 6 address.
  57 //
  58 message L3Address {
  59   optional Ipv4Address v4 = 1;
  60   optional Ipv6Address v6 = 2;
  61 };
  62
  63 //
  64 // An IP prefix, such as 10.1/16.
  65 // We use the message below to represent both IPv4 and IPv6 prefixes.
  66 message L3Prefix {
  67   required uint32 length = 1;
  68   required bytes bytes = 2;
  69 };
  70
  71 //
  72 // Something that identifies an interface on a machine. It can either
  73 // be a name (for instance, 'eth0') or a number currently.
  74 //
  75 message IfIdentifier {
  76   optional uint32 index = 1;
  77   optional string name = 2;
  78 };
  79
  80 enum Protocol {
  81   UNKNOWN_PROTO = 0;
  82   LOCAL = 1;
  83   CONNECTED = 2;
  84   KERNEL = 3;
  85   STATIC = 4;
  86   RIP = 5;
  87   RIPNG = 6;
  88   OSPF = 7;
  89   ISIS = 8;
  90   BGP = 9;
  91   OTHER = 10;
  92 }