Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.0.5

Jun 27, 2023

v1.0.4

Jun 27, 2023

v1.0.3

Jun 12, 2023

v1.0.2

Feb 12, 2023

v1.0.1

Feb 4, 2023

Changes in this version

type IoBuffer

+ Read func(p []byte) (n int, err error)

+ Reset func()

+ Truncate func(n int)

v1.0.0

Jan 4, 2023

Changes in this version

+ type ABIContext interface

+ GetExports func() Exports

+ GetImports func() ImportsHandler

+ GetInstance func() WasmInstance

+ Name func() string

+ SetImports func(imports ImportsHandler)

+ SetInstance func(instance WasmInstance)

+ type Action int32

+ const ActionContinue

+ const ActionPause

+ type BufferType int32

+ const BufferTypeCallData

+ const BufferTypeDownstreamData

+ const BufferTypeGrpcReceiveBuffer

+ const BufferTypeHttpCallResponseBody

+ const BufferTypeHttpRequestBody

+ const BufferTypeHttpResponseBody

+ const BufferTypeMax

+ const BufferTypePluginConfiguration

+ const BufferTypeUpstreamData

+ const BufferTypeVmConfiguration

+ type ContextHandler interface

+ GetExports func() Exports

+ GetImports func() ImportsHandler

+ GetInstance func() WasmInstance

+ Name func() string

+ SetImports func(imports ImportsHandler)

+ SetInstance func(instance WasmInstance)

+ type ContextType int32

+ const ContextTypeHttpContext

+ const ContextTypeStreamContext

+ type Exports interface

+ ProxyOnConfigure func(rootContextID int32, pluginConfigurationSize int32) (bool, error)

+ ProxyOnContextCreate func(contextID int32, rootContextID int32) error

+ ProxyOnDelete func(contextID int32) error

+ ProxyOnDone func(contextID int32) (bool, error)

+ ProxyOnDownstreamConnectionClose func(contextID int32, peerType int32) error

+ ProxyOnDownstreamData func(contextID int32, dataSize int32, endOfStream int32) (Action, error)

+ ProxyOnGrpcClose func(contextID int32, tokenID int32, statusCode int32) error

+ ProxyOnGrpcReceive func(contextID int32, tokenID int32, responseSize int32) error

+ ProxyOnGrpcReceiveInitialMetadata func(contextID int32, tokenID int32, headerCount int32) error

+ ProxyOnGrpcReceiveTrailingMetadata func(contextID int32, tokenID int32, trailerCount int32) error

+ ProxyOnHttpCallResponse func(contextID int32, tokenID int32, headerCount int32, bodySize int32, ...) error

+ ProxyOnLog func(contextID int32) error

+ ProxyOnNewConnection func(contextID int32) (Action, error)

+ ProxyOnQueueReady func(rootContextID int32, queueID int32) error

+ ProxyOnRequestBody func(contextID int32, bodySize int32, endOfStream int32) (Action, error)

+ ProxyOnRequestHeaders func(contextID int32, headerCount int32, endOfStream int32) (Action, error)

+ ProxyOnRequestTrailers func(contextID int32, trailerCount int32) (Action, error)

+ ProxyOnResponseBody func(contextID int32, bodySize int32, endOfStream int32) (Action, error)

+ ProxyOnResponseHeaders func(contextID int32, headerCount int32, endOfStream int32) (Action, error)

+ ProxyOnResponseTrailers func(contextID int32, trailerCount int32) (Action, error)

+ ProxyOnTick func(rootContextID int32) error

+ ProxyOnUpstreamConnectionClose func(contextID int32, peerType int32) error

+ ProxyOnUpstreamData func(contextID int32, dataSize int32, endOfStream int32) (Action, error)

+ ProxyOnVmStart func(rootContextID int32, vmConfigurationSize int32) (bool, error)

+ type HeaderMap interface

+ Add func(key, value string)

+ ByteSize func() uint64

+ Clone func() HeaderMap

+ Del func(key string)

+ Get func(key string) (string, bool)

+ Range func(f func(key, value string) bool)

+ Set func(key, value string)

+ type Imports interface

+ ProxyAddHeaderMapValue func(mapType int32, keyPtr int32, keySize int32, valuePtr int32, valueSize int32) int32

+ ProxyCallForeignFunction func(funcNamePtr int32, funcNameSize int32, paramPtr int32, paramSize int32, ...) int32

+ ProxyCloseStream func(streamType int32) int32

+ ProxyContinueStream func(streamType int32) int32

+ ProxyDefineMetric func(metricType int32, namePtr int32, nameSize int32, returnMetricId int32) int32

+ ProxyDequeueSharedQueue func(tokenID int32, returnValuePtr int32, returnValueSize int32) int32

+ ProxyDone func() int32

+ ProxyEnqueueSharedQueue func(tokenID int32, dataPtr int32, dataSize int32) int32

+ ProxyGetBufferBytes func(bufferType int32, start int32, length int32, returnDataPtr int32, ...) int32

