README
¶
Handler Modules
This directory contains all handler modules. A handler module is one which is defines the main logic for a request response. nedomi is very modular in this respect and you are welcome to write you own handler modules. Every subdirectory in here is a handler module.
A virtual host must have exactly one handler module and it is the brain of the request handling.
Contents
Anatomy of a Handler Module
It is a subpackage in the handler/ directory which must have a new function of the type:
func New() *T
where T is a type which implements the RequestHandler interface defined in interface.go.
How to Write Your Own Module?
You can add your own modules as long as their names do not collide with any other module's name.
- Go into the
handler/directory -$ cd .../nedomi/handler - Create a directory which will be the name of your module. Lets say it is random so it is
mkdir random - Write your implementation of RequestHandler in this directory as
package random - In the main project directory run
go generate ./...
Removing a Module
Lets say you want to remove the random module.
- Within the project directory
rm -rf handler/randomgo generate ./...
You will have to leave at least one handler module in order to have a working build.
How Does it Work?
golang does not support dynamic linking. So our only choice is to come up with some other trick to have optional modules. For that reason we use the go generate tool.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(cfg *config.Handler, l *types.Location, next types.RequestHandler) (types.RequestHandler, error)
New creates and returns a new RequestHandler identified by its module name. Identifier is the module's directory (hence its package name). Additionaly it receives handler specific config in the form of *json.RawMessage and types.Location representing the location the handler will be used for.
Types ¶
This section is empty.
Source Files
Directories