.. _program_listing_file_include_opentelemetry_trace_noop.h:

Program Listing for File noop.h
===============================

|exhale_lsh| :ref:`Return to documentation for file <file_include_opentelemetry_trace_noop.h>` (``include/opentelemetry/trace/noop.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   #pragma once
   // Please refer to provider.h for documentation on how to obtain a Tracer object.
   //
   // This file is part of the internal implementation of OpenTelemetry. Nothing in this file should be
   // used directly. Please refer to span.h and tracer.h for documentation on these interfaces.
   
   #include "opentelemetry/context/runtime_context.h"
   #include "opentelemetry/nostd/string_view.h"
   #include "opentelemetry/nostd/unique_ptr.h"
   #include "opentelemetry/trace/span.h"
   #include "opentelemetry/trace/span_context.h"
   #include "opentelemetry/trace/span_context_kv_iterable.h"
   #include "opentelemetry/trace/tracer.h"
   #include "opentelemetry/trace/tracer_provider.h"
   #include "opentelemetry/version.h"
   
   #include <memory>
   
   OPENTELEMETRY_BEGIN_NAMESPACE
   namespace trace
   {
   class NoopSpan final : public Span
   {
   public:
     explicit NoopSpan(const std::shared_ptr<Tracer> &tracer) noexcept
         : tracer_{tracer}, span_context_{SpanContext::GetInvalid()}
     {}
   
     void SetAttribute(nostd::string_view /*key*/,
                       const common::AttributeValue & /*value*/) noexcept override
     {}
   
     void AddEvent(nostd::string_view /*name*/) noexcept override {}
   
     void AddEvent(nostd::string_view /*name*/,
                   common::SystemTimestamp /*timestamp*/) noexcept override
     {}
   
     void AddEvent(nostd::string_view /*name*/,
                   common::SystemTimestamp /*timestamp*/,
                   const common::KeyValueIterable & /*attributes*/) noexcept override
     {}
   
     void SetStatus(StatusCode /*code*/, nostd::string_view /*description*/) noexcept override {}
   
     void UpdateName(nostd::string_view /*name*/) noexcept override {}
   
     void End(const EndSpanOptions & /*options*/) noexcept override {}
   
     bool IsRecording() const noexcept override { return false; }
   
     SpanContext GetContext() const noexcept override { return span_context_; }
   
   private:
     std::shared_ptr<Tracer> tracer_;
     SpanContext span_context_;
   };
   
   class NoopTracer final : public Tracer, public std::enable_shared_from_this<NoopTracer>
   {
   public:
     // Tracer
     nostd::shared_ptr<Span> StartSpan(nostd::string_view /*name*/,
                                       const common::KeyValueIterable & /*attributes*/,
                                       const SpanContextKeyValueIterable & /*links*/,
                                       const StartSpanOptions & /*options*/) noexcept override
     {
       // Don't allocate a no-op span for every StartSpan call, but use a static
       // singleton for this case.
       static nostd::shared_ptr<trace_api::Span> noop_span(
           new trace_api::NoopSpan{this->shared_from_this()});
   
       return noop_span;
     }
   
     void ForceFlushWithMicroseconds(uint64_t /*timeout*/) noexcept override {}
   
     void CloseWithMicroseconds(uint64_t /*timeout*/) noexcept override {}
   };
   
   class NoopTracerProvider final : public opentelemetry::trace::TracerProvider
   {
   public:
     NoopTracerProvider()
         : tracer_{nostd::shared_ptr<opentelemetry::trace::NoopTracer>(
               new opentelemetry::trace::NoopTracer)}
     {}
   
     nostd::shared_ptr<opentelemetry::trace::Tracer> GetTracer(
         nostd::string_view library_name,
         nostd::string_view library_version) override
     {
       return tracer_;
     }
   
   private:
     nostd::shared_ptr<opentelemetry::trace::Tracer> tracer_;
   };
   }  // namespace trace
   OPENTELEMETRY_END_NAMESPACE