tree: 279680563254460b8c904ab9e168057cc9207f4e [path history] [tgz]
  1. BUILD.gn
  2. DEPS
  3. OWNERS
  4. README.md
  5. adaptation/
  6. array_view.h
  7. array_view_unittest.cc
  8. async_dns_resolver.h
  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. g3doc/
  32. ice_transport_factory.cc
  33. ice_transport_factory.h
  34. ice_transport_interface.h
  35. jsep.cc
  36. jsep.h
  37. jsep_ice_candidate.cc
  38. jsep_ice_candidate.h
  39. jsep_session_description.h
  40. media_stream_interface.cc
  41. media_stream_interface.h
  42. media_stream_track.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_interface.cc
  51. peer_connection_interface.h
  52. priority.h
  53. ref_counted_base.h
  54. rtc_error.cc
  55. rtc_error.h
  56. rtc_error_unittest.cc
  57. rtc_event_log/
  58. rtc_event_log_output.h
  59. rtc_event_log_output_file.cc
  60. rtc_event_log_output_file.h
  61. rtc_event_log_output_file_unittest.cc
  62. rtp_headers.cc
  63. rtp_headers.h
  64. rtp_packet_info.cc
  65. rtp_packet_info.h
  66. rtp_packet_info_unittest.cc
  67. rtp_packet_infos.h
  68. rtp_packet_infos_unittest.cc
  69. rtp_parameters.cc
  70. rtp_parameters.h
  71. rtp_parameters_unittest.cc
  72. rtp_receiver_interface.cc
  73. rtp_receiver_interface.h
  74. rtp_sender_interface.cc
  75. rtp_sender_interface.h
  76. rtp_transceiver_direction.h
  77. rtp_transceiver_interface.cc
  78. rtp_transceiver_interface.h
  79. scoped_refptr.h
  80. scoped_refptr_unittest.cc
  81. sctp_transport_interface.cc
  82. sctp_transport_interface.h
  83. sequence_checker.h
  84. sequence_checker_unittest.cc
  85. set_local_description_observer_interface.h
  86. set_remote_description_observer_interface.h
  87. stats/
  88. stats_types.cc
  89. stats_types.h
  90. task_queue/
  91. test/
  92. transport/
  93. turn_customizer.h
  94. uma_metrics.h
  95. units/
  96. video/
  97. video_codecs/
  98. video_track_source_proxy_factory.h
  99. 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.