docs: add docs

Author: keyvchan

client/client.go

@@ -8,6 +8,7 @@ import (
 	"github.com/keyvchan/NetAssist/protocol"
 )
 
+// Req is the entry point for the client
 func Req() {
 	types := flags.GetArg(2)
 	log.Println("Req:", types)

pkg/flags/args.go

@@ -5,12 +5,15 @@ import (
 	"os"
 )
 
+// args stores the arguments
 var args []string
 
+// SetArgs retrieves the arguments from the command line
 func SetArgs() {
 	args = os.Args
 }
 
+// GetArg returns the nth argument
 func GetArg(i int) string {
 	if i < len(args) {
 		return args[i]

pkg/utils/utils.go

@@ -5,6 +5,7 @@ import (
 	"log"
 )
 
+// Unimplemented is a stub function that returns an error
 func Unimplemented(message string) {
 	log.Fatal(errors.New("unimplemented: " + message))
 }

protocol/tcp.go

@@ -10,6 +10,7 @@ import (
 	"github.com/keyvchan/NetAssist/pkg/message"
 )
 
+// TCPServer is a TCP server, read from stdin and write to the client and read from the client write it to stdout
 func TCPServer() {
 	address := flags.GetArg(3)
 	listener, err := net.Listen("tcp", address)
@@ -41,6 +42,7 @@ func TCPServer() {
 
 }
 
+// accept_conn accepts connections from the listener and adds them to the connections map
 func accept_conn(read_chan chan message.Message, listener net.Listener, connections map[net.Conn]bool) {
 	for {
 		conn, err := listener.Accept()
@@ -59,6 +61,7 @@ func accept_conn(read_chan chan message.Message, listener net.Listener, connecti
 
 }
 
+// TCPClient is a TCP client, read from stdin and write to the server and read from the server when it to stdout
 func TCPClient() {
 	address := flags.GetArg(3)
 	conn, err := net.Dial("tcp", address)
@@ -92,6 +95,7 @@ func TCPClient() {
 	<-quit
 }
 
+// conn_cleanup removes closed connections from the connections map
 func conn_cleanup(closed_conn chan net.Conn, conns map[net.Conn]bool) {
 	for {
 		conn := <-closed_conn
@@ -101,6 +105,7 @@ func conn_cleanup(closed_conn chan net.Conn, conns map[net.Conn]bool) {
 
 }
 
+// write_to_conns writes messages to all connections in the connections map
 func write_to_conns(message_chan chan message.Message, connections map[net.Conn]bool) {
 	for {
 		message := <-message_chan

protocol/udp.go

@@ -9,6 +9,7 @@ import (
 	"github.com/keyvchan/NetAssist/pkg/message"
 )
 
+// UDPServer is a UDP server, it reads from stdin and writes to stdout and read from the client and write to the stdout
 func UDPServer() {
 	address := flags.GetArg(3)
 	conn, err := net.ListenPacket("udp", address)
@@ -30,6 +31,7 @@ func UDPServer() {
 	select {}
 }
 
+// UDPClient is a UDP client, it reads from stdin and writes to stdout and read from the server and write to the stdout
 func UDPClient() {
 	address := flags.GetArg(3)
 	conn, err := net.Dial("udp", address)

protocol/unix.go

@@ -11,6 +11,7 @@ import (
 	"github.com/keyvchan/NetAssist/pkg/flags"
 )
 
+// UnixServer is a server for the unix socket, it bridged server to stdout and stdin to server
 func UnixServer() {
 	address := flags.GetArg(3)
 	listener, err := net.Listen("unix", address)
@@ -33,6 +34,7 @@ func UnixServer() {
 
 }
 
+// UnixClient is a client for the unix socket, it bridged stdin to server and server to stdout
 func UnixClient() {
 	address := flags.GetArg(3)
 	conn, err := net.Dial("unix", address)

protocol/unixgram.go

@@ -11,6 +11,7 @@ import (
 	"github.com/keyvchan/NetAssist/pkg/flags"
 )
 
+// UnixgramServer is a server for the unixgram protocol, its create a bridge between server and client
 func UnixgramServer() {
 	address := flags.GetArg(3)
 	conn, err := net.ListenPacket("unixgram", address)
@@ -24,6 +25,7 @@ func UnixgramServer() {
 	}
 }
 
+// UnixgramClient is a client for the unixgram protocol, its create a bridge between server and client
 func UnixgramClient() {
 	address := flags.GetArg(3)
 	conn, err := net.Dial("unixgram", address)