headers

Documentation

Index

• Constants
• func AddCaller(header http.Header, ref *schema.Ref)
• func GetCaller(header http.Header) (optional.Option[*schema.Ref], error)
• func GetCallers(header http.Header) ([]*schema.Ref, error)
• func GetParentRequestKey(header http.Header) (model.RequestKey, bool, error)
• func GetRequestKey(header http.Header) (model.RequestKey, bool, error)
• func IsDirectRouted(header http.Header) bool
• func SetCallers(header http.Header, refs []*schema.Ref)
• func SetDirectRouted(header http.Header)
• func SetParentRequestKey(header http.Header, key model.RequestKey)
• func SetRequestKey(header http.Header, key model.RequestKey)

Constants

const (
	DirectRoutingHeader = "Ftl-Direct"
	// VerbHeader is the header used to pass the module.verb of the current request.
	//
	// One header will be present for each hop in the request path.
	VerbHeader = "Ftl-Verb"
	// RequestIDHeader is the header used to pass the inbound request ID.
	RequestIDHeader = "Ftl-Request-Id"
	// ParentRequestIDHeader is the header used to pass the parent request ID,
	// i.e. the publisher that initiated this call.
	ParentRequestIDHeader = "Ftl-Parent-Request-Id"
)

Headers used by the internal RPC system.

Functions

func AddCaller

func AddCaller(header http.Header, ref *schema.Ref)

AddCaller to an outgoing request.

func GetCaller

func GetCaller(header http.Header) (optional.Option[*schema.Ref], error)

GetCaller returns the module.verb of the caller, if any.

Will return an error if the header is malformed.

func GetCallers

func GetCallers(header http.Header) ([]*schema.Ref, error)

GetCallers history from an incoming request.

func GetParentRequestKey

func GetParentRequestKey(header http.Header) (model.RequestKey, bool, error)

func GetRequestKey

func GetRequestKey(header http.Header) (model.RequestKey, bool, error)

GetRequestKey from an incoming request.

Will return ("", false, nil) if no request key is present.

func IsDirectRouted

func IsDirectRouted(header http.Header) bool

func SetCallers

func SetCallers(header http.Header, refs []*schema.Ref)

func SetDirectRouted

func SetDirectRouted(header http.Header)

func SetParentRequestKey

func SetParentRequestKey(header http.Header, key model.RequestKey)

func SetRequestKey

func SetRequestKey(header http.Header, key model.RequestKey)