common

module
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Apr 20, 2021 License: Apache-2.0

README

Common

CircleCI Godoc

This repository contains GO libraries used in the different component of Perses.

This set of library aims to provide a way:

  • to handle processes management with graceful stop
  • to defines an HTTP API
  • to handle the configuration

Note: These libraries are mainly designed to ease the development of Perses. As it is still a beta, breaking change can happen between two release. But, as there is nothing really specific to Perses itself, you can use it, but at your own risks.

Here a short description about what each package provides.

  • app: provides a struct to be used to help to start an application (usually with an HTTP API)
  • async: provides different way to manage an asynchronous job
  • config: provides a config resolver that helps to manage the configuration. It also provides a default configuration for etcd
  • echo: provides a builder that helps to manage middleware, api and help to start a server with a context management.
  • etcd: provides a dao that wraps the etcd client to simplify a bit how to use it
  • slices: provides utils method to manipulate the slice (mostly slice of string)

Directories

Path Synopsis
Package app is exposing a struct to handle the building and the managing of the different task coming from the package async.
Package app is exposing a struct to handle the building and the managing of the different task coming from the package async.
Package async provide different kind of interface and implementation to manipulate a bit more safely the go routing.
Package async provide different kind of interface and implementation to manipulate a bit more safely the go routing.
taskhelper
Package taskhelper provides struct and methods to help to synchronize different async.Task together and to simply start the async.Task properly This package should mainly used through the package app and not directly by the developer.
Package taskhelper provides struct and methods to help to synchronize different async.Task together and to simply start the async.Task properly This package should mainly used through the package app and not directly by the developer.
Package config provides a single way to manage the configuration of your application.
Package config provides a single way to manage the configuration of your application.

Jump to

Keyboard shortcuts

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