api

Documentation

Index

• Variables
• type Module
• type SyncInvoker

Variables

var ShutdownHookTime = time.Second * 5

ShutdownHookTime is the global shutdown hook time.

Types

type Module

type Module interface {
	// Prepare would do some preparing workers, such build connection with external services.
	Prepare() error
	// Boot would start the module and return error when started failed. When a stop signal received
	// or an exception occurs, the shutdown function would be called.
	Boot(ctx context.Context)

	// Shutdown could do some clean job to close Module.
	Shutdown()
}

Module id a custom plugin interface, which defines the processing.

type SyncInvoker

type SyncInvoker interface {
	// SyncInvoke means synchronized process event
	SyncInvoke(d *v1.SniffData) (*v1.SniffData, error)
}