A builder-style API for configuring a transactional cache lookup. More...

#include <core.h>

Public Member Functions
TransactionLookupBuilder	header_values (std::string_view name, std::span< const http::HeaderValue > values) &&
TransactionLookupBuilder	header (std::string_view name, const http::HeaderValue &value) &&
TransactionLookupBuilder	on_behalf_of (std::string service) &&
TransactionLookupBuilder	always_use_requested_range () &&
tl::expected< Transaction, CacheError >	execute () &&
tl::expected< PendingTransaction, CacheError >	execute_async () &&

Friends
class	Transaction

Detailed Description

A builder-style API for configuring a transactional cache lookup.

Member Function Documentation

◆ always_use_requested_range()

TransactionLookupBuilder fastly::cache::core::TransactionLookupBuilder::always_use_requested_range ( ) &&

Respect the range in to_stream_with_range even when the body length is not yet known.

When a cache item is Found, the length of the cached item may or may not be known:

the item may be fully cached;
the item may be streaming in, but have a known length; or
the item may be streaming in progressively, without a known length.

By default (legacy behavior), if a range is specified but the length is not known, the contents of the entire item will be provided instead of the requested range.

always_use_requested_range indicates any cached item returned by this lookup should provide only the requested range, regardless of whether the length is known. An invalid range will eventually return a read error, possibly after providing some data.

NOTE: In the future, the always_use_requested_range behavior will be the default, and this method will be removed.

◆ execute()

tl::expected< Transaction, CacheError > fastly::cache::core::TransactionLookupBuilder::execute ( ) &&

Perform the lookup, entering a Transaction.

If the lookup hits an object being provided by another client, this call will block until that client provides the object's metadata or cancels.

◆ execute_async()

tl::expected< PendingTransaction, CacheError > fastly::cache::core::TransactionLookupBuilder::execute_async ( ) &&

Perform the lookup, returning a PendingTransaction.

If the lookup hits an object being provided by another client, this call will not block. Instead, the returned PendingTransaction can be used to wait for the request collapsed lookup to complete. See the documentation of PendingTransaction for more details.

◆ header()

TransactionLookupBuilder fastly::cache::core::TransactionLookupBuilder::header	(	std::string_view	name,
		const http::HeaderValue &	value ) &&

Sets a single-value header for this lookup, discarding any previous values associated with the header name. Note: These headers are narrowly useful for implementing cache lookups incorporating the semantics of the HTTP Vary header, but the APIs in this module are not suitable for HTTP caching out-of-the-box. Future SDK releases will contain an HTTP Cache API.

The headers act as additional factors in object selection, and the choice of which headers to factor in is determined during insertion, via e.g. crate::cache::core::InsertBuilder::vary_by. A lookup will succeed when there is at least one cached item that matches lookup’s cache key, and all of the lookup’s headers included in the cache items’ vary_by list match the corresponding headers in that cached item.

A typical example is a cached HTTP response, where the request had an Accept-Encoding header. In that case, the origin server may or may not decide on a given encoding, and whether that same response is suitable for a request with a different (or missing) Accept-Encoding header is determined by whether Accept-Encoding is listed in Vary header in the origin’s response.

◆ header_values()

TransactionLookupBuilder fastly::cache::core::TransactionLookupBuilder::header_values	(	std::string_view	name,
		std::span< const http::HeaderValue >	values ) &&

Sets a multi-value header for this lookup, discarding any previous values associated with the header name.

Note: These headers are narrowly useful for implementing cache lookups incorporating the semantics of the HTTP Vary header, but the APIs in this module are not suitable for HTTP caching out-of-the-box. Future SDK releases will contain an HTTP Cache API.

The headers act as additional factors in object selection, and the choice of which headers to factor in is determined during insertion, via e.g. crate::cache::core::InsertBuilder::vary_by. A lookup will succeed when there is at least one cached item that matches lookup’s cache key, and all of the lookup’s headers included in the cache items’ vary_by list match the corresponding headers in that cached item.

A typical example is a cached HTTP response, where the request had an Accept-Encoding header. In that case, the origin server may or may not decide on a given encoding, and whether that same response is suitable for a request with a different (or missing) Accept-Encoding header is determined by whether Accept-Encoding is listed in Vary header in the origin’s response.

◆ on_behalf_of()

TransactionLookupBuilder fastly::cache::core::TransactionLookupBuilder::on_behalf_of ( std::string service ) &&

Perform this lookup on behalf of another service, using its data store.

Internal / Privileged This operation is privileged, and attempts to use this functionality without proper privileges will cause errors. If you are interested in having two or more of your services share the same cache, please talk to your Fastly account representative. While we have no plans to offer this ability widely – this capability is only currently allowed for Fastly-internal services – we may revisit this decision given sufficient customer input.

◆ Transaction

friend class Transaction

friend

The documentation for this class was generated from the following file:

include/fastly/cache/core.h

Public Member Functions

Friends