ne_get_request_target.3 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. '\" t
  2. .\" Title: ne_get_request_target
  3. .\" Author:
  4. .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
  5. .\" Date: 15 April 2025
  6. .\" Manual: neon API reference
  7. .\" Source: neon 0.34.2
  8. .\" Language: English
  9. .\"
  10. .TH "NE_GET_REQUEST_TARGE" "3" "15 April 2025" "neon 0.34.2" "neon API reference"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. ne_get_request_target \- retrieve request target
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <ne_request\&.h>
  37. .fi
  38. .ft
  39. .HP \w'const\ ne_uri\ *ne_get_request_target('u
  40. .BI "const ne_uri *ne_get_request_target(ne_request\ *" "req" ");"
  41. .SH "DESCRIPTION"
  42. .PP
  43. The
  44. \fBne_get_request_target\fR
  45. returns the request target URI as a pointer to an
  46. ne_uri
  47. object\&. The "target resource" of a request is defined per
  48. \m[blue]\fBSection 7\&.1 of RFC 9110\fR\m[]\&\s-2\u[1]\d\s+2
  49. and is derived from the parameters used to create the request with
  50. ne_request_create
  51. and the parameters used to create the session with
  52. ne_session_create\&.
  53. .SH "RETURN VALUE"
  54. .PP
  55. The
  56. \fBne_get_request_target\fR
  57. function returns a
  58. ne_uri, or
  59. NULL
  60. if it was not possible to create the target URI\&. The latter can only occur if the path used to create the request object was not a valid URI path\&. Note that the
  61. \fIpath\fR
  62. field of the returned object can be the empty string if the
  63. authority\-form
  64. of the URI is used\&.
  65. .SH "HISTORY"
  66. .PP
  67. \fBne_get_request_target\fR
  68. is available in neon 0\&.34\&.0 and later\&.
  69. .SH "SEE ALSO"
  70. .PP
  71. ne_request_create,
  72. ne_session_create\&.
  73. .SH "COPYRIGHT"
  74. .br
  75. Copyright \(co 2001-2024 Joe Orton
  76. .br
  77. .SH "REFERENCES"
  78. .IP " 1." 4
  79. Section 7.1 of RFC 9110
  80. .RS 4
  81. \%https://www.rfc-editor.org/rfc/rfc9110.html#section-7.1
  82. .RE