rkgin

Jan 17, 2022

Changes in this version

+ type BootConfig struct

+ Gin []struct{ ... }

type GinEntry

+ func (entry *GinEntry) Apis(ctx *gin.Context)

+ func (entry *GinEntry) Req(ctx *gin.Context)

+ func (entry *GinEntry) TV(ctx *gin.Context)

type GinEntryOption

+ func WithCertEntry(certEntry *rkentry.CertEntry) GinEntryOption

+ func WithCommonServiceEntry(commonServiceEntry *rkentry.CommonServiceEntry) GinEntryOption

+ func WithDescription(description string) GinEntryOption

+ func WithEventLoggerEntry(eventLogger *rkentry.EventLoggerEntry) GinEntryOption

+ func WithPromEntry(prom *rkentry.PromEntry) GinEntryOption

+ func WithStaticFileHandlerEntry(staticEntry *rkentry.StaticFileHandlerEntry) GinEntryOption

+ func WithSwEntry(sw *rkentry.SwEntry) GinEntryOption

+ func WithTvEntry(tvEntry *rkentry.TvEntry) GinEntryOption

+ func WithZapLoggerEntry(zapLogger *rkentry.ZapLoggerEntry) GinEntryOption

Dec 5, 2021

Changes in this version

+ const StaticFileHandlerEntryDescription

+ const StaticFileHandlerEntryNameDefault

+ const StaticFileHandlerEntryType

+ type BootConfigStaticHandler struct

+ Enabled bool

+ Path string

+ SourcePath string

+ SourceType string

type GinEntry

+ StaticFileEntry *StaticFileHandlerEntry

+ func (entry *GinEntry) IsStaticFileHandlerEnabled() bool

type GinEntryOption

+ func WithStaticFileHandlerEntryGin(staticEntry *StaticFileHandlerEntry) GinEntryOption

+ type StaticFileHandlerEntry struct

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ Fs http.FileSystem

+ Path string

+ Template *template.Template

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func NewStaticFileHandlerEntry(opts ...StaticFileHandlerEntryOption) *StaticFileHandlerEntry

+ func (entry *StaticFileHandlerEntry) Bootstrap(ctx context.Context)

+ func (entry *StaticFileHandlerEntry) GetDescription() string

+ func (entry *StaticFileHandlerEntry) GetFileHandler() gin.HandlerFunc

+ func (entry *StaticFileHandlerEntry) GetName() string

+ func (entry *StaticFileHandlerEntry) GetType() string

+ func (entry *StaticFileHandlerEntry) Interrupt(ctx context.Context)

+ func (entry *StaticFileHandlerEntry) MarshalJSON() ([]byte, error)

+ func (entry *StaticFileHandlerEntry) String() string

+ func (entry *StaticFileHandlerEntry) UnmarshalJSON([]byte) error

+ type StaticFileHandlerEntryOption func(*StaticFileHandlerEntry)

+ func WithEventLoggerEntryStatic(eventLoggerEntry *rkentry.EventLoggerEntry) StaticFileHandlerEntryOption

+ func WithFileSystemStatic(fs http.FileSystem) StaticFileHandlerEntryOption

+ func WithNameStatic(name string) StaticFileHandlerEntryOption

+ func WithPathStatic(path string) StaticFileHandlerEntryOption

+ func WithZapLoggerEntryStatic(zapLoggerEntry *rkentry.ZapLoggerEntry) StaticFileHandlerEntryOption

Jul 11, 2021

Changes in this version

+ const CommonServiceEntryDescription

+ const CommonServiceEntryNameDefault

+ const CommonServiceEntryType

+ const GinEntryDescription

+ const GinEntryType

+ const PromEntryDescription

+ const PromEntryNameDefault

+ const PromEntryType

+ const SwEntryDescription

+ const SwEntryNameDefault

+ const SwEntryType

+ const TvEntryDescription

+ const TvEntryNameDefault

+ const TvEntryType

+ var Templates = map[string][]byte

+ func RegisterGinEntriesWithConfig(configFilePath string) map[string]rkentry.Entry

+ type BootConfigCommonService struct

+ Enabled bool

+ type BootConfigGin struct

+ Gin []struct{ ... }

+ type BootConfigProm struct

+ Enabled bool

+ Path string

+ Pusher struct{ ... }

+ type BootConfigSw struct

+ Enabled bool

+ Headers []string

+ JsonPath string

+ Path string

+ type BootConfigTv struct

+ Enabled bool

+ type CommonServiceEntry struct

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func NewCommonServiceEntry(opts ...CommonServiceEntryOption) *CommonServiceEntry

+ func (entry *CommonServiceEntry) Apis(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Bootstrap(ctx context.Context)

+ func (entry *CommonServiceEntry) Certs(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Configs(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Deps(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Entries(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Gc(ctx *gin.Context)

+ func (entry *CommonServiceEntry) GetDescription() string

+ func (entry *CommonServiceEntry) GetName() string

+ func (entry *CommonServiceEntry) GetType() string

+ func (entry *CommonServiceEntry) Git(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Healthy(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Info(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Interrupt(ctx context.Context)

+ func (entry *CommonServiceEntry) License(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Logs(ctx *gin.Context)

+ func (entry *CommonServiceEntry) MarshalJSON() ([]byte, error)

+ func (entry *CommonServiceEntry) Readme(ctx *gin.Context)

+ func (entry *CommonServiceEntry) Req(ctx *gin.Context)

+ func (entry *CommonServiceEntry) String() string

+ func (entry *CommonServiceEntry) Sys(ctx *gin.Context)

+ func (entry *CommonServiceEntry) UnmarshalJSON([]byte) error

+ type CommonServiceEntryOption func(*CommonServiceEntry)

+ func WithEventLoggerEntryCommonService(eventLoggerEntry *rkentry.EventLoggerEntry) CommonServiceEntryOption

+ func WithNameCommonService(name string) CommonServiceEntryOption

+ func WithZapLoggerEntryCommonService(zapLoggerEntry *rkentry.ZapLoggerEntry) CommonServiceEntryOption

type GinEntry

+ CertEntry *rkentry.CertEntry

+ CommonServiceEntry *CommonServiceEntry

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ Interceptors []gin.HandlerFunc

+ Port uint64

+ PromEntry *PromEntry

+ Router *gin.Engine

+ Server *http.Server

+ SwEntry *SwEntry

+ TvEntry *TvEntry

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func GetGinEntry(name string) *GinEntry

+ func RegisterGinEntry(opts ...GinEntryOption) *GinEntry

+ func (entry *GinEntry) AddInterceptor(inters ...gin.HandlerFunc)

+ func (entry *GinEntry) GetDescription() string

+ func (entry *GinEntry) Interrupt(ctx context.Context)

+ func (entry *GinEntry) IsCommonServiceEnabled() bool

+ func (entry *GinEntry) IsPromEnabled() bool

+ func (entry *GinEntry) IsSwEnabled() bool

+ func (entry *GinEntry) IsTvEnabled() bool

+ func (entry *GinEntry) MarshalJSON() ([]byte, error)

+ func (entry *GinEntry) RegisterInterceptor(interceptor gin.HandlerFunc)

+ func (entry *GinEntry) UnmarshalJSON([]byte) error

type GinEntryOption

+ func WithCertEntryGin(certEntry *rkentry.CertEntry) GinEntryOption

+ func WithCommonServiceEntryGin(commonServiceEntry *CommonServiceEntry) GinEntryOption

+ func WithDescriptionGin(description string) GinEntryOption

+ func WithEventLoggerEntryGin(eventLogger *rkentry.EventLoggerEntry) GinEntryOption

+ func WithInterceptorsGin(inters ...gin.HandlerFunc) GinEntryOption

+ func WithNameGin(name string) GinEntryOption

+ func WithPortGin(port uint64) GinEntryOption

+ func WithPromEntryGin(prom *PromEntry) GinEntryOption

+ func WithSwEntryGin(sw *SwEntry) GinEntryOption

+ func WithTVEntryGin(tvEntry *TvEntry) GinEntryOption

+ func WithZapLoggerEntryGin(zapLogger *rkentry.ZapLoggerEntry) GinEntryOption

+ type PromEntry struct

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ Gatherer prometheus.Gatherer

+ Path string

+ Port uint64

+ Pusher *rkprom.PushGatewayPusher

+ Registerer prometheus.Registerer

+ Registry *prometheus.Registry

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func NewPromEntry(opts ...PromEntryOption) *PromEntry

+ func (entry *PromEntry) Bootstrap(ctx context.Context)

+ func (entry *PromEntry) GetDescription() string

+ func (entry *PromEntry) GetName() string

+ func (entry *PromEntry) GetType() string

+ func (entry *PromEntry) Interrupt(ctx context.Context)

+ func (entry *PromEntry) MarshalJSON() ([]byte, error)

+ func (entry *PromEntry) RegisterCollectors(collectors ...prometheus.Collector) error

+ func (entry *PromEntry) String() string

+ func (entry *PromEntry) UnmarshalJSON(b []byte) error

+ type PromEntryOption func(*PromEntry)

+ func WithEventLoggerEntryProm(eventLoggerEntry *rkentry.EventLoggerEntry) PromEntryOption

+ func WithNameProm(name string) PromEntryOption

+ func WithPathProm(path string) PromEntryOption

+ func WithPortProm(port uint64) PromEntryOption

+ func WithPromRegistryProm(registry *prometheus.Registry) PromEntryOption

+ func WithPusherProm(pusher *rkprom.PushGatewayPusher) PromEntryOption

+ func WithZapLoggerEntryProm(zapLoggerEntry *rkentry.ZapLoggerEntry) PromEntryOption

+ type SwEntry struct

+ EnableCommonService bool

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ Headers map[string]string

+ JsonPath string

+ Path string

+ Port uint64

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func NewSwEntry(opts ...SwOption) *SwEntry

+ func (entry *SwEntry) AssetsFileHandler() gin.HandlerFunc

+ func (entry *SwEntry) Bootstrap(ctx context.Context)

+ func (entry *SwEntry) ConfigFileHandler() gin.HandlerFunc

+ func (entry *SwEntry) GetDescription() string

+ func (entry *SwEntry) GetName() string

+ func (entry *SwEntry) GetType() string

+ func (entry *SwEntry) Interrupt(ctx context.Context)

+ func (entry *SwEntry) MarshalJSON() ([]byte, error)

+ func (entry *SwEntry) String() string

+ func (entry *SwEntry) UnmarshalJSON([]byte) error

+ type SwOption func(*SwEntry)

+ func WithEnableCommonServiceSw(enable bool) SwOption

+ func WithEventLoggerEntrySw(eventLoggerEntry *rkentry.EventLoggerEntry) SwOption

+ func WithHeadersSw(headers map[string]string) SwOption

+ func WithJsonPathSw(path string) SwOption

+ func WithNameSw(name string) SwOption

+ func WithPathSw(path string) SwOption

+ func WithPortSw(port uint64) SwOption

+ func WithZapLoggerEntrySw(zapLoggerEntry *rkentry.ZapLoggerEntry) SwOption

+ type TvEntry struct

+ EntryDescription string

+ EntryName string

+ EntryType string

+ EventLoggerEntry *rkentry.EventLoggerEntry

+ Template *template.Template

+ ZapLoggerEntry *rkentry.ZapLoggerEntry

+ func NewTvEntry(opts ...TvEntryOption) *TvEntry

+ func (entry *TvEntry) AssetsFileHandler() gin.HandlerFunc

+ func (entry *TvEntry) Bootstrap(ctx context.Context)

+ func (entry *TvEntry) GetDescription() string

+ func (entry *TvEntry) GetName() string

+ func (entry *TvEntry) GetType() string

+ func (entry *TvEntry) Interrupt(ctx context.Context)

+ func (entry *TvEntry) MarshalJSON() ([]byte, error)

+ func (entry *TvEntry) String() string

+ func (entry *TvEntry) TV(ctx *gin.Context)

+ func (entry *TvEntry) UnmarshalJSON([]byte) error

+ type TvEntryOption func(entry *TvEntry)

+ func WithEventLoggerEntryTv(eventLoggerEntry *rkentry.EventLoggerEntry) TvEntryOption

+ func WithNameTv(name string) TvEntryOption

+ func WithZapLoggerEntryTv(zapLoggerEntry *rkentry.ZapLoggerEntry) TvEntryOption

Nov 22, 2020

Changes in this version

type GinEntryOption

+ func WithEnableTV(enable bool) GinEntryOption

Nov 9, 2020

Changes in this version

type GinEntry

+ func (entry *GinEntry) GetType() string

+ func (entry *GinEntry) IsSWEnabled() bool

+ func (entry *GinEntry) IsTlsEnabled() bool

+ func (entry *GinEntry) String() string

+ func (entry *GinEntry) Wait(draining time.Duration)

Nov 8, 2020

Changes in this version

type GinEntryOption

+ func WithEnableCommonService(enable bool) GinEntryOption

Nov 5, 2020

Changes in this version

+ func NewGinEntries(path string, factory *rk_query.EventFactory, logger *zap.Logger) map[string]*GinEntry

+ type GinEntry struct

+ func NewGinEntry(opts ...GinEntryOption) *GinEntry

+ func (entry *GinEntry) Bootstrap()

+ func (entry *GinEntry) GetName() string

+ func (entry *GinEntry) GetPort() uint64

+ func (entry *GinEntry) GetRouter() *gin.Engine

+ func (entry *GinEntry) GetSWEntry() *swEntry

+ func (entry *GinEntry) GetServer() *http.Server

+ func (entry *GinEntry) GetTlsEntry() *tlsEntry

+ func (entry *GinEntry) Shutdown()

+ type GinEntryOption func(*GinEntry)

+ func WithEventFactory(factory *rk_query.EventFactory) GinEntryOption

+ func WithInterceptors(inters ...gin.HandlerFunc) GinEntryOption

+ func WithLogger(logger *zap.Logger) GinEntryOption

+ func WithName(name string) GinEntryOption

+ func WithPort(port uint64) GinEntryOption

+ func WithRouter(router *gin.Engine) GinEntryOption

+ func WithSWEntry(sw *swEntry) GinEntryOption

+ func WithTlsEntry(tls *tlsEntry) GinEntryOption