api

package

v0.0.0-...-269b0f3 Latest Latest Go to latest Published: May 10, 2023 License: MIT Imports: 8 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Uchet-kz/hectane

Documentation ¶

Index ¶

type API
- func New(config *Config, queue *queue.Queue) *API
type Config

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	// contains filtered or unexported fields
}

HTTP API for managing a mail queue.

func New ¶

func New(config *Config, queue *queue.Queue) *API

Create a new API instance for the specified queue.

func (*API) ServeHTTP ¶

func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

Process an incoming request. This method logs the request and checks to ensure that HTTP basic auth credentials were supplied if required.

func (*API) Start ¶

func (a *API) Start() error

Start listening for new requests.

func (*API) Stop ¶

func (a *API) Stop()

Stop listening for new requests.

type Config ¶

type Config struct {
	Addr       string `json:"bind"`
	CORSOrigin string `json:"cors-origin"`
	TLSCert    string `json:"tls-cert"`
	TLSKey     string `json:"tls-key"`
	Username   string `json:"username"`
	Password   string `json:"password"`
}

Configuration for the HTTP API.

Source Files ¶

View all Source files

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