Protocol::HTTPSourceProtocolHTTPHeaderPriority

class Priority

Represents the priority header, used to indicate the relative importance of an HTTP request.

The priority header allows clients to express their preference for how resources should be prioritized by the server. It supports directives like u= to specify the urgency level of a request, and i to indicate whether a response can be delivered incrementally. The urgency levels range from 0 (highest priority) to 7 (lowest priority), while the i directive is a boolean flag.

Definitions

def initialize(value = nil)

Initialize the priority header with the given value.

Signature

parameter value String | Nil

the value of the priority header, if any. The value should be a comma-separated string of directives.

Implementation

def initialize(value = nil)
	super(value&.downcase)
end

def << value

Add a value to the priority header.

Signature

parameter value String

the directive to add to the header.

Implementation

def << value
	super(value.downcase)
end

DEFAULT_URGENCY = 3

The default urgency level if not specified.

def urgency(default = DEFAULT_URGENCY)

The urgency level, if specified using u=. 0 is the highest priority, and 7 is the lowest.

Note that when duplicate Dictionary keys are encountered, all but the last instance are ignored.

Signature

returns Integer | Nil

the urgency level if specified, or nil if not present.

Implementation

def urgency(default = DEFAULT_URGENCY)
	if value = self.reverse_find{|value| value.start_with?("u=")}
		_, level = value.split("=", 2)
		return Integer(level)
	end
	
	return default
end

def incremental?

Checks if the response should be delivered incrementally.

The i directive, when present, indicates that the response can be delivered incrementally as data becomes available.

Signature

returns Boolean

whether the request should be delivered incrementally.

Implementation

def incremental?
	self.include?("i")
end