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