goserver

README

goserver

goserver

This README documents only the public API exported by the goserver package.

Short summary

• goserver provides a Config struct and a ServerHandler type. Create a handler with New(*Config) and control a server process using exported methods on ServerHandler.

Public API (types and functions)

• type Config

  • Fields (public fields used by the package):
    • RootFolder string
    • MainFileWithoutExtension string
    • ArgumentsForCompilingServer func() []string
    • ArgumentsToRunServer func() []string
    • PublicFolder string
    • AppPort string
    • Logger io.Writer
    • ExitChan chan bool

• type ServerHandler

  • Construct with: New(c *Config) *ServerHandler
  • Exported methods (signatures as found in source):
    • MainFilePath() string — returns the path to the generated/external main server file inside the configured RootFolder.
    • Name() string — returns the server name ("GoServer").
    • UnobservedFiles() []string — files that should not be observed by file watchers (executables, temp files).
    • RestartServer() error — restart the external server.
    • StartServer(wg *sync.WaitGroup) — starts the external server; intended to be run as a goroutine and calls wg.Done() when finished.
    • NewFileEvent(fileName, extension, filePath, event string) error — handle file system events; recognized events include create and write for triggering generation/compilation/restart.

Notes and behaviour

• The package may generate an external server file from embedded templates when the external file is missing. That generation and other internal helpers are not part of the public API (they are unexported).
• The README intentionally documents only the exported surface. Implementation details, unexported helpers and additional files in templates/ or docs/ are not documented here.

Minimal usage example

package main

import (
		"os"
		"sync"
		"github.com/cdvelop/goserver"
)

func main() {
		cfg := &goserver.Config{
				RootFolder:               "./web",
				MainFileWithoutExtension: "main.server",
				ArgumentsForCompilingServer: func() []string { return []string{} },
				ArgumentsToRunServer:        func() []string { return []string{} },
				PublicFolder:             "public",
				AppPort:                  "8080",
				Logger:                   os.Stdout,
				ExitChan:                 make(chan bool),
		}

		handler := goserver.New(cfg)

		var wg sync.WaitGroup
		wg.Add(1)
		go handler.StartServer(&wg)
		wg.Wait()
}

If you want more documentation about embedded templates or design rationale, consult the templates/ and docs/ folders which contain implementation docs — they are not part of the exported API surface described here.

Documentation

Index

• type Config
• type ServerHandler
  • func New(c *Config) *ServerHandler
  • func (h *ServerHandler) MainFilePath() string
  • func (h *ServerHandler) Name() string
  • func (h *ServerHandler) NewFileEvent(fileName, extension, filePath, event string) error
  • func (h *ServerHandler) RestartServer() error
  • func (h *ServerHandler) StartServer(wg *sync.WaitGroup)
  • func (h *ServerHandler) UnobservedFiles() []string

Types

type Config

type Config struct {
	RootFolder                  string          // e.g., web
	MainFileWithoutExtension    string          // e.g., main.server
	ArgumentsForCompilingServer func() []string // e.g., []string{"-X 'main.version=v1.0.0'"}
	ArgumentsToRunServer        func() []string // e.g., []string{"dev"}
	PublicFolder                string          // e.g., public
	AppPort                     string          // e.g., 8080
	Logger                      io.Writer       // For logging output
	ExitChan                    chan bool       // Global channel to signal shutdown
}

type ServerHandler

type ServerHandler struct {
	*Config
	// contains filtered or unexported fields
}

func New

func New(c *Config) *ServerHandler

func (*ServerHandler) MainFilePath

func (h *ServerHandler) MainFilePath() string

MainFilePath eg: <root>/web/main.server.go

func (*ServerHandler) Name

func (h *ServerHandler) Name() string

func (*ServerHandler) NewFileEvent

func (h *ServerHandler) NewFileEvent(fileName, extension, filePath, event string) error

event: create,write,remove,rename

func (*ServerHandler) RestartServer

func (h *ServerHandler) RestartServer() error

func (*ServerHandler) StartServer

func (h *ServerHandler) StartServer(wg *sync.WaitGroup)

Start inicia el servidor como goroutine

func (*ServerHandler) UnobservedFiles

func (h *ServerHandler) UnobservedFiles() []string

UnobservedFiles returns the list of files that should not be tracked by file watchers eg: main.exe, main_temp.exe