vm

Documentation

Index

• func MarshalRecordValue(r RecordValue) ([]byte, error)
• type Machine
  • func NewVM(ctx context.Context, h host.Host, updateCtx ir.UpdateContext, ...) (Machine, error)
• type RecordValue
  • func UnmarshalRecordValue(b []byte) (RecordValue, error)
• type VMOption
  • func GCPeriod(p time.Duration) VMOption

Functions

func MarshalRecordValue

func MarshalRecordValue(r RecordValue) ([]byte, error)

MarshalRecordValue serializes RecordValue to send it through libp2p protocol.

Types

type Machine

type Machine interface {
	Update(writer peer.ID, k string, update xr.Dict, metadata ...meta.Metadata) error // Updates the dictionary in the writer's private space.
	Get(k string) RecordValue                                                         // Get the full Record in a key
	// NOTE: No query operation will be supported until we figure out selectors
	// Query(key string, selector Selector) (RecordValue, error)
	Close() error
}

Machine captures the public interface of a smart record virtual machine.

func NewVM

func NewVM(ctx context.Context, h host.Host, updateCtx ir.UpdateContext, asm ir.AssemblerContext, options ...VMOption) (Machine, error)

NewVM creates a new smart record Machine

type RecordValue

type RecordValue map[peer.ID]*xr.Dict

RecordValue determines the structure used by the VM to interact with the outside world, outputing disassembled syntactic dicts.

func UnmarshalRecordValue

func UnmarshalRecordValue(b []byte) (RecordValue, error)

UnmarshalRecordValue unmarshals a serialized representation of RecordValue

type VMOption

type VMOption func(*vmConfig) error

Option type

func GCPeriod

func GCPeriod(p time.Duration) VMOption

GCPeriod garbage collection period for VM