GRPC C++  1.26.0
endpoint.h
Go to the documentation of this file.
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 
23 
24 #include <grpc/slice.h>
25 #include <grpc/slice_buffer.h>
26 #include <grpc/support/time.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 
36 class Timestamps;
37 
39  void (*read)(grpc_endpoint* ep, grpc_slice_buffer* slices, grpc_closure* cb,
40  bool urgent);
42  void* arg);
43  void (*add_to_pollset)(grpc_endpoint* ep, grpc_pollset* 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);
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. */
60  grpc_closure* cb, bool urgent);
61 
63 
64 /* Get the file descriptor used by \a ep. Return -1 if \a ep is not using an fd.
65  */
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  */
81  grpc_closure* cb, void* arg);
82 
83 /* Causes any pending and future read/write callbacks to run immediately with
84  success==0 */
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 */
92  grpc_pollset_set* pollset_set);
93 
94 /* Delete an endpoint from a pollset_set */
96  grpc_pollset_set* pollset_set);
97 
99 
101 
104 };
105 
106 #endif /* GRPC_CORE_LIB_IOMGR_ENDPOINT_H */
void(* read)(grpc_endpoint *ep, grpc_slice_buffer *slices, grpc_closure *cb, bool urgent)
Definition: endpoint.h:39
void(* delete_from_pollset_set)(grpc_endpoint *ep, grpc_pollset_set *pollset)
Definition: endpoint.h:45
void grpc_endpoint_shutdown(grpc_endpoint *ep, grpc_error *why)
int grpc_endpoint_get_fd(grpc_endpoint *ep)
void grpc_endpoint_read(grpc_endpoint *ep, grpc_slice_buffer *slices, grpc_closure *cb, bool urgent)
Definition: error_internal.h:39
void grpc_endpoint_destroy(grpc_endpoint *ep)
Represents an expandable array of slices, to be interpreted as a single item.
Definition: slice.h:78
char * grpc_endpoint_get_peer(grpc_endpoint *ep)
void(* write)(grpc_endpoint *ep, grpc_slice_buffer *slices, grpc_closure *cb, void *arg)
Definition: endpoint.h:41
void(* shutdown)(grpc_endpoint *ep, grpc_error *why)
Definition: endpoint.h:46
struct grpc_resource_user grpc_resource_user
Definition: resource_quota.h:87
void(* destroy)(grpc_endpoint *ep)
Definition: endpoint.h:47
const grpc_endpoint_vtable * vtable
Definition: endpoint.h:103
void(* add_to_pollset)(grpc_endpoint *ep, grpc_pollset *pollset)
Definition: endpoint.h:43
Definition: endpoint.h:38
void grpc_endpoint_add_to_pollset_set(grpc_endpoint *ep, grpc_pollset_set *pollset_set)
struct grpc_pollset_set grpc_pollset_set
Definition: pollset_set.h:31
void(* add_to_pollset_set)(grpc_endpoint *ep, grpc_pollset_set *pollset)
Definition: endpoint.h:44
struct grpc_pollset grpc_pollset
Definition: pollset.h:38
A closure over a grpc_iomgr_cb_func.
Definition: closure.h:56
void grpc_endpoint_add_to_pollset(grpc_endpoint *ep, grpc_pollset *pollset)
void grpc_endpoint_write(grpc_endpoint *ep, grpc_slice_buffer *slices, grpc_closure *cb, void *arg)
Definition: endpoint.h:102
void grpc_endpoint_delete_from_pollset_set(grpc_endpoint *ep, grpc_pollset_set *pollset_set)
grpc_resource_user * grpc_endpoint_get_resource_user(grpc_endpoint *endpoint)
bool grpc_endpoint_can_track_err(grpc_endpoint *ep)
int(* get_fd)(grpc_endpoint *ep)
Definition: endpoint.h:50
bool(* can_track_err)(grpc_endpoint *ep)
Definition: endpoint.h:51