mirror of
https://github.com/cesanta/mongoose.git
synced 2026-11-17 19:30:36 +00:00
Better API documentation
This commit is contained in:
1 parent
f0994896d5
commit
d4b14ca3c1
2 files changed
+7
-3
No files matched your search
+6
-2
@@ -84,10 +84,10 @@ occur. Sequence of events for the accepted connection is this:
|
|||||||
* `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
|
||||||
return `MG_FALSE`
|
return `MG_FALSE`.
|
||||||
* `MG_CLOSE` is sent when the connection is closed. This event is used
|
* `MG_CLOSE` is sent when the connection is closed. This event is used
|
||||||
to cleanup per-connection state stored in `connection_param`
|
to cleanup per-connection state stored in `connection_param`
|
||||||
if it was allocated.
|
if it was allocated. Event handler return value is ignored.
|
||||||
|
|
||||||
Sequence of events for the client connection is this:
|
Sequence of events for the client connection is this:
|
||||||
|
|
||||||
@@ -96,7 +96,11 @@ Sequence of events for the client connection is this:
|
|||||||
Connection status is held in `mg_connection::status_code`: if zero,
|
Connection status is held in `mg_connection::status_code`: if zero,
|
||||||
then connection was successful, otherwise connection was not established.
|
then connection was successful, otherwise connection was not established.
|
||||||
User should send a request upon successful connection.
|
User should send a request upon successful connection.
|
||||||
|
Event handler should return `MG_TRUE` if connection was successful and
|
||||||
|
HTTP request has been sent. Otherwise, it should send `MG_FALSE`.
|
||||||
* `MG_REPLY` is sent when response has been received from the remote host.
|
* `MG_REPLY` is sent when response has been received from the remote host.
|
||||||
|
If event handler sends another request, then it should return `MG_TRUE`.
|
||||||
|
Otherwise it should return `MG_FALSE` and Mongoose will close the connection.
|
||||||
* `MG_CLOSE` same as for the accepted connection.
|
* `MG_CLOSE` same as for the accepted connection.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -66,7 +66,7 @@ enum mg_event {
|
|||||||
MG_AUTH, // If callback returns MG_FALSE, authentication fails
|
MG_AUTH, // If callback returns MG_FALSE, authentication fails
|
||||||
MG_REQUEST, // If callback returns MG_FALSE, Mongoose continues with req
|
MG_REQUEST, // If callback returns MG_FALSE, Mongoose continues with req
|
||||||
MG_REPLY, // If callback returns MG_FALSE, Mongoose closes connection
|
MG_REPLY, // If callback returns MG_FALSE, Mongoose closes connection
|
||||||
MG_CLOSE, // Connection is closed
|
MG_CLOSE, // Connection is closed, callback return value is ignored
|
||||||
MG_LUA, // Called before LSP page invoked
|
MG_LUA, // Called before LSP page invoked
|
||||||
MG_HTTP_ERROR // If callback returns MG_FALSE, Mongoose continues with err
|
MG_HTTP_ERROR // If callback returns MG_FALSE, Mongoose continues with err
|
||||||
};
|
};
|
||||||
|
|||||||
Reference in new issue
Block a user