framework

type HttpClient interface {
	// The name for the HttpClient
	Name() string
	// Init will be called once, with the config it should use and the request it should use
	// It's expected to store essential field in the implementation for the future user creation
	Init(config *LgConfig, request *Request) (err error)
	// CreateUser will be called LgConfig.Connections times
	// Each User object will be used in a separate goroutine, the HttpClient should initialize goroutine specific
	// variables to the User
	CreateUser() (user User, err error)
}

type LgConfig struct {
	// RequestConfig is the configuration of the request a load generation test
	RequestConfig RequestConfig
	// The duration of the entire load generation test
	Duration time.Duration
	// The concurrency level (number of goroutines to be used)
	Connections int
	// The timeout value. Once a connection timeout occurs, that goroutine will be terminated
	Timeout time.Duration
	// the receive buffer size, should be large enough for status line and headers if `raw` is used
	RecvBufSize int
	// the verbose level for debugging
	Verbose bool
}

type Request struct {
	HttpRequest *http.Request
	RawBytes    []byte
}

type RequestConfig struct {
	// The HTTP method to be used
	Method string
	// The URL to be used, e.g http://xyz.com/abc?de=fg&hi=jklmn
	URL string
	// The headers to be used
	Headers map[string]string
	// The body to be used. nil if no body is required
	Body []byte
}

type Response struct {
	// StatusCode is the Http Status code
	// Size is the total size of the response
	StatusCode int
	Size       int
}

type Stats struct {
	// RequestsSent is the total number of requests sent
	// ResponsesRecv is the total number of responses received
	RequestsSent  int64
	ResponsesRecv int64
	// BytesSent is the total number of bytes sent
	// BytesRecv is the total number of bytes received
	BytesSent int64
	BytesRecv int64

	// MinLatency is the min latency, in microseconds (us, 1/1000ms)
	// MaxLatency is the max latency, in microseconds (us, 1/1000ms)
	Latencies  []int64
	MinLatency int64
	MaxLatency int64

	StatusErrors     int64 // error responses status  > 399
	TimeoutErrors    int64 // timeouts
	ConnectionErrors int64 // connections
	// contains filtered or unexported fields
}

type User interface {
	// DoStaticRequest is used for a request that will not change (immutable)
	// the framework will ask the User to perform the request and the result should be updated
	// in the Response object directly
	// The User should have a reference to the request, instead of creating a new one every time.
	// That's why this interface method don't pass the request object in
	DoStaticRequest(response *Response) (err error)
}