Categorygithub.com/goph/serverz
modulepackage
0.13.0
Repository: https://github.com/goph/serverz.git
Documentation: pkg.go.dev

# README

Serverz

Build Status Go Report Card GoDoc

Web app toolkit to easily manage server based environments.

Development

The project requires Glide to install dependencies.

$ make dep

When all coding and testing is done, please run the test suite:

$ make check

License

The MIT License (MIT). Please see License File for more information.

# Packages

No description provided by the author

# Functions

Close calls Close method on a struct if it implements the Closer interface.
DisableLogging disables the default logger.
NewAddr returns a new in-memory Addr.
NewListener returns a new in-memory listener.
NewQueue returns a new Queue.

# Variables

DefaultLogger is used by servers as a default when no logger is specified.
NoopCloser is a dummy Closer implementation which can be used as a fallback.

# Structs

AppServer wraps a server and provides all kinds of functionalities, such as: - Logging server events - Registering custom closers in the server - Listening on a net.Addr.
CronDaemon is a daemon with an internal scheduler for a CronJob.
DaemonServer is a server without network, running a daemon.
Queue holds a list of servers and starts them at once.

# Interfaces

AddrServer holds a net.Addr which carries the information of the listening network and address.
Closer is an alias interface to io.Closer.
CronJob is ran scheduled by the CronDaemon.
Daemon is a long-running process in the background.
Server in this context is an abstraction over anything that can be started and stopped (either gracefully or forcefully).

# Type aliases

CloserFunc makes any function a Closer.
Closers is a collection of Closer instances.