internal

package

v1.1.0 Latest Latest Go to latest Published: May 21, 2018 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bashtian/appengine

Links

Open Source Insights

Documentation ¶

Overview ¶

Package internal provides support for package appengine.

Programs should not use this package directly. Its API is not stable. Use packages appengine and appengine/* instead.

Index ¶

Variables
func AppID(c netcontext.Context) string
func BackgroundContext() netcontext.Context
func Call(ctx netcontext.Context, service, method string, in, out proto.Message) error
func ContextForTesting(req *http.Request) netcontext.Context
func Datacenter(ctx netcontext.Context) string
func DefaultTicket() string
func DefaultVersionHostname(ctx netcontext.Context) string
func FullyQualifiedAppID(ctx netcontext.Context) string
func IncomingHeaders(ctx netcontext.Context) http.Header
func InstanceID() string
func IsDevAppServer() bool
func Logf(ctx netcontext.Context, level int64, format string, args ...interface{})
func Main()
func ModuleName(_ netcontext.Context) string
func NamespaceFromContext(ctx netcontext.Context) string
func NamespacedContext(ctx netcontext.Context, namespace string) netcontext.Context
func RegisterErrorCodeMap(service string, m map[int32]string)
func RegisterTestRequest(req *http.Request, apiURL *url.URL, ...) (*http.Request, func())
func RegisterTimeoutErrorCode(service string, code int32)
func RegisterTransactionSetter(f interface{})
func ReqContext(req *http.Request) netcontext.Context
func RequestID(ctx netcontext.Context) string
func RunTransactionOnce(c netcontext.Context, f func(netcontext.Context) error, xg bool, readOnly bool, ...) (*pb.Transaction, error)
func ServerSoftware() string
func SetTestEnv() func()
func VersionID(_ netcontext.Context) string
func WithAppIDOverride(ctx netcontext.Context, appID string) netcontext.Context
func WithCallOverride(ctx netcontext.Context, f CallOverrideFunc) netcontext.Context
func WithContext(parent netcontext.Context, req *http.Request) netcontext.Context
func WithLogOverride(ctx netcontext.Context, f logOverrideFunc) netcontext.Context
type APIError
- func (e *APIError) Error() string
- func (e *APIError) IsTimeout() bool
type CallError
- func (e *CallError) Error() string
- func (e *CallError) IsTimeout() bool
type CallOverrideFunc

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrConcurrentTransaction = errors.New("internal: concurrent transaction")

View Source

var NamespaceMods = make(map[string]func(m proto.Message, namespace string))

NamespaceMods is a map from API service to a function that will mutate an RPC request to attach a namespace. The function should be prepared to be called on the same message more than once; it should only modify the RPC request the first time.

Functions ¶

func AppID ¶

func AppID(c netcontext.Context) string

func BackgroundContext ¶

func BackgroundContext() netcontext.Context

func Call ¶

func Call(ctx netcontext.Context, service, method string, in, out proto.Message) error

func ContextForTesting ¶

func ContextForTesting(req *http.Request) netcontext.Context

func Datacenter ¶

func Datacenter(ctx netcontext.Context) string

func DefaultTicket ¶ added in v1.1.0

func DefaultTicket() string

DefaultTicket returns a ticket used for background context or dev_appserver.

func DefaultVersionHostname ¶

func DefaultVersionHostname(ctx netcontext.Context) string

func FullyQualifiedAppID ¶

func FullyQualifiedAppID(ctx netcontext.Context) string

FullyQualifiedAppID returns the fully-qualified application ID. This may contain a partition prefix (e.g. "s~" for High Replication apps), or a domain prefix (e.g. "example.com:").

func IncomingHeaders ¶

func IncomingHeaders(ctx netcontext.Context) http.Header

func InstanceID ¶

func InstanceID() string

func IsDevAppServer ¶

func IsDevAppServer() bool

func Logf ¶

func Logf(ctx netcontext.Context, level int64, format string, args ...interface{})

func Main ¶

func Main()

func ModuleName ¶

func ModuleName(_ netcontext.Context) string

func NamespaceFromContext ¶

func NamespaceFromContext(ctx netcontext.Context) string

func NamespacedContext ¶

func NamespacedContext(ctx netcontext.Context, namespace string) netcontext.Context

NamespacedContext wraps a Context to support namespaces.

func RegisterErrorCodeMap ¶

func RegisterErrorCodeMap(service string, m map[int32]string)

RegisterErrorCodeMap is called from API implementations to register their error code map. This should only be called from init functions.

func RegisterTestRequest ¶

func RegisterTestRequest(req *http.Request, apiURL *url.URL, decorate func(netcontext.Context) netcontext.Context) (*http.Request, func())

RegisterTestRequest registers the HTTP request req for testing, such that any API calls are sent to the provided URL. It returns a closure to delete the registration. It should only be used by aetest package.

func RegisterTimeoutErrorCode ¶

func RegisterTimeoutErrorCode(service string, code int32)

func RegisterTransactionSetter ¶

func RegisterTransactionSetter(f interface{})

RegisterTransactionSetter registers a function that sets transaction information in a protocol buffer message. f should be a function with two arguments, the first being a protocol buffer type, and the second being *datastore.Transaction.

func ReqContext ¶ added in v1.1.0

func ReqContext(req *http.Request) netcontext.Context

func RequestID ¶

func RequestID(ctx netcontext.Context) string

func RunTransactionOnce ¶

func RunTransactionOnce(c netcontext.Context, f func(netcontext.Context) error, xg bool, readOnly bool, previousTransaction *pb.Transaction) (*pb.Transaction, error)

func ServerSoftware ¶

func ServerSoftware() string

func SetTestEnv ¶ added in v1.1.0

func SetTestEnv() func()

SetTestEnv sets the env variables for testing background ticket in Flex.

func VersionID ¶

func VersionID(_ netcontext.Context) string

func WithAppIDOverride ¶

func WithAppIDOverride(ctx netcontext.Context, appID string) netcontext.Context

func WithCallOverride ¶

func WithCallOverride(ctx netcontext.Context, f CallOverrideFunc) netcontext.Context

func WithContext ¶

func WithContext(parent netcontext.Context, req *http.Request) netcontext.Context

func WithLogOverride ¶

func WithLogOverride(ctx netcontext.Context, f logOverrideFunc) netcontext.Context

Types ¶

type APIError ¶

type APIError struct {
	Service string
	Detail  string
	Code    int32 // API-specific error code
}

APIError is the type returned by appengine.Context's Call method when an API call fails in an API-specific way. This may be, for instance, a taskqueue API call failing with TaskQueueServiceError::UNKNOWN_QUEUE.

func (*APIError) Error ¶

func (e *APIError) Error() string

func (*APIError) IsTimeout ¶

func (e *APIError) IsTimeout() bool

type CallError ¶

type CallError struct {
	Detail string
	Code   int32
	// TODO: Remove this if we get a distinguishable error code.
	Timeout bool
}

CallError is the type returned by appengine.Context's Call method when an API call fails in a generic way, such as RpcError::CAPABILITY_DISABLED.

func (*CallError) Error ¶

func (e *CallError) Error() string

func (*CallError) IsTimeout ¶

func (e *CallError) IsTimeout() bool

type CallOverrideFunc ¶

type CallOverrideFunc func(ctx netcontext.Context, service, method string, in, out proto.Message) error

Source Files ¶

View all Source files

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
aetesting Package aetesting provides utilities for testing App Engine packages.	Package aetesting provides utilities for testing App Engine packages.
app_identity Package app_identity is a generated protocol buffer package.	Package app_identity is a generated protocol buffer package.
base Package base is a generated protocol buffer package.	Package base is a generated protocol buffer package.
blobstore Package blobstore is a generated protocol buffer package.	Package blobstore is a generated protocol buffer package.
capability Package capability is a generated protocol buffer package.	Package capability is a generated protocol buffer package.
channel Package channel is a generated protocol buffer package.	Package channel is a generated protocol buffer package.
datastore Package datastore is a generated protocol buffer package.	Package datastore is a generated protocol buffer package.
image Package image is a generated protocol buffer package.	Package image is a generated protocol buffer package.
log Package log is a generated protocol buffer package.	Package log is a generated protocol buffer package.
mail Package mail is a generated protocol buffer package.	Package mail is a generated protocol buffer package.
memcache Package memcache is a generated protocol buffer package.	Package memcache is a generated protocol buffer package.
modules Package modules is a generated protocol buffer package.	Package modules is a generated protocol buffer package.
remote_api Package remote_api is a generated protocol buffer package.	Package remote_api is a generated protocol buffer package.
search Package search is a generated protocol buffer package.	Package search is a generated protocol buffer package.
socket Package socket is a generated protocol buffer package.	Package socket is a generated protocol buffer package.
system Package system is a generated protocol buffer package.	Package system is a generated protocol buffer package.
taskqueue Package taskqueue is a generated protocol buffer package.	Package taskqueue is a generated protocol buffer package.
urlfetch Package urlfetch is a generated protocol buffer package.	Package urlfetch is a generated protocol buffer package.
user Package user is a generated protocol buffer package.	Package user is a generated protocol buffer package.
xmpp Package xmpp is a generated protocol buffer package.	Package xmpp is a generated protocol buffer package.