gaememcache

Documentation

Overview

Package gaememcache provides very minimal memcache-like functionality based on the legacy GAE memcache service.

Using this module while running on GAE will install GAE memcache as the global cache provider as used by go.chromium.org/luci/server/caching library. This allows using GAE memcache as the cache implementation for various parts of the LUCI server (primary for caching various tokens and results of token checks).

Requires `app_engine_apis: true` to be specified in the app.yaml.

This package is not a full replacement for GAE memcache API, nor it is compatible with GAE memcache data stored through other libraries (it intentionally namespaces all keys it is using).

Index

• Variables
• func NewModule(opts *ModuleOptions) module.Module
• func NewModuleFromFlags() module.Module
• type ModuleOptions
  • func (o *ModuleOptions) Register(f *flag.FlagSet)

Variables

var ModuleName = module.RegisterName("go.chromium.org/luci/server/gaememcache")

ModuleName can be used to refer to this module when declaring dependencies.

Functions

func NewModule

func NewModule(opts *ModuleOptions) module.Module

NewModule returns a server module that installs GAE memcache as the default global cache as used by go.chromium.org/luci/server/caching library.

func NewModuleFromFlags

func NewModuleFromFlags() module.Module

NewModuleFromFlags is a variant of NewModule that initializes options through command line flags.

Calling this function registers flags in flag.CommandLine. They are usually parsed in server.Main(...).

Types

type ModuleOptions

type ModuleOptions struct {
}

ModuleOptions contain configuration of the gaememcache server module.

func (*ModuleOptions) Register

func (o *ModuleOptions) Register(f *flag.FlagSet)

Register registers the command line flags.