Merge pull request #138 from ngrok/del/update-example-copy

update example var names
ngrok · Nov 16, 2023 · 716fe70 · 716fe70
2 parents 8b5875b + 8ce6216
commit 716fe70
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 19 deletions.
diff --git a/examples/http/main.go b/examples/http/main.go
@@ -19,17 +19,17 @@ func main() {
 }
 
 func run(ctx context.Context) error {
-	tun, err := ngrok.Listen(ctx,
+	ln, err := ngrok.Listen(ctx,
 		config.HTTPEndpoint(),
 		ngrok.WithAuthtokenFromEnv(),
 	)
 	if err != nil {
 		return err
 	}
 
-	log.Println("tunnel created:", tun.URL())
+	log.Println("Ingress established at:", ln.URL())
 
-	return http.Serve(tun, http.HandlerFunc(handler))
+	return http.Serve(ln, http.HandlerFunc(handler))
 }
 
 func handler(w http.ResponseWriter, r *http.Request) {

diff --git a/examples/logging/main.go b/examples/logging/main.go
@@ -47,7 +47,7 @@ func run(ctx context.Context, lvlName string) error {
 		return err
 	}
 
-	tun, err := ngrok.Listen(ctx,
+	ln, err := ngrok.Listen(ctx,
 		config.HTTPEndpoint(),
 		ngrok.WithAuthtokenFromEnv(),
 		ngrok.WithLogger(&logger{lvl}),
@@ -56,9 +56,9 @@ func run(ctx context.Context, lvlName string) error {
 		return err
 	}
 
-	log.Println("tunnel created:", tun.URL())
+	log.Println("Ingress established at:", ln.URL())
 
-	return http.Serve(tun, http.HandlerFunc(handler))
+	return http.Serve(ln, http.HandlerFunc(handler))
 }
 
 func handler(w http.ResponseWriter, r *http.Request) {

diff --git a/examples/ngrok-forward-lite/main.go b/examples/ngrok-forward-lite/main.go
@@ -1,5 +1,5 @@
 // Naïve ngrok agent implementation.
-// Sets up a single tunnel and forwards it to another service.
+// Sets up a single listener and forwards it to another service.
 
 package main
 
@@ -67,7 +67,7 @@ func run(ctx context.Context, backend *url.URL) error {
 		return err
 	}
 
-	l.Log(ctx, ngrok_log.LogLevelInfo, "tunnel created", map[string]any{
+	l.Log(ctx, ngrok_log.LogLevelInfo, "ingress established", map[string]any{
 		"url": fwd.URL(),
 	})
 

diff --git a/examples/ngrok-http-lite/main.go b/examples/ngrok-http-lite/main.go
@@ -1,5 +1,5 @@
 // Naïve ngrok agent implementation.
-// Sets up a single tunnel and connects to an arbitrary HTTP server.
+// Sets up a single listener and connects to an arbitrary HTTP server.
 
 package main
 
@@ -38,7 +38,7 @@ func main() {
 		fmt.Fprintln(w, "Hello from ngrok-go!")
 	})}
 
-	// Serve with tunnel backend
+	// Serve with listener backend
 	if err := run(context.Background(), server); err != nil {
 		log.Fatal(err)
 	}
@@ -50,16 +50,16 @@ func main() {
 }
 
 func run(ctx context.Context, server *http.Server) error {
-	tunnel, err := ngrok.ListenAndServeHTTP(ctx,
+	ln, err := ngrok.ListenAndServeHTTP(ctx,
 		server,
 		config.HTTPEndpoint(),
 		ngrok.WithAuthtokenFromEnv(),
 		ngrok.WithLogger(&logger{lvl: ngrok_log.LogLevelDebug}),
 	)
 
 	if err == nil {
-		l.Log(ctx, ngrok_log.LogLevelInfo, "tunnel created", map[string]any{
-			"url": tunnel.URL(),
+		l.Log(ctx, ngrok_log.LogLevelInfo, "ingress established", map[string]any{
+			"url": ln.URL(),
 		})
 	}
 

diff --git a/examples/slog/main.go b/examples/slog/main.go
@@ -50,7 +50,7 @@ func run(ctx context.Context, lvlName string) error {
 	h := slog.HandlerOptions{Level: programLevel}.NewTextHandler(os.Stdout)
 	slog.SetDefault(slog.New(h))
 
-	tun, err := ngrok.Listen(ctx,
+	ln, err := ngrok.Listen(ctx,
 		config.HTTPEndpoint(),
 		ngrok.WithAuthtokenFromEnv(),
 		ngrok.WithLogger(slogadapter.NewLogger(slog.Default())),
@@ -59,9 +59,9 @@ func run(ctx context.Context, lvlName string) error {
 		return err
 	}
 
-	slog.Info("tunnel created", "url", tun.URL())
+	slog.Info("Ingress established", "url", ln.URL())
 
-	return http.Serve(tun, http.HandlerFunc(handler))
+	return http.Serve(ln, http.HandlerFunc(handler))
 }
 
 func handler(w http.ResponseWriter, r *http.Request) {

diff --git a/examples/tcp/main.go b/examples/tcp/main.go
@@ -20,17 +20,17 @@ func main() {
 }
 
 func run(ctx context.Context) error {
-	tun, err := ngrok.Listen(ctx,
+	ln, err := ngrok.Listen(ctx,
 		config.TCPEndpoint(),
 		ngrok.WithAuthtokenFromEnv(),
 	)
 	if err != nil {
 		return err
 	}
 
-	log.Println("started tunnel:", tun.URL())
+	log.Println("Ingress established at:", ln.URL())
 
-	return runListener(ctx, tun)
+	return runListener(ctx, ln)
 }
 
 func runListener(ctx context.Context, l net.Listener) error {