frame

package
v1.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	HeaderPrefix        = "Microbus-"
	HeaderBaggagePrefix = HeaderPrefix + "Baggage-"
	HeaderMsgId         = HeaderPrefix + "Msg-Id"
	HeaderFromHost      = HeaderPrefix + "From-Host"
	HeaderFromId        = HeaderPrefix + "From-Id"
	HeaderFromVersion   = HeaderPrefix + "From-Version"
	HeaderTimeBudget    = HeaderPrefix + "Time-Budget"
	HeaderCallDepth     = HeaderPrefix + "Call-Depth"
	HeaderOpCode        = HeaderPrefix + "Op-Code"
	HeaderQueue         = HeaderPrefix + "Queue"
	HeaderFragment      = HeaderPrefix + "Fragment"
	HeaderClockShift    = HeaderPrefix + "Clock-Shift"
	HeaderLocality      = HeaderPrefix + "Locality"
	HeaderActor         = HeaderPrefix + "Actor"

	OpCodeError    = "Err"
	OpCodeAck      = "Ack"
	OpCodeRequest  = "Req"
	OpCodeResponse = "Res"
)

Variables

This section is empty.

Functions

func CloneContext 

func CloneContext(parent context.Context) (cloned context.Context)

CloneContext returns a new context with a copy of the frame of the parent context, or a new frame if it does not have one. In either case, the returned context is guaranteed to have a frame. Manipulating the frame of the cloned context does not impact the parent's.

func ContextWithClonedFrameOf added in v1.14.0 

func ContextWithClonedFrameOf(parent context.Context, x any) (ctx context.Context)

ContextWithClonedFrameOf returns a copy of the parent context, setting on it a clone of the frame obtained from x. Manipulating the frame of the returned context does not impact the parent's.

func ContextWithFrame 

func ContextWithFrame(parent context.Context) (ctx context.Context)

ContextWithFrame returns either the parent, or a copy of the parent with a new frame. In either case, the returned context is guaranteed to have a frame.

func ContextWithFrameOf 

func ContextWithFrameOf(parent context.Context, x any) (ctx context.Context)

ContextWithFrameOf returns a copy of the parent context, setting on it the frame obtained from x. Use with caution. Manipulating the frame of the returned context also impacts the parent's.

Types

type Frame 

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

Frame is a utility class that helps with manipulating the control headers.

func Of 

func Of(x any) Frame

Of creates a new frame wrapping the headers of the HTTP request, response, response writer, header, or context.

func (Frame) Baggage 

func (f Frame) Baggage(name string) (value string)

Baggage is an arbitrary name=value pair that is passed through to downstream microservices.

func (Frame) CallDepth 

func (f Frame) CallDepth() int

CallDepth is the depth of the call stack beginning at the original request.

func (Frame) ClockShift 

func (f Frame) ClockShift() time.Duration

ClockShift returns the time offset set in the frame. Time offsets are used during testing to offset the clock of a transaction. A positive offset moves the clock into the future. A negative offset moves the clock into the past.

func (Frame) Fragment 

func (f Frame) Fragment() (index int, max int)

Fragment returns the index of the fragment of large messages out of the total number of fragments. Fragments are indexed starting at 1.

func (Frame) FromHost 

func (f Frame) FromHost() string

FromHost is the hostname of the microservice that made the request or response.

func (Frame) FromID 

func (f Frame) FromID() string

FromID is the unique ID of the instance of the microservice that made the request or response.

func (Frame) FromVersion 

func (f Frame) FromVersion() int

FromVersion is the version number of the microservice that made the request or response.

func (Frame) Get 

func (f Frame) Get(name string) string

Get returns an arbitrary header.

func (Frame) Header 

func (f Frame) Header() http.Header

Header returns the underlying HTTP header backing the frame.

func (Frame) IfActor added in v1.13.1 

func (f Frame) IfActor(boolExp string) (ok bool, err error)

IfActor evaluates the boolean expression against the properties of the actor associated with the frame. The =~ and !~ operators evaluate the left operand against a regexp. String constants, including regexp patterns, must be quoted using single quotes, double quotes or backticks.

For example, "iss=='my_issuer' && (roles.admin || roles.manager) && foo!='baz' && level>=5 && region=~'US'" evaluates to true for the actor {"iss":"my_issuer","sub":"harry@hogwarts.edu","roles":["admin"],"foo":"bar","level":5,"region":"AMER US"}.

func (Frame) IncrementClockShift added in v1.13.1 

