request

Documentation

Index

• type DisbandCluster
• type Execute
• type FormCluster
• type InstallFunction
• type RollCall

Types

type DisbandCluster

type DisbandCluster struct {
	Type      string  `json:"type,omitempty"`
	From      peer.ID `json:"from,omitempty"`
	RequestID string  `json:"request_id,omitempty"`
}

DisbandCluster describes the `MessageDisbandCluster` request payload. It is sent after head node receives the leaders execution response.

type Execute

type Execute struct {
	Type       string              `json:"type,omitempty"`
	From       peer.ID             `json:"from,omitempty"`
	Code       string              `json:"code,omitempty"`
	FunctionID string              `json:"function_id,omitempty"`
	Method     string              `json:"method,omitempty"`
	Parameters []execute.Parameter `json:"parameters,omitempty"`
	Config     execute.Config      `json:"config,omitempty"`

	// RequestID may be set initially, if the execution request is relayed via roll-call.
	RequestID string `json:"request_id,omitempty"`
}

Execute describes the `MessageExecute` request payload.

type FormCluster

type FormCluster struct {
	Type      string    `json:"type,omitempty"`
	From      peer.ID   `json:"from,omitempty"`
	RequestID string    `json:"request_id,omitempty"`
	Peers     []peer.ID `json:"peers,omitempty"`
}

FormCluster describes the `MessageFormCluster` request payload. It is sent on clustered execution of a request.

type InstallFunction

type InstallFunction struct {
	Type        string  `json:"type,omitempty"`
	From        peer.ID `json:"from,omitempty"`
	ManifestURL string  `json:"manifest_url,omitempty"`
	CID         string  `json:"cid,omitempty"`
}

InstallFunction describes the `MessageInstallFunction` request payload.

type RollCall

type RollCall struct {
	From            peer.ID `json:"from,omitempty"`
	Type            string  `json:"type,omitempty"`
	Origin          peer.ID `json:"origin,omitempty"` // Origin is the peer that initiated the roll call.
	FunctionID      string  `json:"function_id,omitempty"`
	RequestID       string  `json:"request_id,omitempty"`
	ConsensusNeeded bool    `json:"consensus_needed"`
}

RollCall describes the `MessageRollCall` message payload.