Commit 60674c11 authored by Sergey Lyubka's avatar Sergey Lyubka

API docs regarding MG_POLL changed

parent 91c9ab80
...@@ -71,16 +71,16 @@ occur. Sequence of events for the accepted connection is this: ...@@ -71,16 +71,16 @@ occur. Sequence of events for the accepted connection is this:
certain prefix, and let Mongoose serve all static files. certain prefix, and let Mongoose serve all static files.
If event handler decides to serve the request, but doesn't have If event handler decides to serve the request, but doesn't have
all the data at the moment, it should return `MG_MORE`. That tells all the data at the moment, it should return `MG_MORE`. That tells
Mongoose to send `MG_POLL` events on each iteration of `mg_poll_server()` Mongoose to keep the connection open after callback returns.
`mg_connection::connection_param` pointer is a placeholder to keep `mg_connection::connection_param` pointer is a placeholder to keep
user-specific data. For example, handler could decide to open a DB user-specific data. For example, handler could decide to open a DB
connection and store DB connection handle in `connection_param`. connection and store DB connection handle in `connection_param`.
* `MG_POLL` is sent only to those connections which returned `MG_MORE`. * `MG_POLL` is sent to every connection on every iteration of
Event handler should try to complete the reply. If reply is completed, `mg_poll_server()`. Event handler should return `MG_FALSE` to ignore
then event handler should return `MG_TRUE`. Otherwise, it should this event. If event handler returns `MG_TRUE`, then Mongoose assumes
return `MG_FALSE`, and polling will continue until that event handler has finished sending data, and Mongoose will
handler returns `MG_TRUE`. close the connection.
* `MG_HTTP_ERROR` sent when Mongoose is about to send HTTP error back * `MG_HTTP_ERROR` sent when Mongoose is about to send HTTP error back
to the client. Event handler can choose to send a reply itself, in which to the client. Event handler can choose to send a reply itself, in which
case event handler must return `MG_TRUE`. Otherwise, event handler must case event handler must return `MG_TRUE`. Otherwise, event handler must
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment