Struct Decoder

decoder/packet/packet_decoder.go:66–97

Decoder implements custom logic to decode data from a gopacket.Packet this structure has an optimized field order to avoid excessive padding.

	// Decoder implements custom logic to decode data from a gopacket.Packet
	// this structure has an optimized field order to avoid excessive padding.
	Decoder struct {

		// used to keep track of the number of generated audit records
		NumRecordsWritten int64

		// Name of the decoder
		Name string

		// Description of the decoder
		Description string

		// Icon name for the decoder (for Maltego)
		Icon string

		// Handler to process packets
		Handler packetDecoderHandler

		// init functions
		PostInit func(*Decoder) error
		DeInit   func(*Decoder) error

		// FlushState is called during live capture to write current state without clearing it.
		// This allows accumulating decoders (DeviceProfile, IPProfile, Connection) to periodically
		// make their data visible while continuing to track state.
		FlushState func(*Decoder) int64

		// Writer for audit records
		Writer io.AuditRecordWriter

		// Type of the audit records produced by this decoder
		Type types.Type
	}

	// DecoderAPI PacketDecoderAPI describes an interface that all custom decoders need to implement
	// this allows to supply a custom structure and maintain state for advanced protocol analysis.