context::RuntimeContextStorage Class Reference

Detailed Description

RuntimeContextStorage is used by RuntimeContext to store Context frames.

Custom context management strategies can be implemented by deriving from this class and passing an initialized RuntimeContextStorage object to RuntimeContext::SetRuntimeContextStorage.

Definition at line 48 of file includes/opentelemetry/context/runtime_context.h.

Inheritance diagram for context::RuntimeContextStorage:

Public Member Functions
virtual Context	GetCurrent () noexcept=0
	Return the current context. More...
virtual nostd::unique_ptr< Token >	Attach (const Context &context) noexcept=0
	Set the current context. More...
virtual bool	Detach (Token &token) noexcept=0
	Detach the context related to the given token. More...
virtual	~RuntimeContextStorage ()
virtual Context	GetCurrent () noexcept=0
	Return the current context. More...
virtual nostd::unique_ptr< Token >	Attach (const Context &context) noexcept=0
	Set the current context. More...
virtual bool	Detach (Token &token) noexcept=0
	Detach the context related to the given token. More...
virtual	~RuntimeContextStorage ()

Protected Member Functions
nostd::unique_ptr< Token >	CreateToken (const Context &context) noexcept
nostd::unique_ptr< Token >	CreateToken (const Context &context) noexcept

Constructor & Destructor Documentation

~RuntimeContextStorage() [1/2]

virtual context::RuntimeContextStorage::~RuntimeContextStorage ( )

inlinevirtual

Definition at line 71 of file includes/opentelemetry/context/runtime_context.h.

~RuntimeContextStorage() [2/2]

virtual context::RuntimeContextStorage::~RuntimeContextStorage ( )

inlinevirtual

Definition at line 71 of file 9.2/includes/opentelemetry/context/runtime_context.h.

Member Function Documentation

Attach() [1/2]

virtual nostd::unique_ptr<Token> context::RuntimeContextStorage::Attach ( const Context &  context )

pure virtualnoexcept

Set the current context.

Parameters

context

The new current context

Returns

a token for the new current context. This never returns a nullptr.

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

Attach() [2/2]

virtual nostd::unique_ptr<Token> context::RuntimeContextStorage::Attach ( const Context &  context )

pure virtualnoexcept

Set the current context.

Parameters

context

The new current context

Returns

a token for the new current context. This never returns a nullptr.

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

CreateToken() [1/2]

nostd::unique_ptr<Token> context::RuntimeContextStorage::CreateToken ( const Context &  context )

inlineprotectednoexcept

Definition at line 74 of file includes/opentelemetry/context/runtime_context.h.

Referenced by context::ThreadLocalContextStorage::Attach().

CreateToken() [2/2]

nostd::unique_ptr<Token> context::RuntimeContextStorage::CreateToken ( const Context &  context )

inlineprotectednoexcept

Definition at line 74 of file 9.2/includes/opentelemetry/context/runtime_context.h.

Detach() [1/2]

virtual bool context::RuntimeContextStorage::Detach ( Token &  token )

pure virtualnoexcept

Detach the context related to the given token.

Parameters

token

a token related to a context

Returns

true if the context could be detached

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

Detach() [2/2]

virtual bool context::RuntimeContextStorage::Detach ( Token &  token )

pure virtualnoexcept

Detach the context related to the given token.

Parameters

token

a token related to a context

Returns

true if the context could be detached

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

GetCurrent() [1/2]

virtual Context context::RuntimeContextStorage::GetCurrent ( )

pure virtualnoexcept

Return the current context.

Returns

the current context

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

GetCurrent() [2/2]

virtual Context context::RuntimeContextStorage::GetCurrent ( )

pure virtualnoexcept

Return the current context.

Returns

the current context

Implemented in context::ThreadLocalContextStorage, and context::ThreadLocalContextStorage.

---

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

• includes/opentelemetry/context/runtime_context.h