dictd

command module
v0.0.0-...-f148425 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 1, 2016 License: MIT Imports: 6 Imported by: 0

README

go-dictd

go-dictd is a Go library for implementing custom RFC2229/dictd protocol servers.

Basically, the coolest part is that you can define your own custom "tables" for the dictd server. So far, this comes with a LevelDB and an Urban Dictionary example.

Writing a custom Database

The protocol you have to implement is the dictd.Database interface, which looks something like:

/* Database is an interface for external Database "Backends" to implement. */
type Database interface {

	/* Method to handle incoming `MATCH` commands. */
	Match(name string, query string, strat string) []*Definition

	/* Method to handle incoming `DEFINE` commands. */
	Define(name string, query string) []*Definition

	/* Method to handle incoming `SHOW INFO` commands. */
	Info(name string) string

	/* Method to return a one-line Description of the Database. */
	Description(name string) string

	/* Get a list of valid Match Strategies. */
	Strategies(name string) map[string]string
}

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL