grpc_posix.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. /*
  2. *
  3. * Copyright 2016 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. #ifndef GRPC_GRPC_POSIX_H
  19. #define GRPC_GRPC_POSIX_H
  20. #include <grpc/support/port_platform.h>
  21. #include <stddef.h>
  22. #include <grpc/impl/codegen/grpc_types.h>
  23. #ifdef __cplusplus
  24. extern "C" {
  25. #endif
  26. /*! \mainpage GRPC Core POSIX
  27. *
  28. * The GRPC Core POSIX library provides some POSIX-specific low-level
  29. * functionality on top of GRPC Core.
  30. */
  31. /** Create a client channel to 'target' using file descriptor 'fd'. The 'target'
  32. argument will be used to indicate the name for this channel. See the comment
  33. for grpc_insecure_channel_create for description of 'args' argument. */
  34. GRPCAPI grpc_channel* grpc_insecure_channel_create_from_fd(
  35. const char* target, int fd, const grpc_channel_args* args);
  36. /** Add the connected communication channel based on file descriptor 'fd' to the
  37. 'server'. The 'fd' must be an open file descriptor corresponding to a
  38. connected socket. Events from the file descriptor may come on any of the
  39. server completion queues (i.e completion queues registered via the
  40. grpc_server_register_completion_queue API).
  41. The 'reserved' pointer MUST be NULL.
  42. TODO(hork): add channel_args to this API to allow endpoints and transports
  43. created in this function to participate in the resource quota feature.
  44. */
  45. GRPCAPI void grpc_server_add_insecure_channel_from_fd(grpc_server* server,
  46. void* reserved, int fd);
  47. #ifdef __cplusplus
  48. }
  49. #endif
  50. #endif /* GRPC_GRPC_POSIX_H */