GRPC C++  1.73.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 <initializer_list>
27 #include <vector>
28 
29 #include "absl/functional/any_invocable.h"
30 #include "absl/status/status.h"
31 #include "absl/status/statusor.h"
32 
33 // TODO(vigneshbabu): Define the Endpoint::Write metrics collection system
34 // TODO(hork): remove all references to the factory methods.
35 namespace grpc_event_engine {
36 namespace experimental {
37 
106 class EventEngine : public std::enable_shared_from_this<EventEngine>,
107  public Extensible {
108  public:
113  using Duration = std::chrono::duration<int64_t, std::nano>;
120 
121  class Closure {
122  public:
123  Closure() = default;
124  // Closure's are an interface, and thus non-copyable.
125  Closure(const Closure&) = delete;
126  Closure& operator=(const Closure&) = delete;
127  // Polymorphic type => virtual destructor
128  virtual ~Closure() = default;
129  // Run the contained code.
130  virtual void Run() = 0;
131  };
136  struct TaskHandle {
137  intptr_t keys[2];
139  };
144  intptr_t keys[2];
146  };
155  public:
156  static constexpr socklen_t MAX_SIZE_BYTES = 128;
157 
158  ResolvedAddress(const sockaddr* address, socklen_t size);
159  ResolvedAddress() = default;
160  ResolvedAddress(const ResolvedAddress&) = default;
161  const struct sockaddr* address() const;
162  socklen_t size() const;
163 
164  private:
165  char address_[MAX_SIZE_BYTES] = {};
166  socklen_t size_ = 0;
167  };
168 
177  class Endpoint : public Extensible {
178  public:
181  virtual ~Endpoint() = default;
186  class ReadArgs final {
187  public:
188  ReadArgs() = default;
189  ReadArgs(const ReadArgs&) = delete;
190  ReadArgs& operator=(const ReadArgs&) = delete;
191  ReadArgs(ReadArgs&&) = default;
192  ReadArgs& operator=(ReadArgs&&) = default;
193 
194  // A suggestion to the endpoint implementation to read at-least the
195  // specified number of bytes over the network connection before marking
196  // the endpoint read operation as complete. gRPC may use this argument
197  // to minimize the number of endpoint read API calls over the lifetime
198  // of a connection.
200  read_hint_bytes_ = read_hint_bytes;
201  }
202  int64_t read_hint_bytes() const { return read_hint_bytes_; }
203 
204  private:
205  int64_t read_hint_bytes_ = 1;
206  };
230  virtual bool Read(absl::AnyInvocable<void(absl::Status)> on_read,
231  SliceBuffer* buffer, ReadArgs args) = 0;
239  struct WriteMetric {
240  size_t key;
241  int64_t value;
242  };
243  using WriteEventCallback = absl::AnyInvocable<void(
244  WriteEvent, absl::Time, std::vector<WriteMetric>) const>;
245  // A bitmask of the events that the caller is interested in.
246  // Each bit corresponds to an entry in WriteEvent.
247  using WriteEventSet = std::bitset<static_cast<int>(WriteEvent::kCount)>;
248  // A sink to receive write events.
249  // The requested metrics are the keys of the metrics that the caller is
250  // interested in. The on_event callback will be called on each event
251  // requested.
252  class WriteEventSink final {
253  public:
254  WriteEventSink(absl::Span<const size_t> requested_metrics,
255  std::initializer_list<WriteEvent> requested_events,
256  WriteEventCallback on_event)
257  : requested_metrics_(requested_metrics),
258  on_event_(std::move(on_event)) {
259  for (auto event : requested_events) {
260  requested_events_mask_.set(static_cast<int>(event));
261  }
262  }
263 
264  absl::Span<const size_t> requested_metrics() const {
265  return requested_metrics_;
266  }
267 
268  bool requested_event(WriteEvent event) const {
269  return requested_events_mask_.test(static_cast<int>(event));
270  }
271 
273  return requested_events_mask_;
274  }
275 
276  WriteEventCallback TakeEventCallback() { return std::move(on_event_); }
277 
278  private:
279  absl::Span<const size_t> requested_metrics_;
280  WriteEventSet requested_events_mask_;
281  // The callback to be called on each event.
282  WriteEventCallback on_event_;
283  };
288  class WriteArgs final {
289  public:
290  WriteArgs() = default;
291  WriteArgs(const WriteArgs&) = delete;
292  WriteArgs& operator=(const WriteArgs&) = delete;
293  WriteArgs(WriteArgs&&) = default;
294  WriteArgs& operator=(WriteArgs&&) = default;
295 
296  // A sink to receive write events.
297  std::optional<WriteEventSink> TakeMetricsSink() {
298  auto sink = std::move(metrics_sink_);
299  metrics_sink_.reset();
300  return sink;
301  }
302 
303  bool has_metrics_sink() const { return metrics_sink_.has_value(); }
304 
306  metrics_sink_ = std::move(sink);
307  }
308 
309  // Represents private information that may be passed by gRPC for
310  // select endpoints expected to be used only within google.
311  // TODO(ctiller): Remove this method once all callers are migrated to
312  // metrics sink.
314  return google_specific_;
315  }
316 
318  google_specific_ = pointer;
319  }
320 
321  // A suggestion to the endpoint implementation to group data to be written
322  // into frames of the specified max_frame_size. gRPC may use this
323  // argument to dynamically control the max sizes of frames sent to a
324  // receiver in response to high receiver memory pressure.
325  int64_t max_frame_size() const { return max_frame_size_; }
326 
328  max_frame_size_ = max_frame_size;
329  }
330 
331  private:
332  std::optional<WriteEventSink> metrics_sink_;
333  void* google_specific_ = nullptr;
334  int64_t max_frame_size_ = 1024 * 1024;
335  };
356  virtual bool Write(absl::AnyInvocable<void(absl::Status)> on_writable,
357  SliceBuffer* data, WriteArgs args) = 0;
360  virtual const ResolvedAddress& GetPeerAddress() const = 0;
361  virtual const ResolvedAddress& GetLocalAddress() const = 0;
366  virtual std::vector<size_t> AllWriteMetrics() = 0;
369  virtual std::optional<absl::string_view> GetMetricName(size_t key) = 0;
372  virtual std::optional<size_t> GetMetricKey(absl::string_view name) = 0;
373  };
374 
381  using OnConnectCallback =
382  absl::AnyInvocable<void(absl::StatusOr<std::unique_ptr<Endpoint>>)>;
383 
386  class Listener : public Extensible {
387  public:
389  using AcceptCallback = absl::AnyInvocable<void(
390  std::unique_ptr<Endpoint>, MemoryAllocator memory_allocator)>;
391  virtual ~Listener() = default;
397  virtual absl::StatusOr<int> Bind(const ResolvedAddress& addr) = 0;
398  virtual absl::Status Start() = 0;
399  };
400 
416  virtual absl::StatusOr<std::unique_ptr<Listener>> CreateListener(
417  Listener::AcceptCallback on_accept,
418  absl::AnyInvocable<void(absl::Status)> on_shutdown,
419  const EndpointConfig& config,
420  std::unique_ptr<MemoryAllocatorFactory> memory_allocator_factory) = 0;
432  virtual ConnectionHandle Connect(OnConnectCallback on_connect,
433  const ResolvedAddress& addr,
434  const EndpointConfig& args,
435  MemoryAllocator memory_allocator,
436  Duration timeout) = 0;
437 
446  virtual bool CancelConnect(ConnectionHandle handle) = 0;
454  class DNSResolver : public Extensible {
455  public:
460  std::string dns_server;
461  };
463  struct SRVRecord {
464  std::string host;
465  int port = 0;
466  int priority = 0;
467  int weight = 0;
468  };
471  using LookupHostnameCallback =
472  absl::AnyInvocable<void(absl::StatusOr<std::vector<ResolvedAddress>>)>;
474  using LookupSRVCallback =
475  absl::AnyInvocable<void(absl::StatusOr<std::vector<SRVRecord>>)>;
477  using LookupTXTCallback =
478  absl::AnyInvocable<void(absl::StatusOr<std::vector<std::string>>)>;
479 
480  virtual ~DNSResolver() = default;
481 
492  virtual void LookupHostname(LookupHostnameCallback on_resolve,
493  absl::string_view name,
494  absl::string_view default_port) = 0;
499  virtual void LookupSRV(LookupSRVCallback on_resolve,
500  absl::string_view name) = 0;
505  virtual void LookupTXT(LookupTXTCallback on_resolve,
506  absl::string_view name) = 0;
507  };
508 
516  virtual ~EventEngine() = default;
517 
518  // TODO(nnoble): consider whether we can remove this method before we
519  // de-experimentalize this API.
520  virtual bool IsWorkerThread() = 0;
521 
527  virtual absl::StatusOr<std::unique_ptr<DNSResolver>> GetDNSResolver(
528  const DNSResolver::ResolverOptions& options) = 0;
529 
539  virtual void Run(Closure* closure) = 0;
552  virtual void Run(absl::AnyInvocable<void()> closure) = 0;
564  virtual TaskHandle RunAfter(Duration when, Closure* closure) = 0;
579  virtual TaskHandle RunAfter(Duration when,
580  absl::AnyInvocable<void()> closure) = 0;
589  virtual bool Cancel(TaskHandle handle) = 0;
590 };
591 
601 // TODO(hork): delete once all known users have migrated away
603  absl::AnyInvocable<std::shared_ptr<EventEngine>()> factory);
604 
611 //
612 // TODO(hork): delete once all known users have migrated away
614 
616 std::shared_ptr<EventEngine> CreateEventEngine();
617 
627 void SetDefaultEventEngine(std::shared_ptr<EventEngine> engine);
628 
637 std::shared_ptr<EventEngine> GetDefaultEventEngine();
638 
651 
652 bool operator==(const EventEngine::TaskHandle& lhs,
653  const EventEngine::TaskHandle& rhs);
654 bool operator!=(const EventEngine::TaskHandle& lhs,
655  const EventEngine::TaskHandle& rhs);
656 std::ostream& operator<<(std::ostream& out,
657  const EventEngine::TaskHandle& handle);
659  const EventEngine::ConnectionHandle& rhs);
661  const EventEngine::ConnectionHandle& rhs);
662 std::ostream& operator<<(std::ostream& out,
663  const EventEngine::ConnectionHandle& handle);
664 
665 namespace detail {
666 std::string FormatHandleString(uint64_t key1, uint64_t key2);
667 }
668 
669 template <typename Sink>
670 void AbslStringify(Sink& out, const EventEngine::ConnectionHandle& handle) {
671  out.Append(detail::FormatHandleString(handle.keys[0], handle.keys[1]));
672 }
673 
674 template <typename Sink>
675 void AbslStringify(Sink& out, const EventEngine::TaskHandle& handle) {
676  out.Append(detail::FormatHandleString(handle.keys[0], handle.keys[1]));
677 }
678 
679 } // namespace experimental
680 } // namespace grpc_event_engine
681 
682 #endif // GRPC_EVENT_ENGINE_EVENT_ENGINE_H
grpc_event_engine::experimental::EventEngine::Endpoint::GetMetricName
virtual std::optional< absl::string_view > GetMetricName(size_t key)=0
Returns the name of the write metric with the given key.
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:382
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::WriteMetric
An output WriteMetric consists of a key and a value.
Definition: event_engine.h:239
grpc_event_engine::experimental::EventEngine::ConnectionHandle
A handle to a cancellable connection attempt.
Definition: event_engine.h:143
port.h
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSet
std::bitset< static_cast< int >(WriteEvent::kCount)> WriteEventSet
Definition: event_engine.h:247
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::TakeMetricsSink
std::optional< WriteEventSink > TakeMetricsSink()
Definition: event_engine.h:297
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:240
grpc_event_engine::experimental::EventEngine::ResolvedAddress::MAX_SIZE_BYTES
static constexpr socklen_t MAX_SIZE_BYTES
Definition: event_engine.h:156
grpc_event_engine::experimental::EventEngine::Endpoint::AllWriteMetrics
virtual std::vector< size_t > AllWriteMetrics()=0
Returns the list of write metrics that the endpoint supports.
extensible.h
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()
Definition: event_engine.h:276
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:390
grpc_event_engine::experimental::EventEngine
The EventEngine Interface.
Definition: event_engine.h:106
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::EventEngine::Endpoint::GetMetricKey
virtual std::optional< size_t > GetMetricKey(absl::string_view name)=0
Returns the key of the write metric with the given name.
grpc_event_engine::experimental::AbslStringify
void AbslStringify(Sink &out, const EventEngine::ConnectionHandle &handle)
Definition: event_engine.h:670
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::set_metrics_sink
void set_metrics_sink(WriteEventSink sink)
Definition: event_engine.h:305
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink
Definition: event_engine.h:252
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:475
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventCallback
absl::AnyInvocable< void(WriteEvent, absl::Time, std::vector< WriteMetric >) const > WriteEventCallback
Definition: event_engine.h:244
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::port
int port
Definition: event_engine.h:465
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::DNSResolver::SRVRecord::host
std::string host
Definition: event_engine.h:464
grpc_event_engine::experimental::EventEngine::ConnectionHandle::keys
intptr_t keys[2]
Definition: event_engine.h:144
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::has_metrics_sink
bool has_metrics_sink() const
Definition: event_engine.h:303
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:472
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:288
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::requested_metrics
absl::Span< const size_t > requested_metrics() const
Definition: event_engine.h:264
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:317
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:327
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:241
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:457
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord
DNS SRV record type.
Definition: event_engine.h:463
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:154
grpc_event_engine::experimental::EventEngine::Listener
Listens for incoming connection requests from gRPC clients and initiates request processing once conn...
Definition: event_engine.h:386
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:121
grpc_event_engine::experimental::EventEngine::Closure::Closure
Closure()=default
grpc_event_engine::experimental::EventEngine::ResolvedAddress::ResolvedAddress
ResolvedAddress()=default
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:272
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:460
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::weight
int weight
Definition: event_engine.h:467
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::Closure::Run
virtual void Run()=0
grpc_event_engine::experimental::EventEngine::DNSResolver
Provides asynchronous resolution.
Definition: event_engine.h:454
grpc_event_engine::experimental::EventEngine::Endpoint::WriteArgs::GetDeprecatedAndDiscouragedGoogleSpecificPointer
void * GetDeprecatedAndDiscouragedGoogleSpecificPointer()
Definition: event_engine.h:313
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:136
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:186
grpc_event_engine::experimental::EventEngine::DNSResolver::SRVRecord::priority
int priority
Definition: event_engine.h:466
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:199
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::WriteEventSink
WriteEventSink(absl::Span< const size_t > requested_metrics, std::initializer_list< WriteEvent > requested_events, WriteEventCallback on_event)
Definition: event_engine.h:254
std
Definition: async_unary_call.h:406
grpc_event_engine::experimental::EventEngine::TaskHandle::kInvalid
static const GRPC_DLL TaskHandle kInvalid
Definition: event_engine.h:138
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:325
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:478
grpc_event_engine::experimental::EventEngine::Endpoint::WriteEventSink::requested_event
bool requested_event(WriteEvent event) const
Definition: event_engine.h:268
grpc_event_engine::experimental::EventEngine::ConnectionHandle::kInvalid
static const GRPC_DLL ConnectionHandle kInvalid
Definition: event_engine.h:145
grpc_event_engine::experimental::EventEngine::Endpoint::ReadArgs::read_hint_bytes
int64_t read_hint_bytes() const
Definition: event_engine.h:202
grpc_event_engine::experimental::EventEngine::Endpoint
One end of a connection between a gRPC client and server.
Definition: event_engine.h:177
grpc_event_engine::experimental::MemoryAllocator
Definition: memory_allocator.h:33
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::TaskHandle::keys
intptr_t keys[2]
Definition: event_engine.h:137
endpoint_config.h
grpc_event_engine::experimental::EventEngine::Listener::~Listener
virtual ~Listener()=default
grpc::protobuf::util::Status
::absl::Status Status
Definition: config_protobuf.h:107
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:113
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