+ ProxyGetBufferStatus func(bufferType int32, lengthPtr int32, flagsPtr int32) int32

+ ProxyGetCurrentTimeNanoseconds func(resultUint64Ptr int32) int32

+ ProxyGetHeaderMapPairs func(mapType MapType, returnDataPtr int32, returnDataSize int32) int32

+ ProxyGetHeaderMapSize func(mapType int32, sizePtr int32) int32

+ ProxyGetHeaderMapValue func(mapType MapType, keyPtr int32, keySize int32, returnValuePtr int32, ...) int32

+ ProxyGetLogLevel func(logLevelPtr int32) int32

+ ProxyGetMetric func(metricId int32, resultUint64Ptr int32) int32

+ ProxyGetProperty func(keyPtr int32, keySize int32, returnValuePtr int32, returnValueSize int32) int32

+ ProxyGetSharedData func(keyPtr int32, keySize int32, returnValuePtr int32, returnValueSize int32, ...) int32

+ ProxyGetStatus func(statusCodePtr int32, returnStatusDetailPtr int32, returnStatusDetailSize int32) int32

+ ProxyGrpcCall func(grpcServiceData int32, grpcServiceSize int32, serviceNameData int32, ...) int32

+ ProxyGrpcCancel func(calloutID int32) int32

+ ProxyGrpcClose func(calloutID int32) int32

+ ProxyGrpcSend func(streamID int32, messagePtr int32, messageSize int32, endOfStream int32) int32

+ ProxyGrpcStream func(grpcServiceData int32, grpcServiceSize int32, serviceNameData int32, ...) int32

+ ProxyHttpCall func(uriPtr int32, uriSize int32, headerPairsPtr int32, headerPairsSize int32, ...) int32

+ ProxyIncrementMetric func(metricId int32, offset int64) int32

+ ProxyLog func(logLevel int32, messagePtr int32, messageSize int32) int32

+ ProxyRecordMetric func(metricId int32, value int64) int32

+ ProxyRegisterSharedQueue func(queueNamePtr int32, queueNameSize int32, tokenIDPtr int32) int32

+ ProxyRemoveHeaderMapValue func(mapType int32, keyPtr int32, keySize int32) int32

+ ProxyReplaceHeaderMapValue func(mapType int32, keyPtr int32, keySize int32, valuePtr int32, valueSize int32) int32

+ ProxyResolveSharedQueue func(vmIDPtr int32, vmIDSize int32, queueNamePtr int32, queueNameSize int32, ...) int32

+ ProxySendLocalResponse func(statusCode int32, statusCodeDetailsPtr int32, statusCodeDetailsSize int32, ...) int32

+ ProxySetBufferBytes func(bufferType int32, start int32, length int32, dataPtr int32, dataSize int32) int32

+ ProxySetEffectiveContext func(contextID int32) int32

+ ProxySetHeaderMapPairs func(mapType MapType, dataPtr int32, dataSize int32) int32

+ ProxySetProperty func(keyPtr int32, keySize int32, valuePtr int32, valueSize int32) int32

+ ProxySetSharedData func(keyPtr int32, keySize int32, valuePtr int32, valueSize int32, cas int32) int32

+ ProxySetTickPeriodMilliseconds func(tickPeriodMillisecondsPtr int32) int32

+ type ImportsHandler interface

+ CallForeignFunction func(funcName string, param []byte) ([]byte, WasmResult)

+ CancelGrpcCall func(token int32) WasmResult

+ CloseDownstream func() WasmResult

+ CloseGrpcCall func(token int32) WasmResult

+ CloseHttpRequest func() WasmResult

+ CloseHttpResponse func() WasmResult

+ CloseUpstream func() WasmResult

+ DefineMetric func(metricType MetricType, name string) (int32, WasmResult)

+ DequeueSharedQueue func(queueID uint32) (string, WasmResult)

+ Done func() WasmResult

+ EnqueueSharedQueue func(queueID uint32, data string) WasmResult

+ GetCurrentTimeNanoseconds func() (int32, WasmResult)

+ GetDownStreamData func() IoBuffer

+ GetFuncCallData func() IoBuffer

+ GetGrpcReceiveBuffer func() IoBuffer

+ GetGrpcReceiveInitialMetaData func() HeaderMap

+ GetGrpcReceiveTrailerMetaData func() HeaderMap

+ GetHttpCallResponseBody func() IoBuffer

+ GetHttpCallResponseHeaders func() HeaderMap

+ GetHttpCallResponseTrailer func() HeaderMap

+ GetHttpRequestBody func() IoBuffer

+ GetHttpRequestHeader func() HeaderMap

+ GetHttpRequestTrailer func() HeaderMap

+ GetHttpResponseBody func() IoBuffer

+ GetHttpResponseHeader func() HeaderMap

+ GetHttpResponseTrailer func() HeaderMap

+ GetLogLevel func() LogLevel

+ GetMetric func(metricID int32) (int64, WasmResult)

+ GetPluginConfig func() IoBuffer

+ GetProperty func(key string) (string, WasmResult)

+ GetRootContextID func() int32

