api

Documentation

Overview

Package api contains the webserver for API and SSE subscription

Index

• type HTTPServerConfig
• type SSESubscription
• type Server
  • func New(cfg *HTTPServerConfig) (srv *Server)
  • func (s *Server) RunInBackground()
  • func (s *Server) SendTx(ctx context.Context, tx *common.TxIn) error
  • func (s *Server) Shutdown()

Types

type HTTPServerConfig

type HTTPServerConfig struct {
	ListenAddr string
	Log        *zap.SugaredLogger

	EnablePprof bool // https://go-chi.io/#/pages/middleware?id=profiler

	DrainDuration            time.Duration
	GracefulShutdownDuration time.Duration
	ReadTimeout              time.Duration
	WriteTimeout             time.Duration
}

type SSESubscription

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

type Server

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

func New

func New(cfg *HTTPServerConfig) (srv *Server)

func (*Server) RunInBackground

func (s *Server) RunInBackground()

func (*Server) SendTx

func (s *Server) SendTx(ctx context.Context, tx *common.TxIn) error

func (*Server) Shutdown

func (s *Server) Shutdown()