Categorygithub.com/clubcedille/server-utils
modulepackage
1.0.0
Repository: https://github.com/clubcedille/server-utils.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
6
Files
189 SLOC

# README

server-utils

Utils library for Go HTTP & gRPC servers.

Install this library

To use this library in your own project, simply run this command:

$ go get github.com/clubcedille/server-utils@latest
...

gRPC Server

The server-utils library offers a gRPC implementation of graceful shutdown and real-time status fetching. See this example to learn how to use its functions.

HTTP Server

The server-utils library offers an HTTP implementation of graceful shutdown and real-time status fetching. See this example to learn how to use its functions.

# Packages

No description provided by the author

# Functions

NewGrpcServer creates a new instance of *GrpcServer.
NewHttpServer creates a new instance of *HttpServer.

# Constants

Running is the status for a running server.
Stopped is the status for a stopped server.

# Structs

GrpcServer represents an instance of *grpc.Server, which gracefully shutdowns and has a status.
HttpServer represents an instance of *http.Server, which gracefully shutdowns and has a status.
RunRequest is a set of parameters passed to the 'Run' function of each server.

# Interfaces

Server represents any kind of server that is able to run, shutdown and fetch a status from.

# Type aliases

No description provided by the author