Interface DecoderAPI

decoder/core/api.go:28–65

DecoderAPI describes functionality of a decoder.

// DecoderAPI describes functionality of a decoder.
type DecoderAPI interface {

	// PostInitFunc is called after the decoder has been initialized
	PostInitFunc() error

	// DeInitFunc is called prior to teardown
	DeInitFunc() error

	// GetName returns the name of the decoder
	GetName() string

	// SetWriter sets the netcap writer to use for the decoder
	SetWriter(io.AuditRecordWriter)

	// GetWriter returns the current writer
	GetWriter() io.AuditRecordWriter

	// GetType returns the netcap type of the decoder
	GetType() types.Type

	// GetDescription returns the description of the decoder
	GetDescription() string

	// GetChan returns a channel to receive serialized audit records from the decoder
	GetChan() <-chan []byte

	// Destroy initiates teardown
	Destroy() (string, int64)

	// NumRecords returns the number of processed audit records
	NumRecords() int64

	// FlushCurrentState writes the current state of accumulating records to disk
	// without clearing the in-memory state. This is used during live capture
	// to periodically make data visible while continuing to track state.
	// Returns the number of records flushed.
	FlushCurrentState() int64
}