Document config API and provide examples

1 files changed, 68 insertions, 0 deletions

diff --git a/pkg/config/config_test.go b/pkg/config/config_test.go
new file mode 100644
index 00000000..67ffa5e7
--- /dev/null
+++ b/pkg/config/config_test.go
@@ -0,0 +1,68 @@
+package config
+
+import (
+	"context"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/osrg/gobgp/pkg/server"
+)
+
+// ExampleUpdateConfig shows how InitialConfig can be used without UpdateConfig
+func ExampleInitialConfig() {
+	bgpServer := server.NewBgpServer()
+	go bgpServer.Serve()
+
+	initialConfig, err := ReadConfigFile("gobgp.conf", "toml")
+	if err != nil {
+		// Handle error
+		return
+	}
+
+	isGracefulRestart := true
+	_, err = InitialConfig(context.Background(), bgpServer, initialConfig, isGracefulRestart)
+
+	if err != nil {
+		// Handle error
+		return
+	}
+}
+
+// ExampleUpdateConfig shows how UpdateConfig is used in conjuction with
+// InitialConfig.
+func ExampleUpdateConfig() {
+	bgpServer := server.NewBgpServer()
+	go bgpServer.Serve()
+
+	initialConfig, err := ReadConfigFile("gobgp.conf", "toml")
+	if err != nil {
+		// Handle error
+		return
+	}
+
+	isGracefulRestart := true
+	currentConfig, err := InitialConfig(context.Background(), bgpServer, initialConfig, isGracefulRestart)
+
+	if err != nil {
+		// Handle error
+		return
+	}
+
+	sigCh := make(chan os.Signal, 1)
+	signal.Notify(sigCh, syscall.SIGHUP)
+
+	for range sigCh {
+		newConfig, err := ReadConfigFile("gobgp.conf", "toml")
+		if err != nil {
+			// Handle error
+			continue
+		}
+
+		currentConfig, err = UpdateConfig(context.Background(), bgpServer, currentConfig, newConfig)
+		if err != nil {
+			// Handle error
+			continue
+		}
+	}
+}