xref: /aosp_15_r20/external/grpc-grpc/include/grpc/grpc_posix.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker /*
2*cc02d7e2SAndroid Build Coastguard Worker  *
3*cc02d7e2SAndroid Build Coastguard Worker  * Copyright 2016 gRPC authors.
4*cc02d7e2SAndroid Build Coastguard Worker  *
5*cc02d7e2SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
6*cc02d7e2SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
7*cc02d7e2SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
8*cc02d7e2SAndroid Build Coastguard Worker  *
9*cc02d7e2SAndroid Build Coastguard Worker  *     http://www.apache.org/licenses/LICENSE-2.0
10*cc02d7e2SAndroid Build Coastguard Worker  *
11*cc02d7e2SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
12*cc02d7e2SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
13*cc02d7e2SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*cc02d7e2SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
15*cc02d7e2SAndroid Build Coastguard Worker  * limitations under the License.
16*cc02d7e2SAndroid Build Coastguard Worker  *
17*cc02d7e2SAndroid Build Coastguard Worker  */
18*cc02d7e2SAndroid Build Coastguard Worker 
19*cc02d7e2SAndroid Build Coastguard Worker #ifndef GRPC_GRPC_POSIX_H
20*cc02d7e2SAndroid Build Coastguard Worker #define GRPC_GRPC_POSIX_H
21*cc02d7e2SAndroid Build Coastguard Worker 
22*cc02d7e2SAndroid Build Coastguard Worker #include <stddef.h>
23*cc02d7e2SAndroid Build Coastguard Worker 
24*cc02d7e2SAndroid Build Coastguard Worker #include <grpc/grpc.h>
25*cc02d7e2SAndroid Build Coastguard Worker #include <grpc/impl/grpc_types.h>
26*cc02d7e2SAndroid Build Coastguard Worker #include <grpc/support/port_platform.h>
27*cc02d7e2SAndroid Build Coastguard Worker 
28*cc02d7e2SAndroid Build Coastguard Worker #ifdef __cplusplus
29*cc02d7e2SAndroid Build Coastguard Worker extern "C" {
30*cc02d7e2SAndroid Build Coastguard Worker #endif
31*cc02d7e2SAndroid Build Coastguard Worker 
32*cc02d7e2SAndroid Build Coastguard Worker /*! \mainpage GRPC Core POSIX
33*cc02d7e2SAndroid Build Coastguard Worker  *
34*cc02d7e2SAndroid Build Coastguard Worker  * The GRPC Core POSIX library provides some POSIX-specific low-level
35*cc02d7e2SAndroid Build Coastguard Worker  * functionality on top of GRPC Core.
36*cc02d7e2SAndroid Build Coastguard Worker  */
37*cc02d7e2SAndroid Build Coastguard Worker 
38*cc02d7e2SAndroid Build Coastguard Worker /** Create a secure channel to 'target' using file descriptor 'fd' and passed-in
39*cc02d7e2SAndroid Build Coastguard Worker     credentials. The 'target' argument will be used to indicate the name for
40*cc02d7e2SAndroid Build Coastguard Worker     this channel. Note that this API currently only supports insecure channel
41*cc02d7e2SAndroid Build Coastguard Worker     credentials. Using other types of credentials will result in a failure. */
42*cc02d7e2SAndroid Build Coastguard Worker GRPCAPI grpc_channel* grpc_channel_create_from_fd(
43*cc02d7e2SAndroid Build Coastguard Worker     const char* target, int fd, grpc_channel_credentials* creds,
44*cc02d7e2SAndroid Build Coastguard Worker     const grpc_channel_args* args);
45*cc02d7e2SAndroid Build Coastguard Worker 
46*cc02d7e2SAndroid Build Coastguard Worker /** Add the connected secure communication channel based on file descriptor 'fd'
47*cc02d7e2SAndroid Build Coastguard Worker    to the 'server' and server credentials 'creds'. The 'fd' must be an open file
48*cc02d7e2SAndroid Build Coastguard Worker    descriptor corresponding to a connected socket. Events from the file
49*cc02d7e2SAndroid Build Coastguard Worker    descriptor may come on any of the server completion queues (i.e completion
50*cc02d7e2SAndroid Build Coastguard Worker    queues registered via the grpc_server_register_completion_queue API).
51*cc02d7e2SAndroid Build Coastguard Worker    Note that this API currently only supports inseure server credentials
52*cc02d7e2SAndroid Build Coastguard Worker    Using other types of credentials will result in a failure.
53*cc02d7e2SAndroid Build Coastguard Worker    TODO(hork): add channel_args to this API to allow endpoints and transports
54*cc02d7e2SAndroid Build Coastguard Worker    created in this function to participate in the resource quota feature. */
55*cc02d7e2SAndroid Build Coastguard Worker GRPCAPI void grpc_server_add_channel_from_fd(grpc_server* server, int fd,
56*cc02d7e2SAndroid Build Coastguard Worker                                              grpc_server_credentials* creds);
57*cc02d7e2SAndroid Build Coastguard Worker 
58*cc02d7e2SAndroid Build Coastguard Worker #ifdef __cplusplus
59*cc02d7e2SAndroid Build Coastguard Worker }
60*cc02d7e2SAndroid Build Coastguard Worker #endif
61*cc02d7e2SAndroid Build Coastguard Worker 
62*cc02d7e2SAndroid Build Coastguard Worker #endif /* GRPC_GRPC_POSIX_H */
63