+ GetSharedData func(key string) (string, uint32, WasmResult)

+ GetStatus func() (int32, string, WasmResult)

+ GetUpstreamData func() IoBuffer

+ GetVmConfig func() IoBuffer

+ GrpcCall func(grpcService string, serviceName string, method string, data IoBuffer, ...) (int32, WasmResult)

+ HttpCall func(url string, headers HeaderMap, body IoBuffer, trailer HeaderMap, ...) (int32, WasmResult)

+ IncrementMetric func(metricID int32, offset int64) WasmResult

+ Log func(level LogLevel, msg string) WasmResult

+ OpenGrpcStream func(grpcService string, serviceName string, method string) (int32, WasmResult)

+ RecordMetric func(metricID int32, value int64) WasmResult

+ RegisterSharedQueue func(queueName string) (uint32, WasmResult)

+ ResolveSharedQueue func(queueName string) (uint32, WasmResult)

+ ResumeDownstream func() WasmResult

+ ResumeHttpRequest func() WasmResult

+ ResumeHttpResponse func() WasmResult

+ ResumeUpstream func() WasmResult

+ SendGrpcCallMsg func(token int32, data IoBuffer, endOfStream int32) WasmResult

+ SendHttpResp func(respCode int32, respCodeDetail IoBuffer, respBody IoBuffer, ...) WasmResult

+ SetEffectiveContextID func(contextID int32) WasmResult

+ SetProperty func(key string, value string) WasmResult

+ SetSharedData func(key string, value string, cas uint32) WasmResult

+ SetTickPeriodMilliseconds func(tickPeriodMilliseconds int32) WasmResult

+ Wait func() Action

+ type IoBuffer interface

+ Bytes func() []byte

+ Drain func(offset int)

+ Len func() int

+ Write func(p []byte) (n int, err error)

+ type KVStore interface

+ DelCAS func(key string, cas bool) bool

+ SetCAS func(key, value string, cas bool) bool

+ type LogLevel int32

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelTrace

+ const LogLevelWarning

+ type MapType = int32

+ const MapTypeGrpcReceiveInitialMetadata

+ const MapTypeGrpcReceiveTrailingMetadata

+ const MapTypeHttpCallResponseHeaders

+ const MapTypeHttpCallResponseTrailers

+ const MapTypeHttpRequestHeaders

+ const MapTypeHttpRequestTrailers

+ const MapTypeHttpResponseHeaders

+ const MapTypeHttpResponseTrailers

+ const MapTypeMax

+ type MetricType int32

+ const MetricTypeCounter

+ const MetricTypeGauge

+ const MetricTypeHistogram

+ const MetricTypeMax

+ type PeerType int32

+ const PeerTypeLocal

+ const PeerTypeRemote

+ const PeerTypeUnknown

+ type Result int32

+ const ResultBadArgument

+ const ResultCompareAndSwapMismatch

+ const ResultEmpty

+ const ResultInvalidMemoryAccess

+ const ResultInvalidOperation

+ const ResultNotAllowed

+ const ResultNotFound

+ const ResultOk

+ const ResultUnimplemented

+ type StreamType int32

+ const StreamTypeDownstream

+ const StreamTypeHttpRequest

+ const StreamTypeHttpResponse

+ const StreamTypeUpstream

+ type WasmFunction interface

+ Call func(args ...interface{}) (interface{}, error)

+ type WasmInstance interface

+ Acquire func() bool

+ GetByte func(addr uint64) (byte, error)

+ GetData func() interface{}

+ GetExportsFunc func(funcName string) (WasmFunction, error)

+ GetExportsMem func(memName string) ([]byte, error)

+ GetMemory func(addr uint64, size uint64) ([]byte, error)

+ GetModule func() WasmModule

+ GetUint32 func(addr uint64) (uint32, error)

+ HandleError func(err error)

+ Lock func(data interface{})

+ Malloc func(size int32) (uint64, error)

+ PutByte func(addr uint64, b byte) error

+ PutMemory func(addr uint64, size uint64, content []byte) error

+ PutUint32 func(addr uint64, value uint32) error

+ Release func()

+ SetData func(data interface{})

+ Start func() error

+ Stop func()

+ Unlock func()

+ type WasmModule interface

+ GetABINameList func() []string

+ Init func()

+ NewInstance func() (WasmInstance, error)

+ type WasmResult int32

+ const WasmResultBadArgument

+ const WasmResultBadExpression

+ const WasmResultBrokenConnection

+ const WasmResultCasMismatch

+ const WasmResultEmpty

+ const WasmResultInternalFailure

+ const WasmResultInvalidMemoryAccess

+ const WasmResultNotFound

+ const WasmResultOk

+ const WasmResultParseFailure

+ const WasmResultResultMismatch

+ const WasmResultSerializationFailure

+ const WasmResultUnimplemented

+ func (wasmResult WasmResult) Int32() int32

+ type WasmVM interface

+ Close func() error

+ Init func()

+ Name func() string

+ NewModule func(guest []byte) (WasmModule, error)