opentracing-c
OpenTracing C API
Data Fields
opentracing_custom_carrier_reader Struct Reference

extract() carrier for a custom format. More...

#include <opentracing-c/propagation.h>

Inheritance diagram for opentracing_custom_carrier_reader:
[legend]
Collaboration diagram for opentracing_custom_carrier_reader:
[legend]

Data Fields

opentracing_destructible base
 Base class member. More...
 
opentracing_propagation_error_code(* extract )(struct opentracing_custom_carrier_reader *reader, const struct opentracing_tracer *tracer, opentracing_span_context **span_context) OPENTRACINGC_NONNULL_ALL
 Extract a span context from a custom format. More...
 
- Data Fields inherited from opentracing_destructible
void(* destroy )(struct opentracing_destructible *destructible) OPENTRACINGC_NONNULL_ALL
 Destructor to clean up any resources allocated to the instance. More...
 

Detailed Description

extract() carrier for a custom format.

With it, the caller can decode an opentracing_span_context from entries in a custom protocol.

Field Documentation

◆ base

opentracing_destructible opentracing_custom_carrier_reader::base

Base class member.

◆ extract

opentracing_propagation_error_code(* opentracing_custom_carrier_reader::extract) (struct opentracing_custom_carrier_reader *reader, const struct opentracing_tracer *tracer, opentracing_span_context **span_context) OPENTRACINGC_NONNULL_ALL

Extract a span context from a custom format.

Parameters
readerReader instance.
tracerTracer instance.
[out]span_contextSpan context pointer to return decoded span. Set to NULL on propagation failure or out of memory.
Returns
Error code indicating success or failure.

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