protoparse

package module

v0.1.3 Latest Latest Go to latest Published: May 2, 2019 License: BSD-2-Clause Imports: 1 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/CSUNetSec/protoparse

Links

Open Source Insights

README ¶

  Protoparse is a library to parse various protocols to protocol buffers

# Installation

 Just include the library from your Golang project and use the API.
 Running make will just run tests on this package and all subpackages.

# Current protocols:

 - MRT (BGP4MP)
 - BGP
 - RIB

# Design

 The main interface in protoparse is PbVal and the types that implement it
 are structures that usually have a buf []byte buffer that as the messages are
 parsed it is advanced and a a dest protocol buffer pointer that the data is stored.
 The functions of the interface is Parse() (PbVal, error) and String() string
 once an of type PbVal is created with an underlying buffer buf upon calling Parse() on 
 it another object that satisfies the PbVal interface is returned. this we way we can 
 recurse in the container formats while populating the internal protocol buffer messages.

# TODO

 1. more protocols
 2. godoc

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BGP4MPHeaderer ¶

type BGP4MPHeaderer interface {
	PbVal
	GetHeader() *pbbgp.BGP4MPHeader
}

type BGPUpdater ¶

type BGPUpdater interface {
	PbVal
	GetUpdate() *pbbgp.BGPUpdate
}

type MRTHeaderer ¶

type MRTHeaderer interface {
	PbVal
	GetHeader() *pbbgp.MrtHeader
}

type PbVal ¶

type PbVal interface {
	Parse() (PbVal, error)
	String() string
}

A pbval is an interface that takes a byte slice and populates the underlying pb. all supported pbs must implement it.

type RIBHeaderer ¶

type RIBHeaderer interface {
	PbVal
	GetHeader() *pbbgp.RIB
}

Source Files ¶

View all Source files

protoparse.go

Directories ¶

Path	Synopsis
fileutil
filter
protocol
bgp
mrt
rib
util The protoparse util package deals with reading and writing protocol buffer encoded records in, for example, files.	The protoparse util package deals with reading and writing protocol buffer encoded records in, for example, files.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL