common

Documentation

Index

• func HandleRequest[Res any, Req Request[Res]](ctx context.Context, handler RequestHandler[Res, Req]) func(*nats.Msg)
• func UnmarshalResponse[T any](data []byte) (T, error)
• type Cache
  • func NewCache[V any](stats *CacheStats) Cache[V]
  • func (c *Cache[V]) Load(key string, loader func() (V, error)) (V, error)
• type CacheStats
  • func (c *CacheStats) Count() uint64
  • func (c *CacheStats) Hits() uint64
  • func (c *CacheStats) RecordHit()
  • func (c *CacheStats) RecordMiss()
  • func (c *CacheStats) String() string
• type Graph
  • func (g *Graph) AddEdge(from string, to string) error
  • func (g *Graph) RemoveEdge(from string, to string)
• type Request
• type RequestHandler

Functions

func HandleRequest

func HandleRequest[Res any, Req Request[Res]](ctx context.Context, handler RequestHandler[Res, Req]) func(*nats.Msg)

HandleRequest returns a NATS subscription target that calls the provided request handler in a new goroutine if the NATS message payload can be parsed into the specified request type, and responds to the client appropriately.

func UnmarshalResponse

func UnmarshalResponse[T any](data []byte) (T, error)

UnmarshalResponse parses a response received from the job server, either into a result of the specified type, or as an error; depending on the response's structure.

Types

type Cache

type Cache[V any] struct {
	// contains filtered or unexported fields
}

func NewCache

func NewCache[V any](stats *CacheStats) Cache[V]

func (*Cache[V]) Load

func (c *Cache[V]) Load(key string, loader func() (V, error)) (V, error)

Load retrieves the value for the provided key in the cache, loading it using the provided callback function if it is not already present. If the loader returns an error, the cache slot is not marked as loaded, and the error is returned as-is.

type CacheStats

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

func (*CacheStats) Count

func (c *CacheStats) Count() uint64

Count returns the total count of cache accesses.

func (*CacheStats) Hits

func (c *CacheStats) Hits() uint64

Hits returns the count of cache accesses that resulted in a hit.

func (*CacheStats) RecordHit

func (c *CacheStats) RecordHit()

func (*CacheStats) RecordMiss

func (c *CacheStats) RecordMiss()

func (*CacheStats) String

func (c *CacheStats) String() string

type Graph

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

Graph keeps track of a directed acyclic graph.

func (*Graph) AddEdge

func (g *Graph) AddEdge(from string, to string) error

AddEdge adds a new edge to this graph. Returns an error if the new edge would introduce a cycle in the graph.

func (*Graph) RemoveEdge

func (g *Graph) RemoveEdge(from string, to string)

RemoveEdge removes an edge from this graph.

type Request

type Request[Res any] interface {
	ResponseIs(Res)
}

type RequestHandler

type RequestHandler[Res any, Req Request[Res]] func(context.Context, Req) (Res, error)

RequestHandler is a function that processes a request of a given type, and returns a response or an error to be sent back to the client.