ttss

Documentation

Index

• Constants
• Variables
• func GetAllStops(e []Endpointer) (chan []pb.Stop, chan error)
• func GetDepartures(e []Endpointer, shortName uint) (chan []pb.Departure, chan error)
• func GetDeparturesErrorCode(e Endpointer, id uint) (errorCode int)
• type Endpoint
  • func (e Endpoint) GetAllStops() ([]pb.Stop, error)
  • func (e Endpoint) GetDepartures(id uint) ([]pb.Departure, error)
  • func (e Endpoint) Id() string
• type Endpointer
• type ErrRequestFailed
  • func (e ErrRequestFailed) Error() string
• type ErrStatusCode
  • func (e ErrStatusCode) Error() string
• type ErrStopNotFound
  • func (e ErrStopNotFound) Error() string

Constants

const (
	OK               = iota
	OTHER_ERROR      // Please check logs for detailed error
	REQUEST_FAILED   // Request failed
	REQUEST_NON_200  // Request returned non 200 status code
	EMPTY_DEPARTURES // No departures received (with 200 status code)
	STOP_NOT_FOUND   // Stop was not found
)

Errors below are sorted by severity - we care the most on the request that succeded, but returned no departures

Variables

var (
	BusEndpoint = Endpoint{
		URL:  "http://91.223.13.70",
		Type: pb.Endpoint_BUS,
	}
	TramEndpoint = Endpoint{
		URL:  "http://185.70.182.51",
		Type: pb.Endpoint_TRAM,
	}

	KrkStopsEndpoints = []Endpointer{
		BusEndpoint,
		TramEndpoint,
	}
)

Functions

func GetAllStops

func GetAllStops(e []Endpointer) (chan []pb.Stop, chan error)

GetAllStops returns stops from multiple endpoints. When one endpoint fails, valid stops are returned and error is send via chan. When request is finished, error channel is closed.

func GetDepartures

func GetDepartures(e []Endpointer, shortName uint) (chan []pb.Departure, chan error)

GetDepartures for range of endpoints. When one endpoint fails, valid departures are returned and error is send via chan. When request is finished, error channel is closed.

func GetDeparturesErrorCode

func GetDeparturesErrorCode(e Endpointer, id uint) (errorCode int)

GetDeparturesErrorCode returns error that can be consumed by e.g. Prometheus.

Types

type Endpoint

type Endpoint struct {
	URL  string
	Type pb.Endpoint
}

func (Endpoint) GetAllStops

func (e Endpoint) GetAllStops() ([]pb.Stop, error)

GetAllStops fetches Stops from given endpoint.

func (Endpoint) GetDepartures

func (e Endpoint) GetDepartures(id uint) ([]pb.Departure, error)

GetDepartures from Endpoint for stop with given shortName.

func (Endpoint) Id

func (e Endpoint) Id() string

type Endpointer

type Endpointer interface {
	GetDepartures(uint) ([]pb.Departure, error)
	GetAllStops() ([]pb.Stop, error)
	Id() string
}

type ErrRequestFailed

type ErrRequestFailed struct {
	// contains filtered or unexported fields
}

func (ErrRequestFailed) Error

func (e ErrRequestFailed) Error() string

type ErrStatusCode

type ErrStatusCode struct {
	// contains filtered or unexported fields
}

func (ErrStatusCode) Error

func (e ErrStatusCode) Error() string

type ErrStopNotFound

type ErrStopNotFound struct {
}

func (ErrStopNotFound) Error

func (e ErrStopNotFound) Error() string