cron

Documentation

Index

• type Actor
  • func (a Actor) Code() cid.Cid
  • func (a Actor) Constructor(rt runtime.Runtime, params *ConstructorParams) *abi.EmptyValue
  • func (a Actor) EpochTick(rt runtime.Runtime, _ *abi.EmptyValue) *abi.EmptyValue
  • func (a Actor) Exports() []interface{}
  • func (a Actor) IsSingleton() bool
  • func (a Actor) State() cbor.Er
• type ConstructorParams
• type Entry
  • func BuiltInEntries() []Entry
  • func (t *Entry) MarshalCBOR(w io.Writer) error
  • func (t *Entry) UnmarshalCBOR(r io.Reader) error
• type EntryParam
• type State
  • func ConstructState(entries []Entry) *State
  • func (t *State) MarshalCBOR(w io.Writer) error
  • func (t *State) UnmarshalCBOR(r io.Reader) error
• type StateSummary
  • func CheckStateInvariants(st *State, store adt.Store) (*StateSummary, *builtin.MessageAccumulator)

Types

type Actor

type Actor struct{}

The cron actor is a built-in singleton that sends messages to other registered actors at the end of each epoch.

func (Actor) Code

func (a Actor) Code() cid.Cid

func (Actor) Constructor

func (a Actor) Constructor(rt runtime.Runtime, params *ConstructorParams) *abi.EmptyValue

func (Actor) EpochTick

func (a Actor) EpochTick(rt runtime.Runtime, _ *abi.EmptyValue) *abi.EmptyValue

Invoked by the system after all other messages in the epoch have been processed.

func (Actor) Exports

func (a Actor) Exports() []interface{}

func (Actor) IsSingleton

func (a Actor) IsSingleton() bool

func (Actor) State

func (a Actor) State() cbor.Er

type ConstructorParams

type ConstructorParams = cron0.ConstructorParams

type ConstructorParams struct {
	Entries []Entry
}

type Entry

type Entry struct {
	Receiver  addr.Address  // The actor to call (must be an ID-address)
	MethodNum abi.MethodNum // The method number to call (must accept empty parameters)
}

func BuiltInEntries

func BuiltInEntries() []Entry

The default entries to install in the cron actor's state at genesis.

func (*Entry) MarshalCBOR

func (t *Entry) MarshalCBOR(w io.Writer) error

func (*Entry) UnmarshalCBOR

func (t *Entry) UnmarshalCBOR(r io.Reader) error

type EntryParam

type EntryParam = cron0.Entry

type State

type State struct {
	Entries []Entry
}

func ConstructState

func ConstructState(entries []Entry) *State

func (*State) MarshalCBOR

func (t *State) MarshalCBOR(w io.Writer) error

func (*State) UnmarshalCBOR

func (t *State) UnmarshalCBOR(r io.Reader) error

type StateSummary

type StateSummary struct {
	EntryCount int
}

func CheckStateInvariants

func CheckStateInvariants(st *State, store adt.Store) (*StateSummary, *builtin.MessageAccumulator)

Checks internal invariants of cron state.