/*
 * This file is part of Go Responsiveness.
 *
 * Go Responsiveness is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software Foundation,
 * either version 2 of the License, or (at your option) any later version.
 * Go Responsiveness is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with Go Responsiveness. If not, see <https://www.gnu.org/licenses/>.
 */

package lgc

import (
	"context"
	"net/http"
	"time"

	"github.com/network-quality/goresponsiveness/debug"
	"github.com/network-quality/goresponsiveness/stats"
)

type LoadGeneratingConnection interface {
	Start(context.Context, debug.DebugLevel) bool
	TransferredInInterval() (uint64, time.Duration)
	Client() *http.Client
	Status() LgcStatus
	ClientId() uint64
	Stats() *stats.TraceStats
	WaitUntilStarted(context.Context) bool
	Direction() LgcDirection
}

type LgcDirection int

const (
	LGC_DOWN LgcDirection = iota
	LGC_UP
)

func (direction LgcDirection) String() string {
	if direction == LGC_DOWN {
		return "Download"
	} else if direction == LGC_UP {
		return "Upload"
	}
	return "Invalid load-generating connection direction"
}

type LgcStatus int

const (
	LGC_STATUS_NOT_STARTED LgcStatus = iota
	LGC_STATUS_RUNNING
	LGC_STATUS_DONE
	LGC_STATUS_ERROR
)

func (status LgcStatus) String() string {
	switch status {
	case LGC_STATUS_DONE:
		return "Load-Generating Connection Done"
	case LGC_STATUS_RUNNING:
		return "Load-Generating Connection Running"
	case LGC_STATUS_ERROR:
		return "Load-Generating Connection Error"
	case LGC_STATUS_NOT_STARTED:
		return "Load-Generating Connection Not Started"
	}
	return "Load-Generating Connection in invalid state"
}