From 0e8c8e56f4c44e4129a8b78992f1eb8d8c81aaa4 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 16 Jun 2016 12:28:30 +0200 Subject: intes: Remove Xmllint errors --- lib/inets/doc/src/mod_esi.xml | 155 +++++++++++++++++++++--------------------- 1 file changed, 79 insertions(+), 76 deletions(-) (limited to 'lib') diff --git a/lib/inets/doc/src/mod_esi.xml b/lib/inets/doc/src/mod_esi.xml index deef010e54..8279fdc824 100644 --- a/lib/inets/doc/src/mod_esi.xml +++ b/lib/inets/doc/src/mod_esi.xml @@ -42,8 +42,7 @@ env() =

{EnvKey()::atom(), Value::term()}

- - +

Currently supported key value pairs

@@ -59,11 +58,12 @@ {server_protocol, string()}

HTTP version, currently "HTTP/1.1"

 - {server_port, integer()} + {server_port, integer()}

Servers port number.

 {request_method, "GET | "PUT" | "DELETE | "POST" | "PATCH"} - +

HTTP request method.

 + {remote_adress, inet:ip_address()}

The clients ip address.

 @@ -81,94 +81,97 @@ {http_LowerCaseHTTPHeaderName, string()}

example: {http_content_type, "text/html"}

 - - + + + - - - deliver(SessionID, Data) -> ok | {error, Reason} - Sends Data back to client. - + + + deliver(SessionID, Data) -> ok | {error, Reason} + Sends Data back to client. + SessionID = term() Data = string() | io_list() | binary() Reason = term() - - - -

This function is only intended to be used from - functions called by the Erl Scheme interface to deliver - parts of the content to the user.

-

Sends data from an Erl Scheme script back to the client.

+ + + +

This function is only intended to be used from + functions called by the Erl Scheme interface to deliver + parts of the content to the user.

+

Sends data from an Erl Scheme script back to the client.

- -

If any HTTP header fields are added by the - script, they must be in the first call to deliver/2, - and the data in the call must be a string. Calls after the headers - are complete can contain binary data to reduce copying - overhead. Do not assume anything about the data type of - SessionID. SessionID must be the value given - as input to the ESI callback function that you implemented.

- - - - - -
- ESI Callback Functions -
- - - Module:Function(SessionID, Env, Input)-> _ - Creates a dynamic web page and returns it chunk by chunk - to the server process by calling mod_esi:deliver/2. - - SessionID = term() - Env = env() - Input = string() - + +

If any HTTP header fields are added by the + script, they must be in the first call to deliver/2, + and the data in the call must be a string. Calls after the headers + are complete can contain binary data to reduce copying + overhead. Do not assume anything about the data type of + SessionID. SessionID must be the value given + as input to the ESI callback function that you implemented.

+ + + + + +
+ ESI Callback Functions +
+ + + + Module:Function(SessionID, Env, Input)-> _ + Creates a dynamic web page and returns it chunk by chunk + to the server process by calling mod_esi:deliver/2. + + SessionID = term() + Env = env() + Input = string() +

Module must be found in the code path and export - Function with an arity of three. An erlScriptAlias must - also be set up in the configuration file for the web server.

+ Function with an arity of three. An erlScriptAlias must + also be set up in the configuration file for the web server.

If the HTTP request is a 'post' request and a body is sent, - content_length is the length of the posted - data. If 'get' is used, query_string is the data after - ? in the URL.

+ content_length is the length of the posted + data. If 'get' is used, query_string is the data after + ? in the URL.

ParsedHeader is the HTTP request as a key-value tuple - list. The keys in ParsedHeader are in lower case.

+ list. The keys in ParsedHeader are in lower case.

SessionID is an identifier - the server uses when deliver/2 is called. Do not - assume anything about the datatype.

+ the server uses when deliver/2 is called. Do not + assume anything about the datatype.

Use this callback function to generate dynamic web - content dynamically. When a part of the page is generated, send the - data back to the client through deliver/2. Notice - that the first chunk of data sent to the client must at - least contain all HTTP header fields that the response - will generate. If the first chunk does not contain the - end of HTTP header, that is, "\r\n\r\n", - the server assumes that no HTTP header fields will be generated.

+ content dynamically. When a part of the page is generated, send the + data back to the client through deliver/2. Notice + that the first chunk of data sent to the client must at + least contain all HTTP header fields that the response + will generate. If the first chunk does not contain the + end of HTTP header, that is, "\r\n\r\n", + the server assumes that no HTTP header fields will be generated.

 - - - Module:Function(Env, Input)-> Response - Creates a dynamic web page and returns it as a list. - This function is deprecated and is only kept for backwards compatibility. - - Env = env() - Input = string() - Response = string() - + + + + Module:Function(Env, Input)-> Response + Creates a dynamic web page and returns it as a list. + This function is deprecated and is only kept for backwards compatibility. + + Env = env() + Input = string() + Response = string() +

This callback format consumes much memory, as the - whole response must be generated before it is sent to the - user. This function is deprecated and is only kept for backwards - compatibility. - For new development, use Module:Function/3.

+ whole response must be generated before it is sent to the + user. This function is deprecated and is only kept for backwards + compatibility. + For new development, use Module:Function/3.

 - - - + + + -- cgit v1.2.3