GRPC Core  49.0.0
event_engine.h
Go to the documentation of this file.
1 // Copyright 2021 The gRPC Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 #ifndef GRPC_EVENT_ENGINE_EVENT_ENGINE_H
15 #define GRPC_EVENT_ENGINE_EVENT_ENGINE_H
16 
21 #include <grpc/event_engine/port.h>
24 
25 #include <bitset>
26 #include <cstddef>
27 #include <initializer_list>
28 #include <memory>
29 #include <optional>
30 #include <utility>
31 #include <vector>
32 
33 #include "absl/functional/any_invocable.h"
34 #include "absl/status/status.h"
35 #include "absl/status/statusor.h"
36 #include "absl/types/span.h"
37 
38 // TODO(vigneshbabu): Define the Endpoint::Write metrics collection system
39 // TODO(hork): remove all references to the factory methods.
40 namespace grpc_event_engine {
41 namespace experimental {
42 
111 class EventEngine : public std::enable_shared_from_this<EventEngine>,
112  public Extensible {
113  public:
118  using Duration = std::chrono::duration<int64_t, std::nano>;
125 
126  class Closure {
127  public:
128  Closure() = default;
129  // Closure's are an interface, and thus non-copyable.
130  Closure(const Closure&) = delete;
131  Closure& operator=(const Closure&) = delete;
132  // Polymorphic type => virtual destructor
133  virtual ~Closure() = default;
134  // Run the contained code.
135  virtual void Run() = 0;
136  };
141  struct TaskHandle {
142  intptr_t keys[2];
144  };
149  intptr_t keys[2];
151  };
160  public:
161  static constexpr socklen_t MAX_SIZE_BYTES = 128;
162 
163  ResolvedAddress(const sockaddr* address, socklen_t size);
164  ResolvedAddress() = default;
165  ResolvedAddress(const ResolvedAddress&) = default;
166  const struct sockaddr* address() const;
167  socklen_t size() const;
168 
169  private:
170  char address_[MAX_SIZE_BYTES] = {};
171  socklen_t size_ = 0;
172  };
173 
182  class Endpoint : public Extensible {
183  public:
186  virtual ~Endpoint() = default;
191  class ReadArgs final {
192  public:
193  ReadArgs() = default;
194  ReadArgs(const ReadArgs&) = delete;
195  ReadArgs& operator=(const ReadArgs&) = delete;
196  ReadArgs(ReadArgs&&) = default;
197  ReadArgs& operator=(ReadArgs&&) = default;
198 
199  // A suggestion to the endpoint implementation to read at-least the
200  // specified number of bytes over the network connection before marking
201  // the endpoint read operation as complete. gRPC may use this argument
202  // to minimize the number of endpoint read API calls over the lifetime
203  // of a connection.
205  read_hint_bytes_ = read_hint_bytes;
206  }
207  int64_t read_hint_bytes() const { return read_hint_bytes_; }
208 
209  private:
210  int64_t read_hint_bytes_ = 1;
211  };
235  virtual bool Read(absl::AnyInvocable<void(absl::Status)> on_read,
236  SliceBuffer* buffer, ReadArgs args) = 0;
244  struct WriteMetric {
245  size_t key;
246  int64_t value;
247  };
248  // It is the responsibility of the caller of WriteEventCallback to make sure
249  // that the corresponding endpoint is still valid. HINT: Do NOT offload
250  // callbacks onto the EventEngine or other threads.
251  using WriteEventCallback = absl::AnyInvocable<void(
252  WriteEvent, absl::Time, std::vector<WriteMetric>) const>;
253  // A bitmask of the events that the caller is interested in.
254  // Each bit corresponds to an entry in WriteEvent.
255  using WriteEventSet = std::bitset<static_cast<int>(WriteEvent::kCount)>;
256 
257  // A set of metrics that the caller is interested in.
258  class MetricsSet {
259  public:
260  virtual ~MetricsSet() = default;
261 
262  virtual bool IsSet(size_t key) const = 0;
263  };
264 
265  // A sink to receive write events.
266  // The requested metrics are the keys of the metrics that the caller is
267  // interested in. The on_event callback will be called on each event
268  // requested.
269  class WriteEventSink final {
270  public:
271  WriteEventSink(std::shared_ptr<MetricsSet> requested_metrics,
272  std::initializer_list<WriteEvent> requested_events,
273  WriteEventCallback on_event)
274  : requested_metrics_(std::move(requested_metrics)),
275  on_event_(std::move(on_event)) {
276  for (auto event : requested_events) {
277  requested_events_mask_.set(static_cast<int>(event));
278  }
279  }
280 
281  const std::shared_ptr<MetricsSet>& requested_metrics() const {
282  return requested_metrics_;
283  }
284 
285  bool requested_event(WriteEvent event) const {
286  return requested_events_mask_.test(static_cast<int>(event));
287  }
288 
290  return requested_events_mask_;
291  }
292 
295  WriteEventCallback TakeEventCallback() { return std::move(on_event_); }
296 
297  private:
298  std::shared_ptr<MetricsSet> requested_metrics_;
299  WriteEventSet requested_events_mask_;
300  // The callback to be called on each event.
301  WriteEventCallback on_event_;
302  };
307  class WriteArgs final {
308  public:
309  WriteArgs() = default;
310 
311  ~WriteArgs();
312 
313  WriteArgs(const WriteArgs&) = delete;
314  WriteArgs& operator=(const WriteArgs&) = delete;
315 
316  WriteArgs(WriteArgs&& other) noexcept
317  : metrics_sink_(std::move(other.metrics_sink_)),
318  google_specific_(other.google_specific_),
319  max_frame_size_(other.max_frame_size_) {
320  other.google_specific_ = nullptr;
321  }
322 
323  WriteArgs& operator=(WriteArgs&& other) noexcept {
324  if (this != &other) {
325  metrics_sink_ = std::move(other.metrics_sink_);
326  google_specific_ = other.google_specific_;
327  other.google_specific_ = nullptr; // Nullify source
328  max_frame_size_ = other.max_frame_size_;
329  }
330  return *this;
331  }
332 
333  // A sink to receive write events.
334  std::optional<WriteEventSink> TakeMetricsSink() {
335  auto sink = std::move(metrics_sink_);
336  metrics_sink_.reset();
337  return sink;
338  }
339 
340  bool has_metrics_sink() const { return metrics_sink_.has_value(); }
341 
343  metrics_sink_ = std::move(sink);
344  }
345 
346  // Represents private information that may be passed by gRPC for
347  // select endpoints expected to be used only within google.
348  // TODO(ctiller): Remove this method once all callers are migrated to
349  // metrics sink.
351  return google_specific_;
352  }
353 
355  return std::exchange(google_specific_, nullptr);
356  }
357 
359  google_specific_ = pointer;
360  }
361 
362  // A suggestion to the endpoint implementation to group data to be written
363  // into frames of the specified max_frame_size. gRPC may use this
364  // argument to dynamically control the max sizes of frames sent to a
365  // receiver in response to high receiver memory pressure.
366  int64_t max_frame_size() const { return max_frame_size_; }
367 
369  max_frame_size_ = max_frame_size;
370  }
371 
372  private:
373  std::optional<WriteEventSink> metrics_sink_;
374  void* google_specific_ = nullptr;
375  int64_t max_frame_size_ = 1024 * 1024;
376  };
377 
379  public:
380  virtual ~TelemetryInfo() = default;
381 
386  virtual std::vector<size_t> AllWriteMetrics() const = 0;
389  virtual std::optional<absl::string_view> GetMetricName(
390  size_t key) const = 0;
393  virtual std::optional<size_t> GetMetricKey(
394  absl::string_view name) const = 0;
396  virtual std::shared_ptr<MetricsSet> GetMetricsSet(
397  absl::Span<const size_t> keys) const = 0;
399  virtual std::shared_ptr<MetricsSet> GetFullMetricsSet() const = 0;
400  };
401 
422  virtual bool Write(absl::AnyInvocable<void(absl::Status)> on_writable,
423  SliceBuffer* data, WriteArgs args) = 0;
426  virtual const ResolvedAddress& GetPeerAddress() const = 0;
427  virtual const ResolvedAddress& GetLocalAddress() const = 0;
428 
429  virtual std::shared_ptr<TelemetryInfo> GetTelemetryInfo() const = 0;
430  };
431 
438  using OnConnectCallback =
439  absl::AnyInvocable<void(absl::StatusOr<std::unique_ptr<Endpoint>>)>;
440 
443  class Listener : public Extensible {
444  public:
446  using AcceptCallback = absl::AnyInvocable<void(
447  std::unique_ptr<Endpoint>, MemoryAllocator memory_allocator)>;
448  virtual ~Listener() = default;
454  virtual absl::StatusOr<int> Bind(const ResolvedAddress& addr) = 0;
455  virtual absl::Status Start() = 0;
456  };
457 
473  virtual absl::StatusOr<std::unique_ptr<Listener>> CreateListener(
474  Listener::AcceptCallback on_accept,
475  absl::AnyInvocable<void(absl::Status)> on_shutdown,
476  const EndpointConfig& config,
477  std::unique_ptr<MemoryAllocatorFactory> memory_allocator_factory) = 0;
489  virtual ConnectionHandle Connect(OnConnectCallback on_connect,
490  const ResolvedAddress& addr,
491  const EndpointConfig& args,
492  MemoryAllocator memory_allocator,
493  Duration timeout) = 0;
494 
503  virtual bool CancelConnect(ConnectionHandle handle) = 0;
511  class DNSResolver : public Extensible {
512  public:
517  std::string dns_server;
518  };
520  struct SRVRecord {
521  std::string host;
522  int port = 0;
523  int priority = 0;
524  int weight = 0;
525  };
528  using LookupHostnameCallback =
529  absl::AnyInvocable<void(absl::StatusOr<std::vector<ResolvedAddress>>)>;
531  using LookupSRVCallback =
532  absl::AnyInvocable<void(absl::StatusOr<std::vector<SRVRecord>>)>;
534  using LookupTXTCallback =
535  absl::AnyInvocable<void(absl::StatusOr<std::vector<std::string>>)>;
536 
537  virtual ~DNSResolver() = default;
538 
549  virtual void LookupHostname(LookupHostnameCallback on_resolve,
550  absl::string_view name,
551  absl::string_view default_port) = 0;
556  virtual void LookupSRV(LookupSRVCallback on_resolve,
557  absl::string_view name) = 0;
562  virtual void LookupTXT(LookupTXTCallback on_resolve,
563  absl::string_view name) = 0;
564  };
565 
573  virtual ~EventEngine() = default;
574 
575  // TODO(nnoble): consider whether we can remove this method before we
576  // de-experimentalize this API.
577  virtual bool IsWorkerThread() = 0;
578 
584  virtual absl::StatusOr<std::unique_ptr<DNSResolver>> GetDNSResolver(
585  const DNSResolver::ResolverOptions& options) = 0;
586 
596  virtual void Run(Closure* closure) = 0;
609  virtual void Run(absl::AnyInvocable<void()> closure) = 0;
621  virtual TaskHandle RunAfter(Duration when, Closure* closure) = 0;
636  virtual TaskHandle RunAfter(Duration when,
637  absl::AnyInvocable<void()> closure) = 0;
646  virtual bool Cancel(TaskHandle handle) = 0;
647 };
648 
658 // TODO(hork): delete once all known users have migrated away
660  absl::AnyInvocable<std::shared_ptr<EventEngine>()> factory);
661 
668 //
669 // TODO(hork): delete once all known users have migrated away
671 
673 std::shared_ptr<EventEngine> CreateEventEngine();
674 
684 void SetDefaultEventEngine(std::shared_ptr<EventEngine> engine);
685 
694 std::shared_ptr<EventEngine> GetDefaultEventEngine();
695 
708 
709 bool operator==(const EventEngine::TaskHandle& lhs,
710  const EventEngine::TaskHandle& rhs);
711 bool operator!=(const EventEngine::TaskHandle& lhs,
712  const EventEngine::TaskHandle& rhs);
713 std::ostream& operator<<(std::ostream& out,
714  const EventEngine::TaskHandle& handle);
716  const EventEngine::ConnectionHandle& rhs);
718  const EventEngine::ConnectionHandle& rhs);
719 std::ostream& operator<<(std::ostream& out,
720  const EventEngine::ConnectionHandle& handle);
721 
722 namespace detail {
723 std::string FormatHandleString(uint64_t key1, uint64_t key2);
724 }
725 
726 template <typename Sink>
727 void AbslStringify(Sink& out, const EventEngine::ConnectionHandle& handle) {
728  out.Append(detail::FormatHandleString(handle.keys[0], handle.keys[1]));
729 }
730 
731 template <typename Sink>
732 void AbslStringify(Sink& out, const EventEngine::TaskHandle& handle) {
733  out.Append(detail::FormatHandleString(handle.keys[0], handle.keys[1]));
734 }
735 
736 } // namespace experimental
737 } // namespace grpc_event_engine
738 
739 #endif // GRPC_EVENT_ENGINE_EVENT_ENGINE_H
grpc_event_engine::experimental::EventEngine::OnConnectCallback
absl::AnyInvocable< void(absl::StatusOr< std::unique_ptr< Endpoint > >)> OnConnectCallback
Called when a new connection is established.
Definition: event_engine.h:439
grpc_event_engine::experimental::internal::WriteEvent
WriteEvent
Definition: write_event.h:23
grpc_event_engine::experimental::EventEngine::~EventEngine
virtual ~EventEngine()=default
At time of destruction, the EventEngine must have no active responsibilities.
grpc_event_engine::experimental::operator<<
std::ostream & operator<<(std::ostream &out, const EventEngine::TaskHandle &handle)
grpc_event_engine::experimental::EventEngine::ResolvedAddress::size
socklen_t size() const
grpc_event_engine::experimental::ShutdownDefaultEventEngine
void ShutdownDefaultEventEngine()
Resets gRPC to use one of the default internal EventEngines for all new GetDefaultEventEngine request...
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricKey
virtual std::optional< size_t > GetMetricKey(absl::string_view name) const =0
Returns the key of the write metric with the given name.
grpc_event_engine::experimental::EventEngine::Endpoint::WriteMetric
An output WriteMetric consists of a key and a value.
Definition: event_engine.h:244
grpc_event_engine::experimental::EventEngine::ConnectionHandle
A handle to a cancellable connection attempt.
Definition: event_engine.h:148
port.h
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSet
std::bitset< static_cast< int >(WriteEvent::kCount)> WriteEventSet
Definition: event_engine.h:255
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::TakeMetricsSink
std::optional< WriteEventSink > TakeMetricsSink()
Definition: event_engine.h:334
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs::ReadArgs
ReadArgs()=default
grpc_event_engine::experimental::GetDefaultEventEngine
std::shared_ptr< EventEngine > GetDefaultEventEngine()
Returns the default EventEngine instance.
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::WriteArgs
WriteArgs()=default
grpc_event_engine::experimental::EventEngine::Endpoint::WriteMetric::key
size_t key
Definition: event_engine.h:245
grpc_event_engine::experimental::EventEngine::ResolvedAddress::MAX_SIZE_BYTES
static constexpr socklen_t MAX_SIZE_BYTES
Definition: event_engine.h:161
extensible.h
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::~WriteArgs
~WriteArgs()
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::requested_metrics
const std::shared_ptr< MetricsSet > & requested_metrics() const
Definition: event_engine.h:281
grpc_event_engine::experimental::EventEngine::RunAfter
virtual TaskHandle RunAfter(Duration when, Closure *closure)=0
Synonymous with scheduling an alarm to run after duration when.
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::TakeEventCallback
WriteEventCallback TakeEventCallback()
Takes the callback.
Definition: event_engine.h:295
grpc_event_engine::experimental::EventEngine::Listener::AcceptCallback
absl::AnyInvocable< void(std::unique_ptr< Endpoint >, MemoryAllocator memory_allocator)> AcceptCallback
Called when the listener has accepted a new client connection.
Definition: event_engine.h:447
grpc_event_engine::experimental::EventEngine
The EventEngine Interface.
Definition: event_engine.h:111
grpc_event_engine::experimental::EventEngine::Endpoint::~Endpoint
virtual ~Endpoint()=default
Shuts down all connections and invokes all pending read or write callbacks with an error status.
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs::operator=
ReadArgs & operator=(const ReadArgs &)=delete
grpc_event_engine::experimental::EventEngine::IsWorkerThread
virtual bool IsWorkerThread()=0
grpc_event_engine::experimental::EventEngine::DNSResolver::~DNSResolver
virtual ~DNSResolver()=default
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupHostname
virtual void LookupHostname(LookupHostnameCallback on_resolve, absl::string_view name, absl::string_view default_port)=0
Asynchronously resolve an address.
grpc_event_engine::experimental::AbslStringify
void AbslStringify(Sink &out, const EventEngine::ConnectionHandle &handle)
Definition: event_engine.h:727
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::set_metrics_sink
void set_metrics_sink(WriteEventSink sink)
Definition: event_engine.h:342
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink
Definition: event_engine.h:269
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupSRVCallback
absl::AnyInvocable< void(absl::StatusOr< std::vector< SRVRecord > >)> LookupSRVCallback
Called with a collection of SRV records.
Definition: event_engine.h:532
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventCallback
absl::AnyInvocable< void(WriteEvent, absl::Time, std::vector< WriteMetric >) const > WriteEventCallback
Definition: event_engine.h:252
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::TakeDeprecatedAndDiscouragedGoogleSpecificPointer
void * TakeDeprecatedAndDiscouragedGoogleSpecificPointer()
Definition: event_engine.h:354
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::port
int port
Definition: event_engine.h:522
grpc_event_engine::experimental::EventEngine::Endpoint::Write
virtual bool Write(absl::AnyInvocable< void(absl::Status)> on_writable, SliceBuffer *data, WriteArgs args)=0
Writes data out on the connection.
grpc_event_engine::experimental::EventEngine::Listener::Bind
virtual absl::StatusOr< int > Bind(const ResolvedAddress &addr)=0
Bind an address/port to this Listener.
grpc_event_engine::experimental::EventEngine::Endpoint::MetricsSet::IsSet
virtual bool IsSet(size_t key) const =0
grpc_event_engine::experimental::EventEngine::Endpoint::MetricsSet
Definition: event_engine.h:258
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::host
std::string host
Definition: event_engine.h:521
grpc_event_engine::experimental::EventEngine::ConnectionHandle::keys
intptr_t keys[2]
Definition: event_engine.h:149
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::has_metrics_sink
bool has_metrics_sink() const
Definition: event_engine.h:340
grpc_event_engine::experimental::EventEngineFactoryReset
void EventEngineFactoryReset()
[DEPRECATED] Reset gRPC's EventEngine factory to the built-in default.
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupHostnameCallback
absl::AnyInvocable< void(absl::StatusOr< std::vector< ResolvedAddress > >)> LookupHostnameCallback
Called with the collection of sockaddrs that were resolved from a given target address.
Definition: event_engine.h:529
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs
A struct representing optional arguments that may be provided to an EventEngine Endpoint Write API ca...
Definition: event_engine.h:307
grpc_event_engine::experimental::EventEngine::CancelConnect
virtual bool CancelConnect(ConnectionHandle handle)=0
Request cancellation of a connection attempt.
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::SetDeprecatedAndDiscouragedGoogleSpecificPointer
void SetDeprecatedAndDiscouragedGoogleSpecificPointer(void *pointer)
Definition: event_engine.h:358
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricsSet
virtual std::shared_ptr< MetricsSet > GetMetricsSet(absl::Span< const size_t > keys) const =0
Returns a MetricsSet with all the keys from keys set.
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::set_max_frame_size
void set_max_frame_size(int64_t max_frame_size)
Definition: event_engine.h:368
grpc_event_engine::experimental::operator!=
bool operator!=(const EventEngine::TaskHandle &lhs, const EventEngine::TaskHandle &rhs)
grpc_event_engine::experimental::EventEngine::Endpoint::WriteMetric::value
int64_t value
Definition: event_engine.h:246
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::operator=
WriteArgs & operator=(const WriteArgs &)=delete
grpc_event_engine::experimental::EventEngine::DNSResolver::ResolverOptions
Optional configuration for DNSResolvers.
Definition: event_engine.h:514
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::WriteArgs
WriteArgs(WriteArgs &&other) noexcept
Definition: event_engine.h:316
grpc_event_engine::experimental::EventEngine::Endpoint::GetTelemetryInfo
virtual std::shared_ptr< TelemetryInfo > GetTelemetryInfo() const =0
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord
DNS SRV record type.
Definition: event_engine.h:520
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupTXT
virtual void LookupTXT(LookupTXTCallback on_resolve, absl::string_view name)=0
Asynchronously perform a TXT record lookup.
grpc_event_engine::experimental::EndpointConfig
Collection of parameters used to configure client and server endpoints.
Definition: endpoint_config.h:31
grpc_event_engine::experimental::EventEngine::ResolvedAddress
Thin wrapper around a platform-specific sockaddr type.
Definition: event_engine.h:159
grpc_event_engine::experimental::EventEngine::Listener
Listens for incoming connection requests from gRPC clients and initiates request processing once conn...
Definition: event_engine.h:443
grpc_event_engine::experimental::SliceBuffer
A Wrapper around grpc_slice_buffer pointer.
Definition: slice_buffer.h:50
grpc_event_engine::experimental::detail::FormatHandleString
std::string FormatHandleString(uint64_t key1, uint64_t key2)
grpc_event_engine::experimental::EventEngine::Closure
A custom closure type for EventEngine task execution.
Definition: event_engine.h:126
grpc_event_engine::experimental::EventEngine::Closure::Closure
Closure()=default
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo
Definition: event_engine.h:378
grpc_event_engine::experimental::EventEngine::ResolvedAddress::ResolvedAddress
ResolvedAddress()=default
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::WriteEventSink
WriteEventSink(std::shared_ptr< MetricsSet > requested_metrics, std::initializer_list< WriteEvent > requested_events, WriteEventCallback on_event)
Definition: event_engine.h:271
grpc_event_engine::experimental::EventEngine::ResolvedAddress::address
const struct sockaddr * address() const
grpc_event_engine::experimental::EventEngine::Listener::Start
virtual absl::Status Start()=0
grpc_event_engine::experimental::EventEngine::Closure::operator=
Closure & operator=(const Closure &)=delete
grpc_event_engine::experimental::EventEngine::Closure::~Closure
virtual ~Closure()=default
grpc_event_engine::experimental::EventEngine::Run
virtual void Run(Closure *closure)=0
Asynchronously executes a task as soon as possible.
slice_buffer.h
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::requested_events_mask
WriteEventSet requested_events_mask() const
Definition: event_engine.h:289
grpc_event_engine::experimental::EventEngine::DNSResolver::ResolverOptions::dns_server
std::string dns_server
If empty, default DNS servers will be used.
Definition: event_engine.h:517
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::weight
int weight
Definition: event_engine.h:524
grpc_event_engine::experimental::SetEventEngineFactory
void SetEventEngineFactory(absl::AnyInvocable< std::shared_ptr< EventEngine >()> factory)
[DEPRECATED] Replace gRPC's default EventEngine factory.
grpc_event_engine::experimental::EventEngine::Endpoint::GetPeerAddress
virtual const ResolvedAddress & GetPeerAddress() const =0
Returns an address in the format described in DNSResolver.
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::~TelemetryInfo
virtual ~TelemetryInfo()=default
grpc_event_engine::experimental::EventEngine::Closure::Run
virtual void Run()=0
grpc_event_engine::experimental::EventEngine::DNSResolver
Provides asynchronous resolution.
Definition: event_engine.h:511
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::GetDeprecatedAndDiscouragedGoogleSpecificPointer
void * GetDeprecatedAndDiscouragedGoogleSpecificPointer()
Definition: event_engine.h:350
grpc_event_engine::experimental::EventEngine::Endpoint::Read
virtual bool Read(absl::AnyInvocable< void(absl::Status)> on_read, SliceBuffer *buffer, ReadArgs args)=0
Reads data from the Endpoint.
grpc_event_engine::experimental::Extensible
Definition: extensible.h:25
grpc_event_engine::experimental::EventEngine::TaskHandle
Represents a scheduled task.
Definition: event_engine.h:141
grpc_event_engine::experimental::EventEngine::Cancel
virtual bool Cancel(TaskHandle handle)=0
Request cancellation of a task.
grpc_event_engine::experimental::SetDefaultEventEngine
void SetDefaultEventEngine(std::shared_ptr< EventEngine > engine)
Set the default EventEngine instance, which will be used throughout gRPC.
grpc_event_engine::experimental::CreateEventEngine
std::shared_ptr< EventEngine > CreateEventEngine()
Create a new EventEngine instance.
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs
A struct representing optional arguments that may be provided to an EventEngine Endpoint Read API cal...
Definition: event_engine.h:191
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::operator=
WriteArgs & operator=(WriteArgs &&other) noexcept
Definition: event_engine.h:323
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::priority
int priority
Definition: event_engine.h:523
write_event.h
grpc_event_engine::experimental::EventEngine::GetDNSResolver
virtual absl::StatusOr< std::unique_ptr< DNSResolver > > GetDNSResolver(const DNSResolver::ResolverOptions &options)=0
Creates and returns an instance of a DNSResolver, optionally configured by the options struct.
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs::set_read_hint_bytes
void set_read_hint_bytes(int64_t read_hint_bytes)
Definition: event_engine.h:204
grpc_event_engine::experimental::EventEngine::TaskHandle::kInvalid
static const GRPC_DLL TaskHandle kInvalid
Definition: event_engine.h:143
grpc_event_engine
Definition: endpoint_config.h:24
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::max_frame_size
int64_t max_frame_size() const
Definition: event_engine.h:366
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupTXTCallback
absl::AnyInvocable< void(absl::StatusOr< std::vector< std::string > >)> LookupTXTCallback
Called with the result of a TXT record lookup.
Definition: event_engine.h:535
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::requested_event
bool requested_event(WriteEvent event) const
Definition: event_engine.h:285
grpc_event_engine::experimental::EventEngine::ConnectionHandle::kInvalid
static const GRPC_DLL ConnectionHandle kInvalid
Definition: event_engine.h:150
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs::read_hint_bytes
int64_t read_hint_bytes() const
Definition: event_engine.h:207
grpc_event_engine::experimental::EventEngine::Endpoint
One end of a connection between a gRPC client and server.
Definition: event_engine.h:182
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetFullMetricsSet
virtual std::shared_ptr< MetricsSet > GetFullMetricsSet() const =0
Returns a MetricsSet with all supported keys set.
grpc_event_engine::experimental::MemoryAllocator
Definition: memory_allocator.h:33
grpc_event_engine::experimental::EventEngine::Endpoint::MetricsSet::~MetricsSet
virtual ~MetricsSet()=default
grpc_event_engine::experimental::EventEngine::Connect
virtual ConnectionHandle Connect(OnConnectCallback on_connect, const ResolvedAddress &addr, const EndpointConfig &args, MemoryAllocator memory_allocator, Duration timeout)=0
Creates a client network connection to a remote network listener.
memory_allocator.h
GRPC_DLL
#define GRPC_DLL
Definition: port_platform.h:130
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::GetMetricName
virtual std::optional< absl::string_view > GetMetricName(size_t key) const =0
Returns the name of the write metric with the given key.
grpc_event_engine::experimental::EventEngine::TaskHandle::keys
intptr_t keys[2]
Definition: event_engine.h:142
grpc_event_engine::experimental::EventEngine::Endpoint::TelemetryInfo::AllWriteMetrics
virtual std::vector< size_t > AllWriteMetrics() const =0
Returns the list of write metrics that the endpoint supports.
endpoint_config.h
grpc_event_engine::experimental::EventEngine::Listener::~Listener
virtual ~Listener()=default
grpc_event_engine::experimental::EventEngine::DNSResolver::LookupSRV
virtual void LookupSRV(LookupSRVCallback on_resolve, absl::string_view name)=0
Asynchronously perform an SRV record lookup.
grpc_event_engine::experimental::EventEngine::CreateListener
virtual absl::StatusOr< std::unique_ptr< Listener > > CreateListener(Listener::AcceptCallback on_accept, absl::AnyInvocable< void(absl::Status)> on_shutdown, const EndpointConfig &config, std::unique_ptr< MemoryAllocatorFactory > memory_allocator_factory)=0
Factory method to create a network listener / server.
grpc_event_engine::experimental::EventEngine::Duration
std::chrono::duration< int64_t, std::nano > Duration
A duration between two events.
Definition: event_engine.h:118
grpc_event_engine::experimental::EventEngine::Endpoint::GetLocalAddress
virtual const ResolvedAddress & GetLocalAddress() const =0
grpc_event_engine::experimental::operator==
bool operator==(const EventEngine::TaskHandle &lhs, const EventEngine::TaskHandle &rhs)
port_platform.h