go-bgp

a collection of golang BGP tools to monitor, archive and serve
git clone git://git.2f30.org/go-bgp.git
Log | Files | Refs | README

README (2330B)


     1 =====================================================================
     2 		go-bgp by DsP <dsp@2f30.org>
     3 =====================================================================
     4 [General]
     5 go-bgp is a collection of pure golang libraries and tools for:
     6 reading and writing MRT files
     7 parsing BGP messages
     8 exposing archived BGP messages in various formats over RESTful HTTP/2
     9 
    10 [Details]
    11 mrt/
    12 	Using this module from golang allows you to open a file and then using
    13 	bufio to set the splitfunc to the provided SplitMrt
    14 	then using .Scan() you can get the []bytes of each MRT message
    15 	
    16 
    17 archive/
    18 	This module allows the scanning of hierarchical dated dirs 
    19 	that contain either XML encoded files or MRT files.
    20 	then it exposes an API that allows requests in the form of
    21 	http://host:port/archive?start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&type=mrt    
    22 	or
    23 	http://host:port/archive/conf?range
    24 	http://host:port/archive/conf?files
    25 
    26 monitor/
    27 	bgp monitor
    28 
    29 tests/
    30 	contain data for unit tests
    31 
    32 doc/
    33 	relevant RFCs
    34 
    35 cmd/
    36 	executable programs
    37 
    38 [License]
    39 Copyright (c) 2015, dsp <dsp@2f30.org>
    40 All rights reserved.
    41 
    42 Redistribution and use in source and binary forms, with or without modification,
    43 are permitted provided that the following conditions are met:
    44 
    45 1. Redistributions of source code must retain the above copyright notice,
    46 this list of conditions and the following disclaimer.
    47 
    48 2. Redistributions in binary form must reproduce the above copyright notice,
    49 this list of conditions and the following disclaimer in the documentation and/or
    50 other materials provided with the distribution.
    51 
    52 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
    53 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    54 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    55 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
    56 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    57 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
    58 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    59 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
    60 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.