external/bsd/libevent/man/http_compat.h.3

   1 .TH "event2/http_compat.h" 3 "Tue Jan 27 2015" "libevent" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 event2/http_compat.h \-
   6 .PP
   7 Potentially non-threadsafe versions of the functions in \fBhttp\&.h\fP: provided only for backwards compatibility\&.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 \fC#include <event2/event-config\&.h>\fP
  13 .br
  14 \fC#include <event2/util\&.h>\fP
  15 .br
  16
  17 .SS "Macros"
  18
  19 .in +1c
  20 .ti -1c
  21 .RI "#define \fBevhttp_request_uri\fP   \fBevhttp_request_get_uri\fP"
  22 .br
  23 .RI "\fIReturns the request URI\&. \fP"
  24 .in -1c
  25 .SS "Functions"
  26
  27 .in +1c
  28 .ti -1c
  29 .RI "struct evhttp_connection * \fBevhttp_connection_new\fP (const char *address, unsigned short port)"
  30 .br
  31 .RI "\fIA connection object that can be used to for making HTTP requests\&. \fP"
  32 .ti -1c
  33 .RI "void \fBevhttp_connection_set_base\fP (struct evhttp_connection *evcon, struct \fBevent_base\fP *base)"
  34 .br
  35 .RI "\fIAssociates an event base with the connection - can only be called on a freshly created connection object that has not been used yet\&. \fP"
  36 .ti -1c
  37 .RI "struct evhttp * \fBevhttp_start\fP (const char *address, unsigned short port)"
  38 .br
  39 .RI "\fIStart an HTTP server on the specified address and port\&. \fP"
  40 .in -1c
  41 .SH "Detailed Description"
  42 .PP
  43 Potentially non-threadsafe versions of the functions in \fBhttp\&.h\fP: provided only for backwards compatibility\&.
  44
  45
  46 .SH "Function Documentation"
  47 .PP
  48 .SS "struct evhttp_connection* evhttp_connection_new (const char *address, unsigned shortport)"
  49
  50 .PP
  51 A connection object that can be used to for making HTTP requests\&. The connection object tries to establish the connection when it is given an http request object\&.
  52 .PP
  53 \fBDeprecated\fP
  54 .RS 4
  55 It does not allow an event base to be specified
  56 .RE
  57 .PP
  58
  59 .SS "void evhttp_connection_set_base (struct evhttp_connection *evcon, struct \fBevent_base\fP *base)"
  60
  61 .PP
  62 Associates an event base with the connection - can only be called on a freshly created connection object that has not been used yet\&.
  63 .PP
  64 \fBDeprecated\fP
  65 .RS 4
  66 XXXX Why?
  67 .RE
  68 .PP
  69
  70 .SS "struct evhttp* evhttp_start (const char *address, unsigned shortport)"
  71
  72 .PP
  73 Start an HTTP server on the specified address and port\&.
  74 .PP
  75 \fBDeprecated\fP
  76 .RS 4
  77 It does not allow an event base to be specified
  78 .RE
  79 .PP
  80 .PP
  81 \fBParameters:\fP
  82 .RS 4
  83 \fIaddress\fP the address to which the HTTP server should be bound
  84 .br
  85 \fIport\fP the port number on which the HTTP server should listen
  86 .RE
  87 .PP
  88 \fBReturns:\fP
  89 .RS 4
  90 an struct evhttp object
  91 .RE
  92 .PP
  93
  94 .SH "Author"
  95 .PP
  96 Generated automatically by Doxygen for libevent from the source code\&.