libaria2.rst 741 B

12345678910111213141516171819202122232425262728
  1. .. default-domain:: cpp
  2. .. highlight:: cpp
  3. libaria2: C++ library interface to aria2
  4. ========================================
  5. .. Warning::
  6. The API has not been frozen yet. It will be changed on the course of
  7. the development.
  8. The libaria2 is a C++ library and offers the core functionality of
  9. aria2. The library takes care of all networking and downloading stuff,
  10. so its usage is very straight forward right now. See *libaria2ex.cc*
  11. in *examples* directory to see how to use API.
  12. API Reference
  13. -------------
  14. To use the API function, include ``aria2/aria2.h``::
  15. #include <aria2/aria2.h>
  16. All enums, types and functions are under ``aria2`` namespace. To link
  17. with libaria2, use linker flag ``-laria2``.
  18. .. include:: libaria2api