Name
ngx_cpp_dev
Nginx cpp development kit, with the power of C++11 and Boost Library.
Table of Contents
Status
Experimental but works well.
Now support Nginx 1.13.10 and later.
See Also
- annotated_nginx - 注释nginx，学习研究源码
- ngx_ansic_dev - Nginc ANSI C Development
- openresty_dev - OpenResty/Lua Programming
- ngx_google_perftools_profiler - A better tools for nginx with google_perftools
Requirements
- Linux or other UNIX like
- C++11(gcc 4.6 or later)
- Boost(1.57 or later)
- Nginx 1.13.10 or later
Please see directiory "setup".
Usage
At first, you must patch nginx/auto/make to enable g++ compiler and C++11.
Please see directory "patch/auto".
For example:
patch -b make make.patch
Then configure nginx with:
./configure --add-module=path/to/ngxpp \ # ngx cpp module
--add-module=xxxx # other modules
make
ngx_cpp_module is a pure header library, you should use ngx_cpp_module like this:
#include "NgxAll.hpp" // include all C++ tools for http modules
Or
#include "NgxStreamAll.hpp" // include all C++ tools for stream modules
Examples
Please see directory http, including echo/filter/variables and so on.
C++ APIs
common tools
| Class Name | Description |
|---|---|
| NgxUnsetValue | generic unset value -1. |
| NgxValue | wrapper for nginx int, include init/merge/unset. |
| NgxException | wrapper for nginx error code. |
| NgxPool | wrapper for nginx memory pool. |
| NgxAlloctor | adapter to C++ allocator. |
| NgxString | wrapper for nginx ngx_str_t. |
| NgxClock | wrapper for nginx time functions. |
| NgxDatetime | wrapper for nginx date functions. |
| NgxLog | wrapper for nginx error log. |
data structure
| Class Name | Description |
|---|---|
| NgxArray | wrapper for nginx ngx_array_t. |
| NgxList | wrapper for nginx ngx_list_t. |
| NgxQueue | wrapper for nginx ngx_queue_t. |
| NgxBuf | deprecated, wrapper for nginx ngx_buf_t. |
| NgxChain | deprecated, wrapper for nginx ngx_chain_t. |
| NgxRbtree | wrapper for nginx ngx_rbtree_t. |
modules
| Class Name | Description |
|---|---|
| NgxModuleConfig | easy to access nginx module confing info. |
| NgxModule | get module's config and ctx data. |
| NgxCommand | deprecated, DO NOT USE IT. |
| NgxTake | deprecated |
| NgxModuleCtx | easy to access nginx module's ctx data. |
| NgxHttpCoreModule | wrapper for ngx_http_core_module |
| NgxFilter | wrapper for nginx filter mechanism. |
http process
| Class Name | Description |
|---|---|
| NgxHeaders | |
| NgxRequest | |
| NgxResponse | |
| NgxUpstreamHelper | |
| NgxLoadBalance | |
| NgxSubRequest |
others
| Class Name | Description |
|---|---|
| NgxVariables | |
| NgxVarManager | |
| NgxDigest | |
| NgxTimer |
TODO
- more test suites
- nginx datagram
- ...