goplugin

Documentation

Overview

Package goplugin - golang plugin in docker runner

Index

• type CallConstructorResult
• type CallMethodResult
• type GoPlugin
  • func NewGoPlugin(conf *configuration.LogicRunner, eb core.MessageBus, am core.ArtifactManager) (*GoPlugin, error)
  • func (gp *GoPlugin) CallConstructor(ctx context.Context, callContext *core.LogicCallContext, code core.RecordRef, ...) ([]byte, error)
  • func (gp *GoPlugin) CallConstructorRPC(ctx context.Context, req rpctypes.DownCallConstructorReq, ...)
  • func (gp *GoPlugin) CallMethod(ctx context.Context, callContext *core.LogicCallContext, code core.RecordRef, ...) ([]byte, core.Arguments, error)
  • func (gp *GoPlugin) CallMethodRPC(ctx context.Context, req rpctypes.DownCallMethodReq, ...)
  • func (gp *GoPlugin) CloseDownstream()
  • func (gp *GoPlugin) Downstream(ctx context.Context) (*rpc.Client, error)
  • func (gp *GoPlugin) Stop() error
• type Options
• type RunnerOptions

Types

type CallConstructorResult

type CallConstructorResult struct {
	Response rpctypes.DownCallConstructorResp
	Error    error
}

type CallMethodResult

type CallMethodResult struct {
	Response rpctypes.DownCallMethodResp
	Error    error
}

type GoPlugin

type GoPlugin struct {
	Cfg             *configuration.LogicRunner
	MessageBus      core.MessageBus
	ArtifactManager core.ArtifactManager
	// contains filtered or unexported fields
}

GoPlugin is a logic runner of code written in golang and compiled as go plugins

func NewGoPlugin

func NewGoPlugin(conf *configuration.LogicRunner, eb core.MessageBus, am core.ArtifactManager) (*GoPlugin, error)

NewGoPlugin returns a new started GoPlugin

func (*GoPlugin) CallConstructor

func (gp *GoPlugin) CallConstructor(
	ctx context.Context, callContext *core.LogicCallContext,
	code core.RecordRef, name string, args core.Arguments,
) (
	[]byte, error,
)

CallConstructor runs a constructor of a contract in controlled environment

func (*GoPlugin) CallConstructorRPC

func (gp *GoPlugin) CallConstructorRPC(ctx context.Context, req rpctypes.DownCallConstructorReq, res rpctypes.DownCallConstructorResp, resultChan chan CallConstructorResult)

func (*GoPlugin) CallMethod

func (gp *GoPlugin) CallMethod(
	ctx context.Context, callContext *core.LogicCallContext,
	code core.RecordRef, data []byte,
	method string, args core.Arguments,
) (
	[]byte, core.Arguments, error,
)

CallMethod runs a method on an object in controlled environment

func (*GoPlugin) CallMethodRPC

func (gp *GoPlugin) CallMethodRPC(ctx context.Context, req rpctypes.DownCallMethodReq, res rpctypes.DownCallMethodResp, resultChan chan CallMethodResult)

func (*GoPlugin) CloseDownstream

func (gp *GoPlugin) CloseDownstream()

func (*GoPlugin) Downstream

func (gp *GoPlugin) Downstream(ctx context.Context) (*rpc.Client, error)

Downstream returns a connection to `ginsider`

func (*GoPlugin) Stop

func (gp *GoPlugin) Stop() error

Stop stops runner(s) and RPC service

type Options

type Options struct {
	// Listen  is address `GoPlugin` listens on and provides RPC interface for runner(s)
	Listen string
}

Options of the GoPlugin

type RunnerOptions

type RunnerOptions struct {
	// Listen is address the runner listens on and provides RPC interface for the `GoPlugin`
	Listen string
	// CodeStoragePath is path to directory where the runner caches code
	CodeStoragePath string
}

RunnerOptions - set of options to control internal isolated code runner(s)