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