Skip to content

A GO library for communicating with the BIRD internet routing daemon over the provided unix domain socket.

License

Notifications You must be signed in to change notification settings

StatCan/go-birdc

Repository files navigation

(Français)

go-birdc

This is a GO library for working with the BIRD internet routing daemon through the provided unix domain socket. It is primarily an abstraction layer allowing users to communicate with a BIRD daemon without needing to directly talk with the BIRD daemon or spawn goroutines to issue birdc commands and parsing the output.

Usage

Install the library as a dependency

go get -u github.com/StatCan/go-birdc@latest

Then start using it in your application

import "github.com/StatCan/go-birdc"

func main() {
	b := New() // optionally you can specify a path to the unix socket endpoint (defaults to: /run/bird/bird.ctl)
	resp, replyCode, err := b.ShowStatus()
	if err != nil {
		log.Fatalf("something went wrong. %s", replyCode)
	}

	resp, replyCode, err := b.RestartProtocol("bgp")
	if err != nil {
		log.Fatalf("somthing went wrong. %s", replyCode)
	}

	fmt.Println(string(resp))
}

Related Documentation

How to Contribute

See CONTRIBUTING.md

License

Unless otherwise noted, the source code of this project is covered under Crown Copyright, Government of Canada, and is distributed under the MIT License.

The Canada wordmark and related graphics associated with this distribution are protected under trademark law and copyright law. No permission is granted to use them outside the parameters of the Government of Canada's corporate identity program. For more information, see Federal identity requirements.


go-birdc

Voici une bibliothèque GO pour travailler avec le démon de routage internet BIRD via le socket de domaine Unix fourni. Il s'agit principalement d'une couche d'abstraction permettant aux utilisateurs de communiquer avec un démon BIRD sans avoir besoin de dialoguer directement avec le démon BIRD ou de lancer des goroutines pour émettre des commandes birdc et analyser la sortie.

Utilisation

Installer la bibliothèque en tant que dépendance.

go get -u github.com/StatCan/go-birdc@latest

Ensuite, commencez à l'utiliser dans votre application.

import "github.com/StatCan/go-birdc"

func main() {
	b := New() // optionally you can specify a path to the unix socket endpoint (defaults to: /run/bird/bird.ctl)
	resp, replyCode, err := b.ShowStatus()
	if err != nil {
		log.Fatalf("something went wrong. %s", replyCode)
	}

	resp, replyCode, err := b.RestartProtocol("bgp")
	if err != nil {
		log.Fatalf("somthing went wrong. %s", replyCode)
	}

	fmt.Println(string(resp))
}

Documentation Connexe

Comment contribuer

Voir CONTRIBUTING.md

Licence

Sauf indication contraire, le code source de ce projet est protégé par le droit d'auteur de la Couronne du gouvernement du Canada et distribué sous la licence MIT.

Le mot-symbole « Canada » et les éléments graphiques connexes liés à cette distribution sont protégés en vertu des lois portant sur les marques de commerce et le droit d'auteur. Aucune autorisation n'est accordée pour leur utilisation à l'extérieur des paramètres du programme de coordination de l'image de marque du gouvernement du Canada. Pour obtenir davantage de renseignements à ce sujet, veuillez consulter les Exigences pour l'image de marque.

About

A GO library for communicating with the BIRD internet routing daemon over the provided unix domain socket.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks