types

Documentation

Index

• Constants
• type Database
• type MiddlewareFunc
• type MiddlewareGroup
  • func (mw MiddlewareGroup) Add(fullMethod string, middlewareFunc ...MiddlewareFunc)
  • func (mw MiddlewareGroup) AddProto(protoDesc protoreflect.FileDescriptor, handler any, ...)
• type Module
• type Server
• type Service
• type Worker
• type WorkerHandler
• type WorkerHandlerFunc
• type WorkerHandlerGroup
  • func (m *WorkerHandlerGroup) Add(patternRoute string, mainHandlerFunc WorkerHandlerFunc, ...)
  • func (m *WorkerHandlerGroup) AddMultiRoute(patternRoutes []string, mainHandlerFunc WorkerHandlerFunc, ...)
• type WorkerHandlerOptionFunc
  • func WorkerHandlerOptionAddConfig(key string, value any) WorkerHandlerOptionFunc
  • func WorkerHandlerOptionAddHandlers(handlerFuncs ...WorkerHandlerFunc) WorkerHandlerOptionFunc
  • func WorkerHandlerOptionAutoACK(auto bool) WorkerHandlerOptionFunc
  • func WorkerHandlerOptionDisableTrace() WorkerHandlerOptionFunc

Constants

const (
	// REST server
	REST Server = "rest"
	// GRPC server
	GRPC Server = "grpc"
	// GraphQL server
	GraphQL Server = "graphql"

	// Kafka worker
	Kafka Worker = "kafka"
	// RedisSubscriber worker
	RedisSubscriber Worker = "redis_subscriber"
	// RabbitMQ worker
	RabbitMQ Worker = "rabbit_mq"
	// Scheduler worker
	Scheduler Worker = "scheduler"
	// TaskQueue worker
	TaskQueue Worker = "task_queue"
	// PostgresListener worker
	PostgresListener Worker = "postgres_listener"
)

Types

type Database

type Database int

Database enum

const (
	// SQL database type
	SQL Database = iota

	// Mongo database type
	Mongo

	// Redis database type
	Redis

	// ElasticSearch database type
	ElasticSearch
)

type MiddlewareFunc

type MiddlewareFunc func(context.Context) (context.Context, error)

MiddlewareFunc type

type MiddlewareGroup

type MiddlewareGroup map[string][]MiddlewareFunc

MiddlewareGroup type

func (MiddlewareGroup) Add

func (mw MiddlewareGroup) Add(fullMethod string, middlewareFunc ...MiddlewareFunc)

Add register full method to middleware

func (MiddlewareGroup) AddProto

func (mw MiddlewareGroup) AddProto(protoDesc protoreflect.FileDescriptor, handler any, middlewareFunc ...MiddlewareFunc)

AddProto register proto for grpc middleware

type Module

type Module string

Module is the type returned by a Classifier module

type Server

type Server string

Server is the type returned by a classifier server (REST, gRPC, GraphQL)

type Service

type Service string

Service is the type returned by a classifier service name

type Worker

type Worker string

Worker is the type returned by a classifier worker (kafka, redis subscriber, rabbitmq, scheduler, task queue)

type WorkerHandler

type WorkerHandler struct {
	Pattern      string
	HandlerFuncs []WorkerHandlerFunc
	DisableTrace bool
	AutoACK      bool
	Configs      map[string]any
}

WorkerHandler types

type WorkerHandlerFunc

type WorkerHandlerFunc func(ctx *candishared.EventContext) error

WorkerHandlerFunc types

type WorkerHandlerGroup

type WorkerHandlerGroup struct {
	Handlers []WorkerHandler
}

WorkerHandlerGroup group of worker handlers by pattern string

func (*WorkerHandlerGroup) Add

func (m *WorkerHandlerGroup) Add(patternRoute string, mainHandlerFunc WorkerHandlerFunc, opts ...WorkerHandlerOptionFunc)

Add method from WorkerHandlerGroup, patternRoute can contains unique topic name, key, or task name

func (*WorkerHandlerGroup) AddMultiRoute

func (m *WorkerHandlerGroup) AddMultiRoute(patternRoutes []string, mainHandlerFunc WorkerHandlerFunc, opts ...WorkerHandlerOptionFunc)

AddMultiRoute method from WorkerHandlerGroup to handle multi topic in single method

type WorkerHandlerOptionFunc

type WorkerHandlerOptionFunc func(*WorkerHandler)

WorkerHandlerOptionFunc types

func WorkerHandlerOptionAddConfig

func WorkerHandlerOptionAddConfig(key string, value any) WorkerHandlerOptionFunc

WorkerHandlerOptionAddConfig set config

func WorkerHandlerOptionAddHandlers

func WorkerHandlerOptionAddHandlers(handlerFuncs ...WorkerHandlerFunc) WorkerHandlerOptionFunc

WorkerHandlerOptionAddHandlers add after handlers execute after main handler

func WorkerHandlerOptionAutoACK

func WorkerHandlerOptionAutoACK(auto bool) WorkerHandlerOptionFunc

WorkerHandlerOptionAutoACK set auto ACK

func WorkerHandlerOptionDisableTrace

func WorkerHandlerOptionDisableTrace() WorkerHandlerOptionFunc

WorkerHandlerOptionDisableTrace set disable trace