service

Documentation

Index

• Constants
• type Client
  • func NewClient() Client
  • func (clt *Client) StartServer()
  • func (c *Client) StartWorker()
• type ConversionJob
• type Version
  • func GetVersion() Version
  • func (v *Version) Str() string

Constants

const (

	// MinWorkerConcurrency is the minimum number of concurrent jobs the worker
	// should process
	MinWorkerConcurrency = 1

	// MaxWorkerConcurrency is the maximum number of concurrent jobs the worker
	// should process
	MaxWorkerConcurrency = 10

	// MinWorkerMaxRetries is minimum number that can be set for the worker's
	// maximum-retries
	MinWorkerMaxRetries = 0
)

const (
	// MinRequestTTL in the minimum TTL that we should allow to be set on requests
	MinRequestTTL = 300
)

Types

type Client

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

Client is the application client

func NewClient

func NewClient() Client

NewClient creates an initialized application client

func (*Client) StartServer

func (clt *Client) StartServer()

StartServer starts the application web server

func (*Client) StartWorker

func (c *Client) StartWorker()

StartWorker starts the application background worker

type ConversionJob

type ConversionJob struct {
	Identifier    string `redis:"uuid"`
	CreatedAt     string `redis:"created_at"`
	StartedAt     string `redis:"started_at"`
	EndedAt       string `redis:"ended_at"`
	ExpiresIn     int    `redis:"expires_in"`
	Status        string `redis:"status"`
	Logs          []byte `redis:"logs"`
	StorageBucket string `redis:"storage_bucket"`
	StorageKey    string `redis:"storage_key"`
	RequestType   string `redis:"request_type"`
	RequestData   []byte `redis:"request_data"`
}

ConversionJob is a mapping of a conversion job's attributes

type Version

type Version struct {
	Major  string
	Minor  string
	Patch  string
	Commit string
}

Version represents version information.

func GetVersion

func GetVersion() Version

GetVersion returns version information.

func (*Version) Str

func (v *Version) Str() string

Str returns version information as a string