envelope

type Envelope struct {
	// contains filtered or unexported fields
}

type EnvelopeHandler interface {
	// StartComponent starts the given component.
	StartComponent(entry *protos.ComponentToStart) error

	// StartColocationGroup starts the given colocation group.
	StartColocationGroup(entry *protos.ColocationGroup) error

	// RegisterReplica registers the given weavelet replica.
	RegisterReplica(entry *protos.ReplicaToRegister) error

	// ReportLoad reports the given weavelet load information.
	ReportLoad(entry *protos.WeaveletLoadReport) error

	// ExportListener exports the given listener, returning the export
	// information (e.g,. any port assigned).
	ExportListener(request *protos.ListenerToExport) (*protos.ExportListenerReply, error)

	// GetRoutingInfo returns the latest routing information for the weavelet.
	//
	// This is a blocking method that can be processed out-of-order w.r.t.
	// the other methods.
	GetRoutingInfo(request *protos.GetRoutingInfo) (*protos.RoutingInfo, error)

	// GetComponentsToStart is a blocking call that returns the latest set of
	// components that should be started by the weavelet.
	//
	// This is a blocking method that can be processed out-of-order w.r.t.
	// the other methods.
	GetComponentsToStart(request *protos.GetComponentsToStart) (*protos.ComponentsToStart, error)

	// RecvLogEntry enables the envelope to receive a log entry.
	RecvLogEntry(entry *protos.LogEntry)

	// RecvTraceSpans enables the envelope to receive a sequence of trace spans.
	RecvTraceSpans(spans []trace.ReadOnlySpan) error
}

type Options struct {
	// Restart dictates when a weavelet is restarted. Defaults to Never.
	Restart RestartPolicy

	// Retry configures the exponential backoff performed when restarting the
	// weavelet. Defaults to retry.DefaultOptions.
	Retry retry.Options

	// GetEnvelopeConn returns a connection between a pre-started weavelet and
	// its Envelope.
	//
	// Note that setting this option implies that the weavelet has already been
	// started, in which case the Envelope will not restart it (i.e., the
	// Restart policy is assumed to be Never).
	//
	// TODO: conn.EnvelopeConn is internal. This is only used right now for
	// weavertest. If we remove the weavertest use case, we can remove this
	// option.
	//
	// TODO: Set this only in weavertest.
	GetEnvelopeConn func() *conn.EnvelopeConn
}

type RestartPolicy int