candishared

Documentation

Index

• func GetValueFromContext(ctx context.Context, key ContextKey) interface{}
• func HTTPMemstatsHandler(w http.ResponseWriter, r *http.Request)
• func HTTPRoot(serviceName, buildNumber string) http.HandlerFunc
• func ParseWorkerKeyFromContext(ctx context.Context) []byte
• func SetToContext(ctx context.Context, key ContextKey, value interface{}) context.Context
• type ContextKey
• type ErrorRetrier
  • func (e *ErrorRetrier) Error() string
• type Filter
  • func (f *Filter) CalculateOffset() int
• type GraphQLErrorResolver
  • func NewGraphQLErrorResolver(errMesage string, extensions map[string]interface{}) GraphQLErrorResolver
• type Meta
  • func NewMeta(page, limit, totalRecords int) (m Meta)
  • func (m *Meta) CalculatePages()
• type PublisherArgument
• type Queue
  • func NewQueue() *Queue
  • func (q *Queue) Len() int
  • func (q *Queue) Peek() (interface{}, error)
  • func (q *Queue) Pop() (interface{}, error)
  • func (q *Queue) Push(elem interface{})
• type Result
• type SliceResult
• type TokenClaim
  • func ParseTokenClaimFromContext(ctx context.Context) *TokenClaim

Functions

func GetValueFromContext

func GetValueFromContext(ctx context.Context, key ContextKey) interface{}

GetValueFromContext will get context with specific key

func HTTPMemstatsHandler

func HTTPMemstatsHandler(w http.ResponseWriter, r *http.Request)

HTTPMemstatsHandler calculate runtime statistic

func HTTPRoot

func HTTPRoot(serviceName, buildNumber string) http.HandlerFunc

HTTPRoot http handler

func ParseWorkerKeyFromContext

func ParseWorkerKeyFromContext(ctx context.Context) []byte

ParseWorkerKeyFromContext parse token claim from given context

func SetToContext

func SetToContext(ctx context.Context, key ContextKey, value interface{}) context.Context

SetToContext will set context with specific key

Types

type ContextKey

type ContextKey string

ContextKey represent Key of all context

const (
	// ContextKeyHTTPHeader context key
	ContextKeyHTTPHeader ContextKey = "httpHeader"

	// ContextKeyTaskQueueRetry context key
	ContextKeyTaskQueueRetry ContextKey = "taskQueueRetry"

	// ContextKeyTokenClaim context key
	ContextKeyTokenClaim ContextKey = "tokenClaim"

	// ContextKeyWorkerKey context key
	ContextKeyWorkerKey ContextKey = "workerKey"
)

type ErrorRetrier

type ErrorRetrier struct {
	Delay   time.Duration
	Retry   int
	Message string
}

ErrorRetrier task queue worker for retry error with retry count and delay between retry

func (*ErrorRetrier) Error

func (e *ErrorRetrier) Error() string

Error implement error

type Filter

type Filter struct {
	Limit   int    `json:"limit" default:"10"`
	Page    int    `json:"page" default:"1"`
	Offset  int    `json:"-"`
	Search  string `json:"search,omitempty"`
	OrderBy string `json:"orderBy,omitempty"`
	Sort    string `json:"sort,omitempty" default:"desc" lower:"true"`
	ShowAll bool   `json:"showAll"`
}

Filter data

func (*Filter) CalculateOffset

func (f *Filter) CalculateOffset() int

CalculateOffset method

type GraphQLErrorResolver

type GraphQLErrorResolver interface {
	Error() string
	Extensions() map[string]interface{}
}

GraphQLErrorResolver graphql error with extensions

func NewGraphQLErrorResolver

func NewGraphQLErrorResolver(errMesage string, extensions map[string]interface{}) GraphQLErrorResolver

NewGraphQLErrorResolver constructor

type Meta

type Meta struct {
	Page         int `json:"page"`
	Limit        int `json:"limit"`
	TotalRecords int `json:"totalRecords"`
	TotalPages   int `json:"totalPages"`
}

Meta model

func NewMeta

func NewMeta(page, limit, totalRecords int) (m Meta)

NewMeta create new meta for slice data

func (*Meta) CalculatePages

func (m *Meta) CalculatePages()

CalculatePages meta method

type PublisherArgument

type PublisherArgument struct {
	// Topic or queue name
	Topic       string
	Key         string
	Header      map[string]interface{}
	ContentType string
	Data        interface{}
}

PublisherArgument declare publisher argument

type Queue

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

Queue represents a single instance of the queue data structure.

func NewQueue

func NewQueue() *Queue

NewQueue constructs and returns a new Queue.

func (*Queue) Len

func (q *Queue) Len() int

Len returns the number of elements currently stored in the queue.

func (*Queue) Peek

func (q *Queue) Peek() (interface{}, error)

Peek returns the element at the head of the queue. This call panics if the queue is empty.

func (*Queue) Pop

func (q *Queue) Pop() (interface{}, error)

Pop Pops and returns the element from the front of the queue. If the queue is empty, the call will panic.

func (*Queue) Push

func (q *Queue) Push(elem interface{})

Push puts an element on the end of the queue.

type Result

type Result struct {
	Data  interface{}
	Error error
}

Result common output

type SliceResult

type SliceResult struct {
	Data  interface{}
	Meta  Meta
	Error error
}

SliceResult include meta

type TokenClaim

type TokenClaim struct {
	jwt.StandardClaims
	Role       string
	Additional interface{}
}

TokenClaim for token claim data

func ParseTokenClaimFromContext

func ParseTokenClaimFromContext(ctx context.Context) *TokenClaim

ParseTokenClaimFromContext parse token claim from given context