/thirdparty/libportfwd/README

http://github.com/tomahawk-player/tomahawk · #! · 29 lines · 22 code · 7 blank · 0 comment · 0 complexity · 98fa82b051f7e9ad3f291c5e260172c3 MD5 · raw file 

    

  1. libportfwd
    2. 

  2. ----------
    3. 

  3. A basic, lightweight c++ wrapper around miniupnp and nat-pmp libraries
    4. 

  4. for setting up port fwds, detecting max up/downstream bandwidth, and 
    5. 

  5. finding out external IP address.
    6. 

  6. 

  7. See: http://miniupnp.free.fr/
    8. 

  8. 

  9. Designed to wrap up miniupnpc+natpmp libs into a static lib with a small API
    10. 

  10. so other projects can easily setup port fwds without shipping extra libs/deps.
    11. 

  11. 

  12. Should detect any upnp or nat-pmp router and automatically use the appropriate
    13. 

  13. library under the hood.
    14. 

  14. 

  15. Uses cmake to build needed bits of miniupnpc.
    16. 

  16. 

  17. NB/TODO
    18. 

  18. -------
    19. 

  19. I don't have a nat-pmp capable device (eg: Airport Express)
    20. 

  20. so haven't implemented that bit yet. Only supports upnp atm.
    21. 

    22. 

  22. Usage
    23. 

  23. -----
    24. 

  24. See the demo in main.cpp, but here's the jist:
    25. 

    26. 

  26.  Portfwd pf;
    27. 

  27.  pf.init(2000);   // 2000 = ms to wait for response from router
    28. 

  28.  pf.add(1234);    // port to fwd to you
    29. 

  29.  pf.remove(1234); // remove port fwding on exit
    30.