tree: 917e6c26173ab34748f251145710443425d3bb90 [path history] [tgz]
  1. BUILD.gn
  2. DEPS
  3. DESIGN.md
  4. OWNERS
  5. README.md
  6. adaptation/
  7. array_view.h
  8. array_view_unittest.cc
  9. async_resolver_factory.h
  10. audio/
  11. audio_codecs/
  12. audio_options.cc
  13. audio_options.h
  14. call/
  15. candidate.cc
  16. candidate.h
  17. create_peerconnection_factory.cc
  18. create_peerconnection_factory.h
  19. crypto/
  20. crypto_params.h
  21. data_channel_interface.cc
  22. data_channel_interface.h
  23. dtls_transport_interface.cc
  24. dtls_transport_interface.h
  25. dtmf_sender_interface.h
  26. fec_controller.h
  27. fec_controller_override.h
  28. frame_transformer_interface.h
  29. function_view.h
  30. function_view_unittest.cc
  31. ice_transport_factory.cc
  32. ice_transport_factory.h
  33. ice_transport_interface.h
  34. jsep.cc
  35. jsep.h
  36. jsep_ice_candidate.cc
  37. jsep_ice_candidate.h
  38. jsep_session_description.h
  39. media_stream_interface.cc
  40. media_stream_interface.h
  41. media_stream_proxy.h
  42. media_stream_track_proxy.h
  43. media_types.cc
  44. media_types.h
  45. neteq/
  46. network_state_predictor.h
  47. notifier.h
  48. numerics/
  49. packet_socket_factory.h
  50. peer_connection_factory_proxy.h
  51. peer_connection_interface.cc
  52. peer_connection_interface.h
  53. peer_connection_proxy.h
  54. priority.h
  55. proxy.cc
  56. proxy.h
  57. ref_counted_base.h
  58. rtc_error.cc
  59. rtc_error.h
  60. rtc_error_unittest.cc
  61. rtc_event_log/
  62. rtc_event_log_output.h
  63. rtc_event_log_output_file.cc
  64. rtc_event_log_output_file.h
  65. rtc_event_log_output_file_unittest.cc
  66. rtp_headers.cc
  67. rtp_headers.h
  68. rtp_packet_info.cc
  69. rtp_packet_info.h
  70. rtp_packet_info_unittest.cc
  71. rtp_packet_infos.h
  72. rtp_packet_infos_unittest.cc
  73. rtp_parameters.cc
  74. rtp_parameters.h
  75. rtp_parameters_unittest.cc
  76. rtp_receiver_interface.cc
  77. rtp_receiver_interface.h
  78. rtp_sender_interface.cc
  79. rtp_sender_interface.h
  80. rtp_transceiver_direction.h
  81. rtp_transceiver_interface.cc
  82. rtp_transceiver_interface.h
  83. scoped_refptr.h
  84. scoped_refptr_unittest.cc
  85. sctp_transport_interface.cc
  86. sctp_transport_interface.h
  87. set_local_description_observer_interface.h
  88. set_remote_description_observer_interface.h
  89. stats/
  90. stats_types.cc
  91. stats_types.h
  92. task_queue/
  93. test/
  94. transport/
  95. turn_customizer.h
  96. uma_metrics.h
  97. units/
  98. video/
  99. video_codecs/
  100. video_track_source_proxy.h
  101. voip/
api/README.md

How to write code in the api/ directory

Mostly, just follow the regular style guide, but:

  • Note that api/ code is not exempt from the “.h and .cc files come in pairs” rule, so if you declare something in api/path/to/foo.h, it should be defined in api/path/to/foo.cc.
  • Headers in api/ should, if possible, not #include headers outside api/. It’s not always possible to avoid this, but be aware that it adds to a small mountain of technical debt that we’re trying to shrink.
  • .cc files in api/, on the other hand, are free to #include headers outside api/.

That is, the preferred way for api/ code to access non-api/ code is to call it from a .cc file, so that users of our API headers won’t transitively #include non-public headers.

For headers in api/ that need to refer to non-public types, forward declarations are often a lesser evil than including non-public header files. The usual rules still apply, though.

.cc files in api/ should preferably be kept reasonably small. If a substantial implementation is needed, consider putting it with our non-public code, and just call it from the api/ .cc file.