# ngx_cpp_dev

**Repository Path**: wh609/ngx_cpp_dev

## Basic Information

- **Project Name**: ngx_cpp_dev
- **Description**: nginx开发c++示例
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-03-26
- **Last Updated**: 2021-09-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Name
====
ngx_cpp_dev

Nginx cpp development kit, with the power of C++11 and Boost Library.

[![Build Status](https://travis-ci.org/chronolaw/ngx_cpp_dev.svg?branch=master)](https://travis-ci.org/chronolaw/ngx_cpp_dev)

Table of Contents
=================

* [Name](#name)
* [Status](#status)
* [See Also](#see-also)
* [Requirements](#Requirements)
* [Usage](#Usage)
* [Examples](Examples)
* [C++ APIs](#C++-APIs)
* [TODO](#TODO)

Status
====
Experimental but works well.

Now support *Nginx 1.13.10 and later*.

See Also
====
* [annotated_nginx](https://github.com/chronolaw/annotated_nginx) - 注释nginx，学习研究源码
* [ngx_ansic_dev](https://github.com/chronolaw/ngx_ansic_dev) - Nginc ANSI C Development
* [openresty_dev](https://github.com/chronolaw/openresty_dev) - OpenResty/Lua Programming
* [ngx_google_perftools_profiler](https://github.com/chronolaw/ngx_google_perftools_profiler_module) - 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
* ...