legacy-libs/grpc-cloned/deps/grpc/src/core/lib/iomgr/endpoint.h

   1 /*
   2  *
   3  * Copyright 2015 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_LIB_IOMGR_ENDPOINT_H
  20 #define GRPC_CORE_LIB_IOMGR_ENDPOINT_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <grpc/slice.h>
  25 #include <grpc/slice_buffer.h>
  26 #include <grpc/support/time.h>
  27 #include "src/core/lib/iomgr/pollset.h"
  28 #include "src/core/lib/iomgr/pollset_set.h"
  29 #include "src/core/lib/iomgr/resource_quota.h"
  30
  31 /* An endpoint caps a streaming channel between two communicating processes.
  32    Examples may be: a tcp socket, <stdin+stdout>, or some shared memory. */
  33
  34 typedef struct grpc_endpoint grpc_endpoint;
  35 typedef struct grpc_endpoint_vtable grpc_endpoint_vtable;
  36 class Timestamps;
  37
  38 struct grpc_endpoint_vtable {
  39   void (*read)(grpc_endpoint* ep, grpc_slice_buffer* slices, grpc_closure* cb,
  40                bool urgent);
  41   void (*write)(grpc_endpoint* ep, grpc_slice_buffer* slices, grpc_closure* cb,
  42                 void* arg);
  43   void (*add_to_pollset)(grpc_endpoint* ep, grpc_pollset* pollset);
  44   void (*add_to_pollset_set)(grpc_endpoint* ep, grpc_pollset_set* pollset);
  45   void (*delete_from_pollset_set)(grpc_endpoint* ep, grpc_pollset_set* pollset);
  46   void (*shutdown)(grpc_endpoint* ep, grpc_error* why);
  47   void (*destroy)(grpc_endpoint* ep);
  48   grpc_resource_user* (*get_resource_user)(grpc_endpoint* ep);
  49   char* (*get_peer)(grpc_endpoint* ep);
  50   int (*get_fd)(grpc_endpoint* ep);
  51   bool (*can_track_err)(grpc_endpoint* ep);
  52 };
  53
  54 /* When data is available on the connection, calls the callback with slices.
  55    Callback success indicates that the endpoint can accept more reads, failure
  56    indicates the endpoint is closed.
  57    Valid slices may be placed into \a slices even when the callback is
  58    invoked with error != GRPC_ERROR_NONE. */
  59 void grpc_endpoint_read(grpc_endpoint* ep, grpc_slice_buffer* slices,
  60                         grpc_closure* cb, bool urgent);
  61
  62 char* grpc_endpoint_get_peer(grpc_endpoint* ep);
  63
  64 /* Get the file descriptor used by \a ep. Return -1 if \a ep is not using an fd.
  65  */
  66 int grpc_endpoint_get_fd(grpc_endpoint* ep);
  67
  68 /* Write slices out to the socket.
  69
  70    If the connection is ready for more data after the end of the call, it
  71    returns GRPC_ENDPOINT_DONE.
  72    Otherwise it returns GRPC_ENDPOINT_PENDING and calls cb when the
  73    connection is ready for more data.
  74    \a slices may be mutated at will by the endpoint until cb is called.
  75    No guarantee is made to the content of slices after a write EXCEPT that
  76    it is a valid slice buffer.
  77    \a arg is platform specific. It is currently only used by TCP on linux
  78    platforms as an argument that would be forwarded to the timestamps callback.
  79    */
  80 void grpc_endpoint_write(grpc_endpoint* ep, grpc_slice_buffer* slices,
  81                          grpc_closure* cb, void* arg);
  82
  83 /* Causes any pending and future read/write callbacks to run immediately with
  84    success==0 */
  85 void grpc_endpoint_shutdown(grpc_endpoint* ep, grpc_error* why);
  86 void grpc_endpoint_destroy(grpc_endpoint* ep);
  87
  88 /* Add an endpoint to a pollset or pollset_set, so that when the pollset is
  89    polled, events from this endpoint are considered */
  90 void grpc_endpoint_add_to_pollset(grpc_endpoint* ep, grpc_pollset* pollset);
  91 void grpc_endpoint_add_to_pollset_set(grpc_endpoint* ep,
  92                                       grpc_pollset_set* pollset_set);
  93
  94 /* Delete an endpoint from a pollset_set */
  95 void grpc_endpoint_delete_from_pollset_set(grpc_endpoint* ep,
  96                                            grpc_pollset_set* pollset_set);
  97
  98 grpc_resource_user* grpc_endpoint_get_resource_user(grpc_endpoint* endpoint);
  99
 100 bool grpc_endpoint_can_track_err(grpc_endpoint* ep);
 101
 102 struct grpc_endpoint {
 103   const grpc_endpoint_vtable* vtable;
 104 };
 105
 106 #endif /* GRPC_CORE_LIB_IOMGR_ENDPOINT_H */