tracing

type BufferedTrace struct {

	// Only trace events whose SampledVal is is a multiple of Sampling.
	// (E.g., client sequence number for request events, sequence number for protocol events is meant to be stored there)
	Sampling int

	BufferCapacity        int
	ProtocolEventCapacity int
	RequestEventCapacity  int
	EthereumEventCapacity int
	// contains filtered or unexported fields
}

type DirectTrace struct {

	// Only trace events whose sequence number (clSn for request events, seqNr for protocol events)
	// is is a multiple of Sampling.
	Sampling int
	// contains filtered or unexported fields
}

type EventType int

type GenericEvent struct {
	EventType  EventType
	Timestamp  int64
	NodeId     int32
	SampledVal int64
	Val0       int64
}

type Trace interface {
	// Starts the tracing of this Trace.
	// No call to Event(), Protocol() or Request() must be made before Start() returned.
	// If Start() has been called, then Stop() must be called as well
	// to perform the necessary cleanup before the process finishes.
	Start(outFileName string, nodeID int32)

	// Create a new trace event
	// sampledVal and val0 are integers whose interpretation depends on the event type.
	// However, sampledVal is also used for sampling
	Event(e EventType, sampledVal int64, val0 int64)

	// Stops the tracing and performs the necessary cleanup (e.g. closes the output file).
	// Stop() must be called in order to obtain meaningful output.
	Stop()

	// Sets up a signal handler that calls Stop() when the specified OS signal occurs.
	// This is useful for tracing if the program does not terminate gracefully, but is stopped using an OS signal.
	// StopOnSignal() can be used in this case to still stop the tracer (flushing buffer contents).
	// If the exit flag is set to true, the signal handler will exit the process after stopping the tracer.
	StopOnSignal(sig os.Signal, exit bool)
}