PageRenderTime 49ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/doc/t-error.htm

https://bitbucket.org/marto1/udtwrap
HTML | 48 lines | 42 code | 6 blank | 0 comment | 0 complexity | 871d044ea9a5c6945f750000fcd1a7bf MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    5. 

  5. <title>Introduction</title>
    6. 

  6. <link rel="stylesheet" href="udtdoc.css" type="text/css" />
    7. 

  7. </head>
    8. 

  8. 

  9. <body>
    10. 

  10. <div class="ref_head">&nbsp;UDT Tutorial</div>
    11. 

  11. 

  12. <h3><font color="#000080">Error Handling</font></h3>
    13. 

  13. <p>All UDT API will return an error upon a failed operation. Particularly, UDT defines UDT::INVALID_SOCK and UDT::ERROR as error returned values. Application should check the return 
    14. 

  14. value against these two constants (several routine return false as error value).</p>
    15. 

  15. 

  16. <p>On error, <a href="error.htm"><strong>getlasterror</strong></a> can be used to retrieve the error information. In fact, the function returns the latest error occurred in the thread where the function is called. <a href="error.htm"><strong>getlasterror</strong></a> returns an <a href="structure.htm"><strong>ERRORINFO</strong></a> structure, it contains both the error code and special text error message. Two helper functions of <a href="structure.htm"><strong>getErrorCode</strong></a> and <a href="structure.htm"><strong>getErrorMessage</strong></a> can be used to read these 
    17. 

  17. information.</p>
    18. 

  18. <p>The UDT error information is thread local (that is, an error in another thread will not affect the error information in the current thread). The returned value is a reference to the UDT internal error structure.</p>
    19. 

  19. <p>Note that a successful call will NOT clear the error. Therefore, applications should use the return value of a UDT API to check the result of a UDT call. <a href="error.htm"><strong>getlasterror</strong></a> only provides detailed information when necessary. However, application can use <strong>getlasterror().<a href="structure.htm">clear()</a></strong> to clear the previously logged error if needed. </p>
    20. 

  20. <p><strong>Example</strong>: check UDT::bind error.</p>
    21. 

  21. <div class="code">
    22. 

  22. sockaddr_in my_addr;<br>
    23. 

  23. my_addr.sin_family = AF_INET;<br>
    24. 

  24. my_addr.sin_port = htons(21); //invalid port number<br>
    25. 

  25. my_addr.sin_addr.s_addr = INADDR_ANY;<br>
    26. 

  26. memset(&(my_addr.sin_zero), '\0', 8);<br>
    27. 

  27. <br>
    28. 

  28. UDTSOCKET serv = UDT::socket(AF_INET, SOCK_STREAM, 0);<br>
    29. 

  29. if (UDT::ERROR == UDT::bind(serv, (sockaddr*)&my_addr, sizeof(my_addr)))<br>
    30. 

  30. {<br>
    31. 

  31. &nbsp;&nbsp;cout << "bind: " << UDT::getlasterror().getErrorMessage();<br>
    32. 

  32. &nbsp;&nbsp;// further action may depends on UDT::getlasterror().getErrorCode().<br>
    33. 

  33. &nbsp;&nbsp;// system level error can be accessed through "errno"<br>
    34. 

  34. &nbsp;&nbsp;return 0;<br>
    35. 

  35. }
    36. 

  36. </div>
    37. 

  37. 

  38. <p>In the example above, the output will be:</p>
    39. 

  39. <div class="code">
    40. 

  40. error message: Couldn't set up network connection: Permission denied.
    41. 

  41. </div>
    42. 

  42. 

  43. <p>The UDT error code only reflects the operation error of the UDT socket level. Applications can still read the system level error (e.g., <u>errno</u> in Linux, <u>GetLastError</u> in Windows) to read 
    44. 

  44. more specific error information. However, the error message obtained by getErrorMessage contains information of both the UDT level error and the system level error.</p>
    45. 

  45. 

  46. <p>&nbsp;</p>
    47. 

  47. </body>
    48. 

  48. </html>
    49. 

  49.