From 95fcedf2fac5963a94ef412f7682ce9e91e4772f Mon Sep 17 00:00:00 2001 From: Yohann D'ANELLO Date: Tue, 13 Oct 2020 00:31:47 +0200 Subject: [PATCH] Comment telnet package --- stream/telnet/telnet.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/stream/telnet/telnet.go b/stream/telnet/telnet.go index 8ad53df..874fff1 100644 --- a/stream/telnet/telnet.go +++ b/stream/telnet/telnet.go @@ -9,6 +9,8 @@ import ( ) var ( + // TODO Config should not be exported + // Cfg contains the different options of the telnet package, see below Cfg *Options currentMessage *string ) @@ -22,6 +24,7 @@ type Options struct { Delay int } +// Serve starts the telnet server and listen to clients func Serve(config *Options) { Cfg = config @@ -70,7 +73,7 @@ func asciiChar(pixel byte) string { return asciiChars[(255-pixel)/23] } -// ServeAsciiArt starts a telnet server that send all packets as ASCII Art +// ServeAsciiArt send all packets received by ffmpeg as ASCII Art to telnet clients func ServeAsciiArt(reader io.ReadCloser) { if !Cfg.Enabled { _ = reader.Close()