func (f Frame) IncrementClockShift(increment time.Duration)

IncrementClockShift adds to the clock offset in the frame. A clock shift enables time-coordinated testing across microservices. A positive offset shifts the clock into the future. A negative offset shifts the clock into the past.

func (Frame) IsNil added in v1.13.1 

func (f Frame) IsNil() bool

IsNil indicates if the frame's internal header representation is nil.

func (Frame) Languages 

func (f Frame) Languages() []string

Languages parses the Accept-Language header and returns the listed languages in order of their q value.

func (Frame) Locality 

func (f Frame) Locality() string

Locality indicates the geographic locality of the microservice that handled the request. It is used by the client to optimize routing of unicast requests.

func (Frame) MessageID 

func (f Frame) MessageID() string

MessageID is the unique ID given to each HTTP message and its response.

func (Frame) OpCode 

func (f Frame) OpCode() string

OpCode indicates the type of the control message.

func (Frame) ParseActor added in v1.13.1 

func (f Frame) ParseActor(obj any) (ok bool, err error)

ParseActor parses the actor associated with the frame into the provided object. The OK flag indicates whether or not an actor is associated with the frame.

func (Frame) Queue 

func (f Frame) Queue() string

Queue indicates the queue of the subscription that handled the request. It is used by the client to optimize multicast requests.

func (Frame) Set 

func (f Frame) Set(name string, value string)

Set sets the value of an arbitrary header.

func (Frame) SetActor added in v1.13.1 

func (f Frame) SetActor(actor any) error

HeaderActor associates an actor with the frame.

func (Frame) SetBaggage 

func (f Frame) SetBaggage(name string, value string)

SetBaggage sets an arbitrary name=value pair that is passed through to downstream microservices.

func (Frame) SetCallDepth 

func (f Frame) SetCallDepth(depth int)

SetCallDepth sets the depth of the call stack beginning at the original request.

func (Frame) SetClockShift 

func (f Frame) SetClockShift(shift time.Duration)

SetClockShift sets the clock shift in the frame. A clock shift enables time-coordinated testing across microservices. A positive offset shifts the clock into the future. A negative offset shifts the clock into the past.

func (Frame) SetFragment 

func (f Frame) SetFragment(index int, max int)

Fragment sets the index of the fragment of large messages out of the total number of fragments. Fragments are indexed starting at 1.

func (Frame) SetFromHost 

func (f Frame) SetFromHost(host string)

SetFromHost sets the hostname of the microservice that is making the request or response.

func (Frame) SetFromID 

func (f Frame) SetFromID(id string)

SetFromID sets the unique ID of the instance of the microservice that is making the request or response.

func (Frame) SetFromVersion 

func (f Frame) SetFromVersion(version int)

SetFromVersion sets the version number of the microservice that is making the request or response.

func (Frame) SetLanguages 

func (f Frame) SetLanguages(language ...string)

SetLanguages sets the Accept-Language header with the list of languages.

func (Frame) SetLocality 

func (f Frame) SetLocality(locality string)

SetLocality sets the geographic locality of the microservice that handled the request. It is used by the client to optimize routing of unicast requests.

func (Frame) SetMessageID 

func (f Frame) SetMessageID(id string)

SetMessageID sets the unique ID given to each HTTP message or response.

func (Frame) SetOpCode 

func (f Frame) SetOpCode(op string)

SetOpCode sets the type of the control message.

func (Frame) SetQueue 

func (f Frame) SetQueue(queue string)

SetQueue sets the queue of the subscription that handled the request. It is used by the client to optimize multicast requests.

func (Frame) SetTimeBudget 

func (f Frame) SetTimeBudget(budget time.Duration)

SetTimeBudget budgets a duration for the request to complete. A value of 0 indicates no time budget.

func (Frame) TimeBudget 

func (f Frame) TimeBudget() time.Duration

TimeBudget is the duration budgeted for the request to complete. A value of 0 indicates no time budget.

func (Frame) XForwardedBaseURL 

func (f Frame) XForwardedBaseURL() string

XForwardedBaseURL returns the amalgamated headers X-Forwarded-Proto, -Host and -Prefix, without a trailing slash. The empty string is returned if the headers are not present.

func (Frame) XForwardedFullURL 

func (f Frame) XForwardedFullURL() string

XForwardedFullURL returns the amalgamated headers X-Forwarded-Proto, -Host, -Prefix and -Path, without a trailing slash. The empty string is returned if the headers are not present.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.