https://github.com/mlctrez/servicego

https://github.com/mlctrez/servicego

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mlctrez/servicego
• Owner: mlctrez
• License: apache-2.0
• Created: 2022-04-02T18:52:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-04-23T18:42:48.000Z (about 1 year ago)
• Last Synced: 2025-10-10T03:56:35.204Z (9 months ago)
• Language: Go
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# servicego

[![Go Report Card](https://badge.mlctrez.com/mlctrez/servicego)](https://goreportcard.com/report/github.com/mlctrez/servicego)

### Background

The servicego package provides a wrapper for the functionality

in [github.com/kardianos/service](https://github.com/kardianos/service)

This was written to simplify usage when writing lots of services, eliminating 

much of the boiler place code to set up a new service.

### Defaults

Service name, display name, and description all default to the executable name.

### A Brief How-To

```bash

go get github.com/mlctrez/servicego

```

Embed [Defaults](wrapper.go) in a struct for your [Service](api.go).

```go

type exampleService struct {

    servicego.Defaults

}

```

Implement Start and Stop as you would in 

[github.com/kardianos/service](https://github.com/kardianos/service)

```go

func (e *exampleService) Start(s service.Service) error {

    // Start should not block so do non-setup work in goroutines.

    // Return non nil error if the service cannot be started.

}

func (e *exampleService) Stop(s service.Service) error {

    // Cancel goroutines if you require a graceful shutdown.

    // Stop should not block and should return with a few seconds.

}

```