service

Documentation

Index

• Constants
• Variables
• func AttachProfilingHandlers(router *mux.Router)
• type Base
  • func New(opts ...Option) (*Base, error)
  • func (s *Base) Metadata() map[string]string
  • func (s *Base) Name() string
  • func (s *Base) SetStartedNow()
  • func (s *Base) Status() (string, time.Time)
  • func (s *Base) Stop()
  • func (s *Base) Stopped()
• type BufConn
  • func NewBufConn() *BufConn
  • func NewBufConnWithTimeout(timeout time.Duration) *BufConn
  • func (t *BufConn) Close(addr string) error
  • func (t *BufConn) CloseAll()
  • func (t *BufConn) Dial(_ context.Context, addr string) (*rpc.ClientConn, error)
  • func (t *BufConn) Listen(addr string) (net.Listener, error)
  • func (t *BufConn) NewHTTPClient(addr string) (*http.Client, error)
  • func (t *BufConn) Tranport(addr string) (*http.Transport, error)
• type ErrNotHealthy
  • func (e ErrNotHealthy) Error() string
• type GrpcConn
• type GrpcDialer
• type GrpcListener
• type HTTPClientBuilder
• type HTTPConn
  • func (s HTTPConn) ClientBuilderOrDefault() HTTPClientBuilder
  • func (s HTTPConn) ListenerOrDefault() HTTPListener
• type HTTPListener
• type HTTPTranporter
• type HealthChecker
• type HealthStatus
• type Kind
• type ListenerFn
• type NetConn
  • func (NetConn) Dial(_ context.Context, addr string) (*rpc.ClientConn, error)
  • func (NetConn) Listen(addr string) (net.Listener, error)
  • func (NetConn) NewHTTPClient(_ string) (*http.Client, error)
• type Option
  • func WithAddr(addr string) Option
  • func WithContext(ctx context.Context) Option
  • func WithKind(kind string) Option
  • func WithMetaInfo(meta *meta.Data) Option
  • func WithName(name string) Option
  • func WithOtelProvider(p *obs.OtelProvider) Option
• type StatusType
  • func (s StatusType) String() string

Constants

const (
	StatusStopped = iota + 1
	StatusStarted
	StatusStarting
)

Variables

var (
	DefaultGrpcDialer   = netConn
	DefaultGrpcListener = netConn
	DefaultHTTPListener = netConn
	DefaultHTTPClient   = netConn
)

var (
	ErrOtelStack  = errors.New("obs.New: error initializing otel stack")
	ErrEnvLoading = errors.New("env.Populate: error initializing otel stack")
)

var ErrEmptyAddress = errors.New("address is empty")

Functions

func AttachProfilingHandlers

func AttachProfilingHandlers(router *mux.Router)

Types

type Base

type Base struct {
	Meta *meta.Data

	HnUpTime     string
	Addr         string
	OtelProvider *obs.OtelProvider
	Ctx          context.Context
	// contains filtered or unexported fields
}

Base provides common functionality for processes that run in background.

func New

func New(opts ...Option) (*Base, error)

func (*Base) Metadata

func (s *Base) Metadata() map[string]string

func (*Base) Name

func (s *Base) Name() string

func (*Base) SetStartedNow

func (s *Base) SetStartedNow()

func (*Base) Status

func (s *Base) Status() (string, time.Time)

func (*Base) Stop

func (s *Base) Stop()

func (*Base) Stopped

func (s *Base) Stopped()

type BufConn

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

func NewBufConn

func NewBufConn() *BufConn

func NewBufConnWithTimeout

func NewBufConnWithTimeout(timeout time.Duration) *BufConn

func (*BufConn) Close

func (t *BufConn) Close(addr string) error

func (*BufConn) CloseAll

func (t *BufConn) CloseAll()

func (*BufConn) Dial

func (t *BufConn) Dial(_ context.Context, addr string) (*rpc.ClientConn, error)

func (*BufConn) Listen

func (t *BufConn) Listen(addr string) (net.Listener, error)

func (*BufConn) NewHTTPClient

func (t *BufConn) NewHTTPClient(addr string) (*http.Client, error)

func (*BufConn) Tranport

func (t *BufConn) Tranport(addr string) (*http.Transport, error)

type ErrNotHealthy

type ErrNotHealthy struct {
	Addr string
}

func (ErrNotHealthy) Error

func (e ErrNotHealthy) Error() string

type GrpcConn

type GrpcConn struct {
	Dialer   GrpcDialer
	Listener GrpcListener
}

type GrpcDialer

type GrpcDialer interface {
	Dial(ctx context.Context, addr string) (*rpc.ClientConn, error)
}

type GrpcListener

type GrpcListener interface {
	Listen(addr string) (net.Listener, error)
}

type HTTPClientBuilder

type HTTPClientBuilder interface {
	NewHTTPClient(addr string) (*http.Client, error)
}

type HTTPConn

type HTTPConn struct {
	ClientBuilder HTTPClientBuilder
	Listener      HTTPListener
}

func (HTTPConn) ClientBuilderOrDefault

func (s HTTPConn) ClientBuilderOrDefault() HTTPClientBuilder

func (HTTPConn) ListenerOrDefault

func (s HTTPConn) ListenerOrDefault() HTTPListener

type HTTPListener

type HTTPListener interface {
	Listen(addr string) (net.Listener, error)
}

type HTTPTranporter

type HTTPTranporter interface {
	Tranport(addr string) (*http.Transport, error)
}

type HealthChecker

type HealthChecker interface {
	CheckOk(ctx context.Context) error
	Close() error
}

type HealthStatus

type HealthStatus struct {
	Status        string `json:"status"`
	ServiceStatus string `json:"service_status"`
	StartedAt     string `json:"started_at"`
	Error         error
	Details       map[string]string `json:"details"`
}

type Kind

type Kind int

const (
	GRPC Kind = iota + 1
	HTTP
	Process
)

type ListenerFn

type ListenerFn func(ctx context.Context, addr string) (net.Listener, error)

type NetConn

type NetConn struct{}

func (NetConn) Dial

func (NetConn) Dial(_ context.Context, addr string) (*rpc.ClientConn, error)

func (NetConn) Listen

func (NetConn) Listen(addr string) (net.Listener, error)

func (NetConn) NewHTTPClient

func (NetConn) NewHTTPClient(_ string) (*http.Client, error)

type Option

type Option func(*Base)

func WithAddr

func WithAddr(addr string) Option

func WithContext

func WithContext(ctx context.Context) Option

func WithKind

func WithKind(kind string) Option

func WithMetaInfo

func WithMetaInfo(meta *meta.Data) Option

Setters

func WithName

func WithName(name string) Option

func WithOtelProvider

func WithOtelProvider(p *obs.OtelProvider) Option

type StatusType

type StatusType int

func (StatusType) String

func (s StatusType) String() string