first commit

public/MT4ManagerAPI.h

@@ -0,0 +1,1848 @@
+//+------------------------------------------------------------------+
+//|                                         MetaTrader 4 Manager API |
+//|                   Copyright 2001-2017, MetaQuotes Software Corp. |
+//|                                        http://www.metaquotes.net |
+//+------------------------------------------------------------------+
+//|                   DO NOT EDIT THIS FILE!!!                       |
+//+------------------------------------------------------------------+
+// NoStyler
+#pragma once
+//+------------------------------------------------------------------+
+//|                        API Version                               |
+//+------------------------------------------------------------------+
+#define ManAPIProgramVersion  400
+#define ManAPIProgramBuild    1090
+#define ManAPIVersion         MAKELONG(ManAPIProgramBuild,ManAPIProgramVersion)
+//+------------------------------------------------------------------+
+//| MSVS6 Compatibility                                              |
+//+------------------------------------------------------------------+
+#if _MSC_VER <= 1200
+#define __time32_t time_t
+#define __ptr32
+#endif
+//+------------------------------------------------------------------+
+//|                   Server Configurations                          |
+//+------------------------------------------------------------------+
+//| Configuration types                                              |
+//+------------------------------------------------------------------+
+enum
+  {
+   CONFIG_ALL=0,                             // all configurations
+   CONFIG_COMMON,                            // common configuration
+   CONFIG_ACCESS,                            // IP access list configuration
+   CONFIG_SERVERS,                           // data servers
+   CONFIG_TIME,                              // working time configuration
+   CONFIG_HOLIDAYS,                          // holidays configuration
+   CONFIG_SYMBOLS,                           // symbols configuration
+   CONFIG_SYMB_GROUPS,                       // securities configuration
+   CONFIG_GROUPS,                            // groups configuration
+   CONFIG_MANAGERS,                          // manager's rights configuration
+   CONFIG_DATAFEEDS,                         // data feeds configuration
+   CONFIG_BACKUP,                            // backups configuration
+   CONFIG_LIVEUPDATE,                        // LiveUpdate configuration
+   CONFIG_SYNC,                              // synchronization configuration
+   CONFIG_PLUGINS,                           // plugins configuration
+   CONFIG_GATEWAY_ACCOUNTS,                  // gateway accounts
+   CONFIG_GATEWAY_MARKUPS,                   // gateway markups
+   CONFIG_GATEWAY_RULES,                     // gateway rules
+   CONFIG_END=255                            // last (unused)
+  };
+//+------------------------------------------------------------------+
+//| Configuration structures                                         |
+//+------------------------------------------------------------------+
+//| Common configuration                                             |
+//+------------------------------------------------------------------+
+struct ConCommon
+  {
+   char              owner[128];            // servers owner (include version & build)
+   char              name[32];              // server name
+   ULONG             address;               // IP address assigned to the server
+   int               port;                  // port
+   DWORD             timeout;               // sockets timeout
+   int               typeofdemo;            // demo-accounts type (DEMO_DISABLED, DEMO_PROLONG, DEMO_FIXED)
+   int               timeofdemo;            // demo-account living time
+   int               daylightcorrection;    // allow daylight correction
+   char              internal[60];          // reserved
+   int               timezone_real;         // time zone with day light mode
+   int               timezone;              // time zone 0-GMT;-1=GMT-1;1=GMT+1;
+   char              timesync[64];          // time synchronization server address
+   //---
+   int               minclient;             // minimal authorized client version
+   int               minapi;                // minimal authorized client version
+   DWORD             feeder_timeout;        // data feed switch timeout
+   int               keepemails;            // internal mail keep period
+   int               endhour,endminute;     // end of day time-hour & minute
+   //---
+   int               optimization_time;     // optimization start time (minutes)
+   int               optimization_lasttime; // optimization last time
+   int               optimization_counter;  // internal variable
+   int               optimization_unused[8];// reserved for future use
+   //---
+   int               antiflood;             // enable antiflood control
+   int               floodcontrol;          // max. antiflood connections
+   //---
+   int               liveupdate_mode;       // LiveUpdate mode (LIVE_UPDATE_NO,LIVE_UPDATE_ALL,LIVE_UPDATE_NO_SERVER)
+   //---
+   int               lastorder;             // last order's ticket     (read only)
+   int               lastlogin;             // last account's number   (read only)
+   int               lostlogin;             // lost commission's login (read only)
+   //---
+   int               rollovers_mode;        // rollover mode (ROLLOVER_NORMAL,ROLLOVER_REOPEN_BY_CLOSE_PRICE,ROLLOVER_REOPEN_BY_BID)
+   //---
+   char              path_database[256];    // path to databases
+   char              path_history[256];     // path to history bases
+   char              path_log[256];         // path to log
+   //--- overnigths
+   __time32_t        overnight_last_day;    // day of last overnight
+   __time32_t        overnight_last_time;   // time of last overnight
+   __time32_t        overnight_prev_time;   // time of next to last overnight
+   //--- month reports
+   __time32_t        overmonth_last_month;  // month of last report
+   //--- performance base
+   char              adapters[256];         // network adapters list (read-only)
+   ULONG             bind_adresses[8];      // array of avaible IP addresses
+   short             server_version;        // server version
+   short             server_build;          // server build
+   ULONG             web_adresses[8];       // web services access list (comma separated IP addresses)
+   int               statement_mode;        // statement generation time (STATEMENT_END_DAY,STATEMENT_START_DAY)
+   int               monthly_state_mode;    // monthly statement generation day (MONTHLY_STATEMENT_END_MONTH,MONTHLY_STATEMENT_START_MONTH)
+   int               keepticks;             // ticks keep period
+   int               statement_weekend;     // generate statements at weekends
+   __time32_t        last_activate;         // last activation datetime
+   __time32_t        stop_last;             // last stop datetime
+   int               stop_delay;            // last stop delay
+   int               stop_reason;           // last stop reason
+   char              account_url[128];      // account allocation URL
+   int               reserved[16];
+  };
+//--- deno-accounts type
+enum { DEMO_DISABLED, DEMO_PROLONG, DEMO_FIXED };
+//--- rollover mode
+enum { ROLLOVER_NORMAL, ROLLOVER_REOPEN_BY_CLOSE_PRICE, ROLLOVER_REOPEN_BY_BID };
+//--- LiveUpdate mode
+enum { LIVE_UPDATE_NO=0, LIVE_UPDATE_RELEASE=1, LIVE_UPDATE_NO_SERVER=2, LIVE_UPDATE_BETA=3 };
+//--- statement mode
+enum { STATEMENT_END_DAY, STATEMENT_START_DAY };
+//--- monthly statement mode
+enum { MONTHLY_STATEMENT_END_MONTH, MONTHLY_STATEMENT_START_MONTH };
+//--- server stop reason
+enum { STOP_REASON_NONE, STOP_REASON_RESTART, STOP_REASON_SHUTDOWN, STOP_REASON_LIVEUPDATE };
+//+------------------------------------------------------------------+
+//| Access configuration                                             |
+//+------------------------------------------------------------------+
+struct ConAccess
+  {
+   int               action;                // type of action (FW_BLOCK,FW_PERMIT)
+   unsigned long     from,to;               // from, to addresses
+   char              comment[64];           // comment
+   int               reserved[17];          // reserved
+  };
+//--- access action
+enum { FW_BLOCK,FW_PERMIT };
+//+------------------------------------------------------------------+
+//| Data Servers configuration                                       |
+//+------------------------------------------------------------------+
+struct ConDataServer
+  {
+   char              server[64];             // server address (server:ip)
+   ULONG             ip;                     // server IP
+   char              description[64];        // server description
+   int               isproxy;                // can server be proxy?
+   int               priority;               // priority: 0-7 base, 255-idle
+   UINT              loading;                // server loading (UINT_MAX-server does not inform its loading)
+   ULONG             ip_internal;            // internal IP address
+   int               reserved[2];            // reserved
+   ConDataServer* __ptr32 next;                   // internal (not used)
+  };
+//+------------------------------------------------------------------+
+//| Time configuration                                               |
+//+------------------------------------------------------------------+
+struct ConTime
+  {
+   int               days[7][24];           // server's accessebility (7 days-24 hours, 0-denied, 1-allowed)
+   int               dayscontrol;           // internal variable
+   int               reserved[3];           // reserved
+  };
+//+------------------------------------------------------------------+
+//| Backup configuration                                             |
+//+------------------------------------------------------------------+
+struct ConBackup
+  {
+   //---
+   char              fullbackup_path[256];   // path to backup
+   int               fullbackup_period;      // full backup's period-BACKUP_1HOUR, BACKUP_4HOURS, BACKUP_1DAY
+   int               fullbackup_store;       // full backup's store time-BU_STORE_1MONTH, BU_STORE_3MONTHS, BU_STORE_6MONTHS,BU_STORE_1YEAR
+   __time32_t        fullbackup_lasttime;    // full backup's last execution time
+   short             fullbackup_shift;       // full backup timeshift (minutes)
+   //---
+   char              external_path[256];     // path to external processing directory
+   //---
+   int               archive_period;         // period of archive backup-ARC_BACKUP_5MIN, ARC_BACKUP_15MIN, ARC_BACKUP_30MIN, ARC_BACKUP_1HOUR
+   int               archive_store;          // archive backup's store time-ARC_STORE_1WEEK, ARC_STORE_2WEEKS, ARC_STORE_1MONTH, ARC_STORE_3MONTH, ARC_STORE_6MONTH
+   __time32_t        archive_lasttime;       // archive backup's last execution time
+   //---
+   char              export_securities[512]; // comma separated list of exported securities
+   char              export_path[256];       // path to export script
+   int               export_period;          // export period-enumeration EXPORT_1MIN, EXPORT_5MIN, EXPORT_15MIN, EXPORT_30MIN,EXPORT_1HOUR
+   __time32_t        export_lasttime;        // export's last execution time
+   //--- watch dog
+   int               watch_role;             // server role { WATCH_STAND_ALONE, WATCH_MASTER, WATCH_SLAVE }
+   char              watch_password[16];     // slave server password
+   char              watch_opposite[24];     // opposite server IP address and port
+   int               watch_ip;               // opposite server IP
+   //--- 
+   char              archive_shift;          // shift of archive backup time (in minutes)
+   //---
+   char              watch_state;            // watch dog state
+   char              watch_failover;         // watch dog failover mode
+   unsigned char     watch_timeout;          // watch dog timeout
+   int               watch_login;            // watch dog login
+   __time32_t        watch_timestamp;        // watch dog timestamp
+  };
+//--- server role
+enum { WATCH_STAND_ALONE,WATCH_MASTER,WATCH_SLAVE };
+//--- full backup execution periods: 1 hour, 4 hours, 1 day
+enum { BACKUP_1HOUR,BACKUP_4HOURS,BACKUP_1DAY };
+//--- full backup store period: 1 month, 3 months, 6 months, 1 year
+enum { BU_STORE_1MONTH,BU_STORE_3MONTHS,BU_STORE_6MONTHS,BU_STORE_1YEAR };
+//--- arc. backup execution periods: 5 min, 15 min, 30 min, 1 hour
+enum { ARC_BACKUP_DISABLED,ARC_BACKUP_5MIN,ARC_BACKUP_15MIN,ARC_BACKUP_30MIN,ARC_BACKUP_1HOUR };
+//--- arc. backup store period: 1 day, 3 days, 1 week, 2 weeks, 1 month,3 months, 6 months,1 year
+enum { ARC_STORE_1DAY,ARC_STORE_3DAYS,ARC_STORE_1WEEK,ARC_STORE_2WEEKS,ARC_STORE_1MONTH,ARC_STORE_3MONTH,ARC_STORE_6MONTH };
+//--- export execution period: 1 min, 5 min, 15 min, 30 min, 1 hour
+enum { EXPORT_1MIN,EXPORT_5MIN,EXPORT_15MIN,EXPORT_30MIN,EXPORT_1HOUR };
+//--- watchdog state
+enum { WS_DISCONNECTED, WS_SYNCHRONIZING, WS_SYNCHRONIZED };
+//--- watchdog failover mode
+enum { FAILOVER_OFF, FAILOVER_MOST, FAILOVER_FULL };
+//+------------------------------------------------------------------+
+//| Datafeed configuration                                           |
+//+------------------------------------------------------------------+
+struct ConFeeder
+  {
+   char              name[64];              // name
+   char              file[256];             // datafeed filename
+   char              server[64];            // server address
+   char              login[32];             // datafeed login
+   char              pass[32];              // datafeed password
+   char              keywords[256];         // keywords (news filtration)
+   int               enable;                // enable feeder
+   int               mode;                  // datafeed mode-enumeration FEED_QUOTES, FEED_NEWS, FEED_QUOTESNEWS
+   int               timeout;               // max. freeze time (default ~120 sec.)
+   int               timeout_reconnect;     // reconnect timeout before attemps_sleep connect attempts (default ~ 5  sec)
+   int               timeout_sleep;         // reconnect timeout after attemps_sleep connect attempts  (default ~ 60 sec)
+   int               attemps_sleep;         // reconnect count (see timeout_reconnect & timeout_sleep)
+   int               news_langid;           // news language id
+   int               unused[33];            // reserved
+  };
+//--- datafeed modes-receive quotes, receive news, receive quotes and news
+enum { FEED_QUOTES=0, FEED_NEWS=1, FEED_QUOTESNEWS=2 };
+//+------------------------------------------------------------------+
+//| Security group configuration for client group                    |
+//+------------------------------------------------------------------+
+#define MAX_SEC_GROUPS       (32)
+#define MAX_SEC_GROPS_MARGIN (128)
+//---
+struct ConGroupSec
+  {
+   int               show,trade;            // enable show and trade for this group of securites
+   int               execution;             // dealing mode-EXECUTION_MANUAL,EXECUTION_AUTO,EXECUTION_ACTIVITY
+   //--- comission settings
+   double            comm_base;             // standart commission
+   int               comm_type;             // commission type-COMM_TYPE_MONEY,COMM_TYPE_PIPS,COMM_TYPE_PERCENT
+   int               comm_lots;             // commission lots mode-COMMISSION_PER_LOT,COMMISSION_PER_DEAL
+   double            comm_agent;            // agent commission
+   int               comm_agent_type;       // agent commission mode-COMM_TYPE_MONEY, COMM_TYPE_PIPS
+   //---
+   int               spread_diff;           // spread difference in compare with default security spread
+   //---
+   int               lot_min,lot_max;       // allowed minimal and maximal lot values
+   int               lot_step;              // allowed step value (10 lot-1000, 1 lot-100, 0.1 lot-10)
+   int               ie_deviation;          // maximum price deviation in Instant Execution mode
+   int               confirmation;          // use confirmation in Request mode
+   int               trade_rights;          // clients trade rights-bit mask see TRADE_DENY_NONE,TRADE_DENY_CLOSEBY,TRADE_DENY_MUCLOSEBY
+   int               ie_quick_mode;         // do not resend request to the dealer when client uses deviation
+   int               autocloseout_mode;     // auto close-out method { CLOSE_OUT_NONE, CLOSE_OUT_HIHI, CLOSE_OUT_LOLO, CLOSE_OUT_HILO, CLOSE_OUT_LOHI, CLOSE_OUT_LOHI, CLOSE_OUT_FIFO, CLOSE_OUT_LIFO, CLOSE_OUT_INTRDAY_FIFO }
+   double            comm_tax;              // commission taxes
+   int               comm_agent_lots;       // agent commission per lot/per deal { COMMISSION_PER_LOT,COMMISSION_PER_DEAL }
+   int               freemargin_mode;       // "soft" margin check
+   int               reserved[3];           // reserved
+  };
+//+------------------------------------------------------------------+
+//| Special securities configurations for client group               |
+//+------------------------------------------------------------------+
+struct ConGroupMargin
+  {
+   char              symbol[12];            // security
+   double            swap_long,swap_short;  // swap size for long and short positions
+   double            margin_divider;        // margin divider
+   int               reserved[7];
+  };
+//--- dealing mode
+enum { EXECUTION_MANUAL, EXECUTION_AUTO, EXECUTION_ACTIVITY };
+//--- commission type
+enum { COMM_TYPE_MONEY, COMM_TYPE_PIPS, COMM_TYPE_PERCENT };
+//--- comission lots mode
+enum { COMMISSION_PER_LOT, COMMISSION_PER_DEAL };
+//--- clients trade rights
+enum { TRADE_DENY_NONE=0, TRADE_DENY_CLOSEBY=1, TRADE_DENY_MUCLOSEBY=2 };
+//--- auto close-out method
+enum { CLOSE_OUT_NONE, CLOSE_OUT_HIHI, CLOSE_OUT_LOLO, CLOSE_OUT_HILO, CLOSE_OUT_LOHI, CLOSE_OUT_FIFO, CLOSE_OUT_LIFO, CLOSE_OUT_INTRDAY_FIFO };
+//+------------------------------------------------------------------+
+//| Client group configuration                                       |
+//+------------------------------------------------------------------+
+struct ConGroup
+  {
+   //--- common settings
+   char              group[16];                   // group name
+   int               enable;                      // enable group
+   int               timeout;                     // trade confirmation timeout (seconds)
+   int               otp_mode;                    // one-time password mode
+   //--- statements
+   char              company[128];                // company name
+   char              signature[128];              // statements signature
+   char              support_page[128];           // company support page
+   char              smtp_server[64];             // statements SMTP server
+   char              smtp_login[32];              // statements SMTP login
+   char              smtp_password[32];           // statements SMTP password
+   char              support_email[64];           // support email
+   char              templates[32];               // path to directory with custom templates
+   int               copies;                      // copy statements on support email
+   int               reports;                     // enable statements
+   //--- default settings
+   int               default_leverage;            // default leverage (user don't specify leverage himself)
+   double            default_deposit;             // default deposit  (user don't specify balance  himself)
+   //--- securities
+   int               maxsecurities;               // maximum simultaneous securities
+   ConGroupSec       secgroups[MAX_SEC_GROUPS];   // security group settings
+   ConGroupMargin    secmargins[MAX_SEC_GROPS_MARGIN]; // special securities settings
+   int               secmargins_total;            // count of special securities settings
+   //--- margin & interest
+   char              currency[12];                // deposit currency
+   double            credit;                      // virtual credit
+   int               margin_call;                 // margin call level (percents)
+   int               margin_mode;                 // margin mode-MARGIN_DONT_USE,MARGIN_USE_ALL,MARGIN_USE_PROFIT,MARGIN_USE_LOSS
+   int               margin_stopout;              // stop out level
+   double            interestrate;                // annual interest rate (percents)
+   int               use_swap;                    // use rollovers & interestrate
+   //--- rights
+   int               news;                        // news mode
+   int               rights;                      // rights bit mask-ALLOW_FLAG_EMAIL
+   int               check_ie_prices;             // check IE prices on requests
+   int               maxpositions;                // maximum orders and open positions
+   int               close_reopen;                // partial close mode (if !=0 original position will be fully closed and remain position will be fully reopened)
+   int               hedge_prohibited;            // hedge prohibition flag
+   int               close_fifo;                  // fifo rule 
+   int               hedge_largeleg;              // use large leg margin for hedged positions
+   int               unused_rights[2];            // reserved
+
+   char              securities_hash[16];         // internal data
+   //---
+   int               margin_type;                 // margin controlling type { MARGIN_TYPE_PERCENT,  MARGIN_TYPE_CURRENCY }
+   //--- archives
+   int               archive_period;              // inactivity period after which account moves to archive base (in days)
+   int               archive_max_balance;         // maxumum balance of accounts to move in archive base
+   //---
+   int               stopout_skip_hedged;         // skip fully hedged accounts when checking for stopout
+   int               archive_pending_period;      // pendings clean period
+   //--- allowed news languages
+   UINT              news_languages[8];           // LANGID array
+   UINT              news_languages_total;        // news languages total
+   //--- reserved
+   int               reserved[17];
+  };
+//--- margin calculation mode
+enum { MARGIN_MODE_DONT_USE,MARGIN_MODE_USE_ALL,MARGIN_MODE_USE_PROFIT,MARGIN_MODE_USE_LOSS };
+//--- margin controlling type
+enum { MARGIN_TYPE_PERCENT, MARGIN_TYPE_CURRENCY };
+//--- news mode-no news, only topics, full news (topic+body)
+enum { NEWS_NO, NEWS_TOPICS, NEWS_FULL  };
+//--- group rights
+enum 
+  { 
+   ALLOW_FLAG_EMAIL           =1,
+   ALLOW_FLAG_TRAILING        =2,
+   ALLOW_FLAG_ADVISOR         =4,
+   ALLOW_FLAG_EXPIRATION      =8,
+   ALLOW_FLAG_SIGNALS_ALL     =16,
+   ALLOW_FLAG_SIGNALS_OWN     =32,
+   ALLOW_FLAG_RISK_WARNING    =64,
+   ALLOW_FLAG_FORCED_OTP_USAGE=128,
+  };
+//--- group one-time password mode
+enum
+  {
+   OTP_MODE_DISABLED       =0,
+   OTP_MODE_TOTP_SHA256    =1,
+  };
+//+------------------------------------------------------------------+
+//| Hollidays configuration                                          |
+//+------------------------------------------------------------------+
+struct ConHoliday
+  {
+   int               year;                        // year
+   int               month;                       // month
+   int               day;                         // day
+   int               from,to;                     // work time-from & to (minutes)
+   char              symbol[32];                  // security name or symbol's group name or "All"
+   char              description[128];            // description
+   int               enable;                      // enable
+   int               reserved[13];                // reserved
+   ConHoliday * __ptr32 next;                     // internal data
+  };
+//+------------------------------------------------------------------+
+//| LiveUpdate configuration                                         |
+//+------------------------------------------------------------------+
+#define LIVE_FILES_MAX (128)
+//---
+struct LiveInfoFile
+  {
+   char              file[256];                   // file name
+   int               size;                        // file size
+   char              hash[36];                    // file hash
+   int               reserved[10];                // reserved
+  };
+//---
+struct ConLiveUpdate
+  {
+   char              company[128];                // company
+   char              path[256];                   // path to LiveUpdate
+   int               version;                     // version
+   int               build;                       // build
+   int               maxconnect;                  // max. simultaneous connections
+   int               connections;                 // current connections (read only)
+   int               type;                        // type LIVE_UPDATE_*
+   int               enable;                      // enable
+   int               totalfiles;                  // total files count
+   LiveInfoFile      files[LIVE_FILES_MAX];       // files' configurations
+   int               reserved[16];                // reserved
+   ConLiveUpdate * __ptr32 next;                        // internal data
+  };
+//--- LiveUpdate type
+enum
+  {
+   LIVE_UPDATE_CLIENT,
+   LIVE_UPDATE_MANAGER,
+   LIVE_UPDATE_ADMIN,
+   LIVE_UPDATE_DATACENTER,
+   LIVE_UPDATE_CLIENT_PPC2002,
+   LIVE_UPDATE_CLIENT_PPC2003,
+   LIVE_UPDATE_MULTI,
+   LIVE_UPDATE_WD,
+   LIVE_UPDATE_CLIENT_PHONE,
+   LIVE_UPDATE_LAST 
+  };
+//+------------------------------------------------------------------+
+//| Manager rights for security groups                               |
+//+------------------------------------------------------------------+
+struct ConManagerSec
+  {
+   int               internal;                    // internal data
+   int               enable;                      // enable
+   int               minimum_lots;                // min. lots
+   int               maximum_lots;                // max. lots
+   int               unused[16];                  // reserved
+  };
+//+------------------------------------------------------------------+
+//| Manager configuration                                            |
+//+------------------------------------------------------------------+
+struct ConManager
+  {
+   int               login;                       // login
+   //--- rights
+   int               manager;                     // right to add & change client records
+   int               money;                       // right to balance & credit management
+   int               online;                      // right to see online users
+   int               riskman;                     // right to use analyzer
+   int               broker;                      // right to deal
+   int               admin;                       // right to server administration
+   int               logs;                        // right to see logs
+   int               reports;                     // right to see reports
+   int               trades;                      // right to add/modify/delete trades
+   int               market_watch;                // right to change spread, spread balance, stop levels, execution mode and send quotes
+   int               email;                       // right to send internal mail
+   int               user_details;                // right to see clients private data-name,country,address,phone,email etc.
+   int               see_trades;                  // right to see trades
+   int               news;                        // right to send news
+   int               plugins;                     // right to configure plugins
+   int               server_reports;              // right to receive server reports
+   int               techsupport;                 // right to access to technical support page
+   int               market;                      // right to access server applications market
+   int               notifications;               // right to push notifications
+   int               unused[9];
+   //--- IP filtration
+   int               ipfilter;                    // enable IP control
+   unsigned long     ip_from,ip_to;               // range of allowed IPs
+   //---
+   char              mailbox[64];                 // name of mailbox for internal mail
+   char              groups[1024];                // comma separated list of managed groups (allowed '*' wildcard)
+   ConManagerSec     secgroups[MAX_SEC_GROUPS];   // manager rights for security groups
+   DWORD             exp_time;                    // internal data
+   char              name[32];                    // manager name (read only)
+   int               info_depth;                  // maximum available data (in days) 
+   //---
+   int               reserved[22];
+  };
+//+------------------------------------------------------------------+
+//| Symbol configurations                                            |
+//+------------------------------------------------------------------+
+//| Symbol sessions configurations                                   |
+//+------------------------------------------------------------------+
+struct ConSession
+  {
+   short             open_hour,open_min;          // session open  time: hour & minute
+   short             close_hour,close_min;        // session close time: hour & minute
+   int               open,close;                  // internal data
+   short             align[7];                    // internal data
+  };
+//---
+struct ConSessions
+  {
+   //---
+   ConSession        quote[3];                    // quote sessions
+   ConSession        trade[3];                    // trade sessions
+   //---
+   int               quote_overnight;             // internal data
+   int               trade_overnight;             // internal data
+   int               reserved[2];                 // reserved
+  };
+//+------------------------------------------------------------------+
+//| Symbol configuration                                             |
+//+------------------------------------------------------------------+
+#define MAX_SYMBOLS 1024
+//---
+struct ConSymbol
+  {
+   //--- common settings
+   char              symbol[12];                  // name
+   char              description[64];             // description
+   char              source[12];                  // synonym
+   char              currency[12];                // currency
+   int               type;                        // security group (see ConSymbolGroup)
+   int               digits;                      // security precision
+   int               trade;                       // trade mode
+   //--- external settings
+   COLORREF          background_color;            // background color
+   int               count;                       // symbols index
+   int               count_original;              // symbols index in market watch
+   int               external_unused[7];
+   //--- sessions
+   int               realtime;                    // allow real time quotes
+   __time32_t        starting;                    // trades starting date (UNIX time)
+   __time32_t        expiration;                  // trades end date      (UNIX time)
+   ConSessions       sessions[7];                 // quote & trade sessions
+   //--- profits
+   int               profit_mode;                 // profit calculation mode
+   int               profit_reserved;             // reserved
+   //--- filtration
+   int               filter;                      // filter value
+   int               filter_counter;              // filtration parameter
+   double            filter_limit;                // max. permissible deviation from last quote (percents)
+   int               filter_smoothing;            // smoothing
+   float             filter_reserved;             // reserved
+   int               logging;                     // enable to log quotes
+   //--- spread & swaps
+   int               spread;                      // spread
+   int               spread_balance;              // spread balance
+   int               exemode;                     // execution mode
+   int               swap_enable;                 // enable swaps
+   int               swap_type;                   // swap type
+   double            swap_long,swap_short;        // swaps values for long & short postions
+   int               swap_rollover3days;          // triple rollover day-0-Monday,1-Tuesday...4-Friday
+   double            contract_size;               // contract size
+   double            tick_value;                  // one tick value
+   double            tick_size;                   // one tick size
+   int               stops_level;                 // stops deviation value
+   //---
+   int               gtc_pendings;                // GTC mode { ORDERS_DAILY, ORDERS_GTC, ORDERS_DAILY_NO_STOPS }
+   //--- margin calculation
+   int               margin_mode;                 // margin calculation mode
+   double            margin_initial;              // initial margin
+   double            margin_maintenance;          // margin maintenance
+   double            margin_hedged;               // hedged margin
+   double            margin_divider;              // margin divider
+   //--- calclulated variables (internal data)
+   double            point;                       // point size-(1/(10^digits)
+   double            multiply;                    // multiply 10^digits
+   double            bid_tickvalue;               // tickvalue for bid
+   double            ask_tickvalue;               // tickvalue for ask
+   //---
+   int               long_only;                   // allow only BUY positions
+   int               instant_max_volume;          // max. volume for Instant Execution
+   //---
+   char              margin_currency[12];         // currency of margin requirments
+   int               freeze_level;                // modification freeze level
+   int               margin_hedged_strong;        // strong hedged margin mode
+   __time32_t        value_date;                  // value date
+   int               quotes_delay;                // quotes delay after session start
+   int               swap_openprice;         	  // use open price at swaps calculation in SWAP_BY_INTEREST mode
+   int               swap_variation_margin;       // charge variation margin on rollover
+   //---
+   int               unused[21];             	  // reserved
+
+  };
+//+------------------------------------------------------------------+
+//| Symbols enumeration                                              |
+//+------------------------------------------------------------------+
+//--- symbol execution mode
+enum { EXE_REQUEST,EXE_INSTANT,EXE_MARKET };
+//--- trade mode
+enum { TRADE_NO,TRADE_CLOSE,TRADE_FULL };
+//--- swap type
+enum { SWAP_BY_POINTS,SWAP_BY_DOLLARS,SWAP_BY_INTEREST,SWAP_BY_MARGIN_CURRENCY };
+//--- profit calculation mode
+enum { PROFIT_CALC_FOREX,PROFIT_CALC_CFD,PROFIT_CALC_FUTURES };
+//--- margin calculation mode
+enum { MARGIN_CALC_FOREX,MARGIN_CALC_CFD,MARGIN_CALC_FUTURES,MARGIN_CALC_CFDINDEX,MARGIN_CALC_CFDLEVERAGE };
+//--- GTC mode
+enum { ORDERS_DAILY, ORDERS_GTC, ORDERS_DAILY_NO_STOPS };
+//+------------------------------------------------------------------+
+//| Symbol groups                                                    |
+//+------------------------------------------------------------------+
+#define MAX_SEC_GROUP (32)
+struct ConSymbolGroup
+  {
+   char              name[16];                     // group name
+   char              description[64];              // group description
+  };
+//+------------------------------------------------------------------+
+//| Synchronization configuration                                    |
+//+------------------------------------------------------------------+
+struct ConSync
+  {
+   char              server[64];                   // name (address
+   int               unusedport;                   // port
+   char              login[32];                    // for future use-login
+   char              password[32];                 // for future use=password
+   int               enable;                       // enable sychronization
+   int               mode;                         // synchronization mode: HB_ADD,HB_UPDATE,HB_INSERT
+   __time32_t        from,to;                      // synchronization range (<0-whole chart)
+   char              securities[1024];             // symbols list
+   int               timecorrection;               // time correction in minutes
+   int               reserved[13];                 // reserved
+   ConSync * __ptr32 next;                         // internal (do not use)
+  };
+//--- synchronization mode
+enum { HB_ADD,HB_UPDATE,HB_INSERT,HB_DELETE,HB_LAST };
+//+------------------------------------------------------------------+
+//| Plugin configuration                                             |
+//+------------------------------------------------------------------+
+//| Plugin description                                               |
+//+------------------------------------------------------------------+
+struct PluginInfo
+  {
+   char              name[128];                    // plugin name
+   unsigned int      version;                      // plugin version
+   char              copyright[128];               // plugin copyright
+   int               reserved[32];                 // reserved
+  };
+//+------------------------------------------------------------------+
+//| Plugin configuration parameter                                   |
+//+------------------------------------------------------------------+
+struct PluginCfg
+  {
+   char              name[32];                     // parameter name
+   char              value[128];                   // parameter value
+   int               reserved[16];                 // reserved
+  };
+//+------------------------------------------------------------------+
+//| Plugin configuration                                             |
+//+------------------------------------------------------------------+
+struct ConPlugin
+  {
+   char              file[256];                    // plugin file name
+   PluginInfo        info;                         // plugin description
+   int               enabled;                      // plugin enabled/disabled
+   int               configurable;                 // is plugin configurable
+   int               manager_access;               // plugin can be accessed from manager terminal
+   int               reserved[62];                 // reserved
+  };
+//--- plugin with parameters
+struct ConPluginParam
+  {
+   ConPlugin         plugin;                       // plugin configuration
+   PluginCfg* __ptr32 params;                      // plugin parameters
+   int               total;                        // total plugin parameters
+  };
+//+------------------------------------------------------------------+
+//| Gateway configuration                                            |
+//+------------------------------------------------------------------+
+//+------------------------------------------------------------------+
+//| Gateway account configuration                                    |
+//+------------------------------------------------------------------+
+struct ConGatewayAccount
+  {
+   int               enable;                       // enable flag 0 - disabled, 1 - enabled
+   char              name[64];                     // public name
+   int               id;                           // internal id
+   int               type;                         // type (obsolete)
+   int               login;                        // STP MT4 login
+   char              address[64];                  // MT4 server address
+   char              password[64];                 // STP MT4 password
+   int               notify_logins[8];             // list of logins for internal email notification
+   int               flags;                        // flag fields
+   int               reserved[23];                 // reserved
+  };
+//--- gateway account flags
+enum EnGatewayAccountFlags { GATEWAY_FLAG_NONE=0, GATEWAY_FLAG_QUOTES=1 };
+//+------------------------------------------------------------------+
+//| Gateway markup configuration                                     |
+//+------------------------------------------------------------------+
+struct ConGatewayMarkup
+  {
+   int               enable;                       // enable flag 0 - disabled, 1 - enabled
+   char              source[128];                  // source symbol\symbols mask\symbols group name
+   char              symbol[12];                   // local symbol name
+   char              account_name[64];             // account name (obsolete)
+   int               account_id;                   // account internal id (obsolete)
+   int               bid_markup;                   // bid markup in pips
+   int               ask_markup;                   // ask markup in pips
+   int               reserved[16];                 // reserved
+  };
+//+------------------------------------------------------------------+
+//| Gateway rules configuration                                     |
+//+------------------------------------------------------------------+
+struct ConGatewayRule
+  {
+   int               enable;                       // enable flag 0 - disabled, 1 - enabled
+   char              name[64];                     // public name
+   char              request_symbol[128];          // symbol\symbols mask\symbols group name
+   char              request_group[128];           // group name or group mask
+   int               request_reserved[32];         // reserved
+   char              exe_account_name[64];         // account name
+   int               exe_account_id;               // account internal id
+   int               exe_max_deviation;            // max. devation
+   int               exe_max_profit_slippage;      // max profit slippage in pips
+   int               exe_max_profit_slippage_lots; // max profit slippage volume in lots
+   int               exe_max_losing_slippage;      // max losing slippage in pips
+   int               exe_max_losing_slippage_lots; // max losing slippage volume in lots
+   int               exe_account_pos;              // account current position
+   int               exe_volume_percent;           // coverage percentage
+   int               exe_reserved[26];             // reserved
+  };
+//+------------------------------------------------------------------+
+//|                           Result codes                           |
+//+------------------------------------------------------------------+
+enum
+  {
+   //--- common errors
+   RET_OK                =0,        // all OK
+   RET_OK_NONE,                     // all OK-no operation
+   RET_ERROR,                       // general error
+   RET_INVALID_DATA,                // invalid data
+   RET_TECH_PROBLEM,                // server technical problem
+   RET_OLD_VERSION,                 // old client terminal
+   RET_NO_CONNECT,                  // no connection
+   RET_NOT_ENOUGH_RIGHTS,           // no enough rights
+   RET_TOO_FREQUENT,                // too frequently access to server
+   RET_MALFUNCTION,                 // mulfunctional operation
+   RET_GENERATE_KEY,                // need to send public key
+   RET_SECURITY_SESSION,            // security session start
+   //--- account status
+   RET_ACCOUNT_DISABLED  =64,       // account blocked
+   RET_BAD_ACCOUNT_INFO,            // bad account info
+   RET_PUBLIC_KEY_MISSING,          // public key missing on external auth
+   //--- trade
+   RET_TRADE_TIMEOUT     =128,      // trade transatcion timeou expired
+   RET_TRADE_BAD_PRICES,            // order has wrong prices
+   RET_TRADE_BAD_STOPS,             // wrong stops level
+   RET_TRADE_BAD_VOLUME,            // wrong lot size
+   RET_TRADE_MARKET_CLOSED,         // market closed
+   RET_TRADE_DISABLE,               // trade disabled
+   RET_TRADE_NO_MONEY,              // no enough money for order execution
+   RET_TRADE_PRICE_CHANGED,         // price changed
+   RET_TRADE_OFFQUOTES,             // no quotes
+   RET_TRADE_BROKER_BUSY,           // broker is busy
+   RET_TRADE_REQUOTE,               // requote
+   RET_TRADE_ORDER_LOCKED,          // order is proceed by dealer and cannot be changed
+   RET_TRADE_LONG_ONLY,             // allowed only BUY orders
+   RET_TRADE_TOO_MANY_REQ,          // too many requests from one client
+   //--- order status notification
+   RET_TRADE_ACCEPTED,              // trade request accepted by server and placed in request queue
+   RET_TRADE_PROCESS,               // trade request accepted by dealerd
+   RET_TRADE_USER_CANCEL,           // trade request canceled by client
+   //--- additional return codes
+   RET_TRADE_MODIFY_DENIED,         // trade modification denied
+   RET_TRADE_CONTEXT_BUSY,          // trade context is busy (used in client terminal)
+   RET_TRADE_EXPIRATION_DENIED,     // using expiration date denied
+   RET_TRADE_TOO_MANY_ORDERS,       // too many orders
+   RET_TRADE_HEDGE_PROHIBITED,      // hedge is prohibited
+   RET_TRADE_PROHIBITED_BY_FIFO     // prohibited by fifo rule
+  };
+//+------------------------------------------------------------------+
+//| Pumping mode flags                                               |
+//+------------------------------------------------------------------+
+enum
+  {
+   //--- user flags
+   CLIENT_FLAGS_HIDETICKS   =1,     // do not send ticks
+   CLIENT_FLAGS_HIDENEWS    =2,     // do not send news
+   CLIENT_FLAGS_HIDEMAIL    =4,     // do not send mails
+   CLIENT_FLAGS_SENDFULLNEWS=8,     // send news body with news header in pumping mode
+   CLIENT_FLAGS_RESERVED    =16,    // reserved
+   //--- manager flags
+   CLIENT_FLAGS_HIDEONLINE  =32,    // do not send online users table
+   CLIENT_FLAGS_HIDEUSERS   =64     // do not send users table
+  };
+//+------------------------------------------------------------------+
+//|  Server datafeed descritopn                                      |
+//+------------------------------------------------------------------+
+struct FeedDescription
+  {
+   int               version;                   // data source version
+   char              name[128];                 // data source name
+   char              copyright[128];            // copyright string
+   char              web[128];                  // data source web
+   char              email[128];                // data source email
+   char              server[128];               // feeder server
+   char              username[32];              // default feeder name
+   char              userpass[32];              // default feeder password
+   int               modes;                     // feeder modes (enum FeederModes)
+   char              description[512];          // feeder description
+   char              module[32];                // datafeed name in license
+   int               reserved[54];              // reserved
+  };
+//--- feeder modes
+enum FeederModes
+  {
+   modeOnlyQuotes    =0, // only quotes feeder
+   modeOnlyNews      =1, // only news feeder
+   modeQuotesAndNews =2, // quotes and news feeder
+   modeQuotesOrNews  =3  // quotes or news feeder
+  };
+//--- server datafeed
+struct ServerFeed
+  {
+   char              file[256];                 // feeder file name
+   FeedDescription   feed;                      // feeder description
+  };
+//+------------------------------------------------------------------+
+//|                           Charts                                 |
+//+------------------------------------------------------------------+
+//| Request chart history struct                                     |
+//+------------------------------------------------------------------+
+struct ChartInfo
+  {
+   char              symbol[12];          // symbol
+   int               period;              // period (PERIOD_*)
+   __time32_t        start;               // start of chart block
+   __time32_t        end;                 // end of chart block
+   __time32_t        timesign;            // timestamp of existing chart base
+   int               mode;                // request mode
+  };
+//--- chart period
+enum { PERIOD_M1=1,  PERIOD_M5=5,   PERIOD_M15=15,  PERIOD_M30=30,
+       PERIOD_H1=60, PERIOD_H4=240, PERIOD_D1=1440, PERIOD_W1=10080,
+       PERIOD_MN1=43200 };
+//--- request mode
+enum { CHART_RANGE_IN,CHART_RANGE_OUT,CHART_RANGE_LAST };
+//+------------------------------------------------------------------+
+//| Rate the in chart base                                           |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct RateInfoOld
+  {
+   __time32_t        ctm;                    // rate time
+   int               open;                   // open price: 11987=119.87
+   short             high,low,close;         // high,low,close shift from open
+   double            vol;                    // volume
+  };
+struct RateInfo
+  {
+   __time32_t        ctm;                    // rate time
+   int               open;                   // open price: 11987=119.87
+   int               high,low,close;         // high,low,close shift from open
+   double            vol;                    // volume
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Tick record in base                                              |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct TickRecord
+  {
+   __time32_t        ctm;                    // tick time
+   double            bid,ask;                // bid, ask
+   int               datafeed;               // index if datafeed
+   char              flags;                  // TICK_FLAG_* flags
+  };
+#pragma pack(pop)
+//---
+enum { TICK_FLAG_RAW=1, TICK_FLAG_NORMAL=2,TICK_FLAG_ALL=TICK_FLAG_RAW+TICK_FLAG_NORMAL };
+//+------------------------------------------------------------------+
+//| Tick request                                                     |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct TickRequest
+  {
+   char              symbol[12];             // symbol
+   __time32_t        from;                   // start of period
+   __time32_t        to;                     // end of period
+   char              flags;                  // TICK_FLAG_* flags
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Performance information                                          |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct PerformanceInfo
+  {
+   __time32_t        ctm;
+   short             users;                  // online users
+   short             cpu;                    // processor loading (%)
+   int               freemem;                // free memory (Kb)
+   int               network;                // network activity (Kb/s)
+   int               sockets;                // all open sockets in system
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Backup file information                                          |
+//+------------------------------------------------------------------+
+struct BackupInfo
+  {
+   char              file[256];              // file name
+   int               size;                   // file size
+   __time32_t        time;                   // file time
+   int               reserved[6];            // reserved
+  };
+//--- backup mode
+enum
+  {
+   BACKUPS_ALL,             // all backup
+   BACKUPS_PERIODICAL,      // periodical backups
+   BACKUPS_STARTUP,         // backups on startup
+   BACKUPS_DELETE           // backups on delete
+  };
+//+------------------------------------------------------------------+
+//|                        Databases                                 |
+//+------------------------------------------------------------------+
+//| Transaction types                                                |
+//+------------------------------------------------------------------+
+enum { TRANS_ADD, TRANS_DELETE, TRANS_UPDATE, TRANS_CHANGE_GRP };
+//+------------------------------------------------------------------+
+//| User Record                                                      |
+//+------------------------------------------------------------------+
+#define PUBLIC_KEY_SIZE    272                  // RSA key size // (((1024+64)/32)*4*2)
+#define USER_COLOR_NONE    (0xFF000000)         // default user color
+//---
+struct UserRecord
+  {
+   //--- common settings
+   int               login;                      // login
+   char              group[16];                  // group
+   char              password[16];               // password
+   //--- access flags
+   int               enable;                     // enable
+   int               enable_change_password;     // allow to change password
+   int               enable_read_only;           // allow to open/positions (TRUE-may not trade)
+   int               enable_otp;                 // allow to use one-time password
+   int               enable_reserved[2];         // for future use
+   //---
+   char              password_investor[16];      // read-only mode password
+   char              password_phone[32];         // phone password
+   char              name[128];                  // name
+   char              country[32];                // country
+   char              city[32];                   // city
+   char              state[32];                  // state
+   char              zipcode[16];                // zipcode
+   char              address[96];                // address
+   char              lead_source[32];            // lead source
+   char              phone[32];                  // phone
+   char              email[48];                  // email
+   char              comment[64];                // comment
+   char              id[32];                     // SSN (IRD)
+   char              status[16];                 // status
+   __time32_t        regdate;                    // registration date
+   __time32_t        lastdate;                   // last coonection time
+   //--- trade settings
+   int               leverage;                   // leverage
+   int               agent_account;              // agent account
+   __time32_t        timestamp;                  // timestamp
+   int               last_ip;                    // last visit ip
+   //--- trade data
+   double            balance;                    // balance
+   double            prevmonthbalance;           // previous month balance
+   double            prevbalance;                // previous day balance
+   double            credit;                     // credit
+   double            interestrate;               // accumulated interest rate
+   double            taxes;                      // taxes
+   double            prevmonthequity;            // previous month equity
+   double            prevequity;                 // previous day equity
+   double            reserved2[2];               // for future use
+   //---
+   char              otp_secret[32];             // one-time password secret
+   char              secure_reserved[240];       // secure data reserved
+   int               send_reports;               // enable send reports by email
+   unsigned int      mqid;                       // MQ client identificator
+   COLORREF          user_color;                 // color got to client (used by MT Manager)
+   //---
+   char              unused[40];                 // for future use
+   char              api_data[16];               // for API usage
+  };
+//+------------------------------------------------------------------+
+//| Users group operation                                            |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct GroupCommandInfo
+  {
+   int               len;              // length of users list
+   char              command;          // group coommand
+   char              newgroup[16];     // new group
+   int               leverage;         // new leverage
+   int               reserved[8];      // reserved
+  };
+#pragma pack(pop)
+//--- group commands
+enum { GROUP_DELETE,GROUP_ENABLE,GROUP_DISABLE,GROUP_LEVERAGE,GROUP_SETGROUP };
+//+------------------------------------------------------------------+
+//| Online user description                                          |
+//+------------------------------------------------------------------+
+struct OnlineRecord
+  {
+   int               counter;       // connections counter
+   int               reserved;      // reserved
+   int               login;         // user login
+   UINT              ip;            // connection ip address
+   char              group[16];     // user group
+  };
+//+------------------------------------------------------------------+
+//| Trade Record                                                     |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct TradeRecord
+  {
+   int               order;            // order ticket
+   int               login;            // owner's login
+   char              symbol[12];       // security
+   int               digits;           // security precision
+   int               cmd;              // trade command
+   int               volume;           // volume
+   //---
+   __time32_t        open_time;        // open time
+   int               state;            // reserved
+   double            open_price;       // open price
+   double            sl,tp;            // stop loss & take profit
+   __time32_t        close_time;       // close time
+   int               gw_volume;        // gateway order volume
+   __time32_t        expiration;       // pending order's expiration time
+   char              reason;           // trade reason
+   char              conv_reserv[3];   // reserved fields
+   double            conv_rates[2];    // convertation rates from profit currency to group deposit currency
+                                       // (first element-for open time, second element-for close time)
+   double            commission;       // commission
+   double            commission_agent; // agent commission
+   double            storage;          // order swaps
+   double            close_price;      // close price
+   double            profit;           // profit
+   double            taxes;            // taxes
+   int               magic;            // special value used by client experts
+   char              comment[32];      // comment
+   int               gw_order;         // gateway order ticket
+   int               activation;       // used by MT Manager
+   short             gw_open_price;    // gateway order price deviation (pips) from order open price
+   short             gw_close_price;   // gateway order price deviation (pips) from order close price
+   double            margin_rate;      // margin convertation rate (rate of convertation from margin currency to deposit one)
+   __time32_t        timestamp;        // timestamp
+   int               api_data[4];      // for api usage
+   TradeRecord *__ptr32 next;          // internal data
+  };
+#pragma pack(pop)
+//--- trade commands
+enum { OP_BUY=0,OP_SELL,OP_BUY_LIMIT,OP_SELL_LIMIT,OP_BUY_STOP,OP_SELL_STOP,OP_BALANCE,OP_CREDIT };
+//--- trade record state
+enum { TS_OPEN_NORMAL, TS_OPEN_REMAND, TS_OPEN_RESTORED, TS_CLOSED_NORMAL, TS_CLOSED_PART, TS_CLOSED_BY, TS_DELETED };
+//--- trade record reasons
+enum
+  {
+   TR_REASON_CLIENT =0,  // client terminal
+   TR_REASON_EXPERT =1,  // expert
+   TR_REASON_DEALER =2,  // dealer
+   TR_REASON_SIGNAL =3,  // signal
+   TR_REASON_GATEWAY=4,  // gateway
+   TR_REASON_MOBILE =5,  // mobile terminal
+   TR_REASON_WEB    =6,  // Web terminal
+   TR_REASON_API    =7,  // API
+  };
+//--- activation types
+//--- *_ROLLBACK=current price roll back from activation price level
+enum
+  {
+   //--- no activation
+   ACTIVATION_NONE=0,
+   //--- stoploss, takeprofit, pendings
+   ACTIVATION_SL,ACTIVATION_TP,ACTIVATION_PENDING,
+   //--- stopout
+   ACTIVATION_STOPOUT,
+   //--- rollbacks
+   ACTIVATION_SL_ROLLBACK     =-ACTIVATION_SL,
+   ACTIVATION_TP_ROLLBACK     =-ACTIVATION_TP,
+   ACTIVATION_PENDING_ROLLBACK=-ACTIVATION_PENDING,
+   ACTIVATION_STOPOUT_ROLLBACK=-ACTIVATION_STOPOUT
+  };
+//+------------------------------------------------------------------+
+//| TradeRecord restoring from backup result                         |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct TradeRestoreResult
+  {
+   int               order;            // order
+   UCHAR             res;              // RET_OK    - order restored
+                                       // RET_ERROR - error restoring order
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Trade transaction                                                |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct TradeTransInfo
+  {
+   UCHAR             type;             // trade transaction type
+   char              flags;            // flags
+   short             cmd;              // trade command
+   int               order,orderby;    // order, order by
+   char              symbol[12];       // trade symbol
+   int               volume;           // trade volume
+   double            price;            // trade price
+   double            sl,tp;            // stoploss, takeprofit
+   int               ie_deviation;     // deviation on IE
+   char              comment[32];      // comment
+   __time32_t        expiration;       // pending order expiration time
+   int               crc;              // crc
+  };
+#pragma pack(pop)
+//--- trade transaction types
+enum
+  {
+   //---
+   TT_PRICES_GET,                      // prices requets
+   TT_PRICES_REQUOTE,                  // requote
+   //--- client trade transaction
+   TT_ORDER_IE_OPEN=64,                // open order (Instant Execution)
+   TT_ORDER_REQ_OPEN,                  // open order (Request Execution)
+   TT_ORDER_MK_OPEN,                   // open order (Market Execution)
+   TT_ORDER_PENDING_OPEN,              // open pending order
+   //---
+   TT_ORDER_IE_CLOSE,                  // close order (Instant Execution)
+   TT_ORDER_REQ_CLOSE,                 // close order (Request Execution)
+   TT_ORDER_MK_CLOSE,                  // close order (Market Execution)
+   //---
+   TT_ORDER_MODIFY,                    // modify pending order
+   TT_ORDER_DELETE,                    // delete pending order
+   TT_ORDER_CLOSE_BY,                  // close order by order
+   TT_ORDER_CLOSE_ALL,                 // close all orders by symbol
+   //--- broker trade transactions
+   TT_BR_ORDER_OPEN,                   // open order
+   TT_BR_ORDER_CLOSE,                  // close order
+   TT_BR_ORDER_DELETE,                 // delete order (ANY OPEN ORDER!!!)
+   TT_BR_ORDER_CLOSE_BY,               // close order by order
+   TT_BR_ORDER_CLOSE_ALL,              // close all orders by symbol
+   TT_BR_ORDER_MODIFY,                 // modify open price, stoploss, takeprofit etc. of order
+   TT_BR_ORDER_ACTIVATE,               // activate pending order
+   TT_BR_ORDER_COMMENT,                // modify comment of order
+   TT_BR_BALANCE                       // balance/credit
+  };
+//--- trade request flags
+enum EnReqFlags
+  {
+   TT_FLAG_NONE   =0x00000000,         // flags none
+   TT_FLAG_SIGNAL =0x00000001,         // placed by signal
+   TT_FLAG_EXPERT =0x00000002,         // placed by expert
+   TT_FLAG_GATEWAY=0x00000004,         // placed by gateway
+   TT_FLAG_MOBILE =0x00000008,         // placed by mobile terminal
+   TT_FLAG_WEB    =0x00000010,         // placed by web terminal
+   TT_FLAG_API    =0x00000020,         // placed by api
+  };
+//+------------------------------------------------------------------+
+//| Margin level of the user                                         |
+//+------------------------------------------------------------------+
+struct MarginLevel
+  {
+   int               login;            // user login
+   char              group[16];        // user group
+   int               leverage;         // user leverage
+   int               updated;          // (internal)
+   double            balance;          // balance+credit
+   double            equity;           // equity
+   int               volume;           // lots
+   double            margin;           // margin requirements
+   double            margin_free;      // free margin
+   double            margin_level;     // margin level
+   int               margin_type;      // margin controlling type (percent/currency)
+   int               level_type;       // level type(ok/margincall/stopout)
+  };
+//--- margin level type
+enum { MARGINLEVEL_OK=0, MARGINLEVEL_MARGINCALL, MARGINLEVEL_STOPOUT };
+//+------------------------------------------------------------------+
+//| Trade request                                                    |
+//+------------------------------------------------------------------+
+struct RequestInfo
+  {
+   //--- general props
+   int               id;                  // request id
+   char              status;              // request status
+   DWORD             time;                // request time
+   int               manager;             // manager processing request (if any)
+   //--- user info
+   int               login;               // user login
+   char              group[16];           // user group
+   double            balance;             // user balance
+   double            credit;              // user credit
+   //--- processing trade transaction
+   double            prices[2];           // bid/ask
+   TradeTransInfo    trade;               // trade transaction
+   int               gw_volume;           // gateway order volume
+   int               gw_order;            // gateway order ticket
+   short             gw_price;            // gateway order price deviation (pips) from request price
+   //---
+   RequestInfo* __ptr32 prev;
+   RequestInfo* __ptr32 next;             // (internal use)
+  };
+//--- trade request status
+enum { DC_EMPTY,DC_REQUEST,DC_LOCKED,DC_ANSWERED,DC_RESETED,DC_CANCELED };
+//--- time conversion ratio
+#define TIME_RATE         ((double)1.6777216)
+//--- conversion from our time to standard __time32_t
+#define STDTIME(custom_time) ((DWORD)((double)(custom_time)*TIME_RATE))
+//--- conversion from standard __time32_t to our time
+#define OURTIME(stdtime)     ((DWORD)((double)(stdtime)/TIME_RATE))
+//--- request confirmation modes
+enum EnConfirmModes
+  {
+   CONFIRM_MODE_ADD_PRICES=0x00000001,    // throw in prices
+   CONFIRM_MODE_PACKET    =0x00000002     // multiple execution
+  };
+//+------------------------------------------------------------------+
+//| Daily report                                                     |
+//+------------------------------------------------------------------+
+struct DailyReport
+  {
+   int               login;                // login
+   __time32_t        ctm;                  // time
+   char              group[16];            // group
+   char              bank[64];             // bank
+   double            balance_prev;         // previous balance
+   double            balance;              // balance
+   double            deposit;              // deposit
+   double            credit;               // credit
+   double            profit_closed;        // closed profit/loss
+   double            profit;               // floating profit/loss
+   double            equity;               // equity
+   double            margin;               // used margin
+   double            margin_free;          // free margin
+   //---
+   int               next;                 // (internal)
+   int               reserved[3];          // reserved
+  };
+//+------------------------------------------------------------------+
+//| Reports request                                                  |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct ReportGroupRequest
+  {
+   char              name[32];            // request group name
+   __time32_t        from;                // from
+   __time32_t        to;                  // to
+   int               total;               // total logins in request group
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Daily reports request                                            |
+//+------------------------------------------------------------------+
+struct DailyGroupRequest
+  {
+   char              name[32];            // group name
+   __time32_t        from;                // from
+   __time32_t        to;                  // to
+   int               total;               // total logins in request group
+   int               reserved;            // reserved
+  };
+//+------------------------------------------------------------------+
+//| Selected symbol information                                      |
+//+------------------------------------------------------------------+
+struct SymbolInfo
+  {
+   char              symbol[12];            // symbol name
+   int               digits;                // floating point digits
+   int               count;                 // symbol counter
+   int               visible;               // visibility
+   //---
+   int               type;                  // symbol type (symbols group index)
+   double            point;                 // symbol point=1/pow(10,digits)
+   int               spread;                // symbol spread
+   int               spread_balance;        // spread balance
+   //---
+   int               direction;             // direction
+   int               updateflag;            // update flag
+   __time32_t        lasttime;              // last tick time
+   double            bid,ask;               // bid, ask
+   double            high,low;              // high, low
+   double            commission;            // commission
+   int               comm_type;             // commission type
+  };
+//--- symbol price direction
+enum { SDIR_UP,SDIR_DOWN,SDIR_NONE };
+//+------------------------------------------------------------------+
+//| Symbol summary                                                   |
+//+------------------------------------------------------------------+
+struct SymbolSummary
+  {
+   char              symbol[12];          // symbol
+   int               count;               // symbol counter
+   int               digits;              // floating point digits
+   int               type;                // symbol type (symbol group index)
+   //--- clients summary
+   int               orders;              // number of client orders
+   __int64           buylots;             // buy volume
+   __int64           selllots;            // sell volume
+   double            buyprice;            // average buy price
+   double            sellprice;           // average sell price
+   double            profit;              // clients profit
+   //--- coverage summary
+   int               covorders;           // number of coverage orders
+   __int64           covbuylots;          // buy volume
+   __int64           covselllots;         // sell volume
+   double            covbuyprice;         // average buy price
+   double            covsellprice;        // average sell price
+   double            covprofit;           // coverage profit
+  };
+//+------------------------------------------------------------------+
+//| Currence exposure                                                |
+//+------------------------------------------------------------------+
+struct ExposureValue
+  {
+   char              currency[4];         // currency
+   double            clients;             // clients volume
+   double            coverage;            // coverage volume
+  };
+//+------------------------------------------------------------------+
+//| Symbol properties                                                |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct SymbolPropertiesOld
+  {
+   char              symbol[12];             // symbol
+   COLORREF          color;                  // symbol color
+   int               spread;                 // symbol spread
+   int               spread_balance;         // spread balance
+   int               stops_level;            // stops level
+   int               exemode;                // execution mode
+  };
+#pragma pack(pop)
+//---
+#pragma pack(push,1)
+struct SymbolProperties
+  {
+   char              symbol[12];            // symbol
+   COLORREF          color;                 // symbol color
+   int               spread;                // symbol spread
+   int               spread_balance;        // spread balance
+   int               stops_level;           // stops level
+   int               smoothing;             // smoothing
+   int               exemode;               // execution mode
+   int               reserved[8];           // reserved
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Symbol tick                                                      |
+//+------------------------------------------------------------------+
+struct TickInfo
+  {
+   char              symbol[12];             // symbol
+   __time32_t        ctm;                    // tick time
+   double            bid;                    // bid
+   double            ask;                    // ask
+  };
+//+------------------------------------------------------------------+
+//| Mail                                                             |
+//+------------------------------------------------------------------+
+struct MailBox
+  {
+   __time32_t        time;                   // receive time
+   int               sender;                 // mail sender (login)
+   char              from[64];               // mail sender (name)
+   int               to;                     // mail recipient
+   char              subject[128];           // mail sumbect
+   int               readed;                 // readed flag
+   char* __ptr32     body;                   // pointer to mail body
+   int               bodylen;                // mail body length
+   short             build_min;              // minimum build
+   short             build_max;              // maximum build
+   int               reserved;               // reserved
+  };
+//+------------------------------------------------------------------+
+//| News topic                                                       |
+//+------------------------------------------------------------------+
+struct NewsTopic
+  {
+   ULONG             key;                    // news key
+   __time32_t        time;                   // news time
+   char              ctm[32];                // news source time ("yyyy/mm/dd hh:mm:ss")
+   char              topic[256];             // news topic
+   char              category[64];           // news category
+   char              keywords[256];          // news keywords
+   char* __ptr32     body;                   // body (if present)
+   int               bodylen;                // body length
+   int               readed;                 // readed flag
+   int               priority;               // news priority: 0-general, 1-high
+   int               langid;                 // news LANGID
+   int               reserved[1];
+  };
+//+------------------------------------------------------------------+
+//| Extended news structure                                          |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct NewsTopicNew
+  {
+   //--- constants
+   enum constants
+     {
+      MAX_NEWS_BODY_LEN=15*1024*1024         // max. body len
+     };
+   //--- news topic flags
+   enum EnNewsFlags
+     {
+      FLAG_PRIORITY    =1,                   // priority flag
+      FLAG_CALENDAR    =2,                   // calendar item flag
+      FLAG_MIME        =4,                   // MIME news content
+      FLAG_ALLOW_DEMO  =8                    // allow body for demo accounts
+     };
+   ULONG             key;                    // news key
+   UINT              language;               // news language (WinAPI LANGID)
+   wchar_t           subject[256];           // news subject
+   wchar_t           category[256];          // news category
+   UINT              flags;                  // EnNewsFlags
+   wchar_t* __ptr32  body;                   // body
+   UINT              body_len;               // body length
+   UINT              languages_list[32];     // list of languages available for news
+   INT64             datetime;               // news time
+   UINT              reserved[30];           // reserved
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Server journal record                                            |
+//+------------------------------------------------------------------+
+struct ServerLog
+  {
+   int               code;                   // code
+   char              time[24];               // time
+   char              ip[256];                // ip
+   char              message[512];           // message
+  };
+//--- log record codes
+enum EnErrLogTypes { 
+                    CmdOK,                  // OK
+                    CmdTrade,               // trades only
+                    CmdLogin,               // logins only
+                    CmdWarn,                // warnings
+                    CmdErr,                 // errors
+                    CmdAtt                  // attention, important errors
+                   };
+//--- request logs type
+enum EnLogType     { 
+                    LOG_TYPE_STANDARD=0,    // all except logins
+                    LOG_TYPE_LOGINS  =1,    // logins only
+                    LOG_TYPE_TRADES  =2,    // trades only
+                    LOG_TYPE_ERRORS  =3,    // errors
+                    LOG_TYPE_FULL    =4,    // full log
+                    //---
+                    LOG_TYPE_UPDATER =16,   // live update
+                    LOG_TYPE_SENDMAIL=17,   // send mail
+                    LOG_TYPE_FAILOVER=18    // failover
+                   };
+//--- request logs type
+enum EnLogMode     { 
+                    LOG_MODE_ENABLED,       // manager api logs enabled
+                    LOG_MODE_DISABLED,      // manager api logs disabled
+                   };
+//+------------------------------------------------------------------+
+//| Balance check                                                    |
+//+------------------------------------------------------------------+
+#pragma pack(push,1)
+struct BalanceDiff
+  {
+   int               login;
+   double            diff;
+  };
+#pragma pack(pop)
+//+------------------------------------------------------------------+
+//| Pumping notification codes                                       |
+//+------------------------------------------------------------------+
+enum
+  {
+   PUMP_START_PUMPING=0,      // pumping started
+   PUMP_UPDATE_SYMBOLS,       // update symbols
+   PUMP_UPDATE_GROUPS,        // update groups
+   PUMP_UPDATE_USERS,         // update users
+   PUMP_UPDATE_ONLINE,        // update online users
+   PUMP_UPDATE_BIDASK,        // update bid/ask
+   PUMP_UPDATE_NEWS,          // update news
+   PUMP_UPDATE_NEWS_BODY,     // update news body
+   PUMP_UPDATE_MAIL,          // update news
+   PUMP_UPDATE_TRADES,        // update trades
+   PUMP_UPDATE_REQUESTS,      // update trade requests
+   PUMP_UPDATE_PLUGINS,       // update server plugins
+   PUMP_UPDATE_ACTIVATION,    // new order for activation (sl/sp/stopout)
+   PUMP_UPDATE_MARGINCALL,    // new margin calls
+   PUMP_STOP_PUMPING,         // pumping stopped
+   PUMP_PING,                 // ping
+   PUMP_UPDATE_NEWS_NEW,      // update news in new format (NewsTopicNew structure)
+  };
+//+------------------------------------------------------------------+
+//| Dealing notification codes                                       |
+//+------------------------------------------------------------------+
+enum
+  {
+   DEAL_START_DEALING=0,      // dealing dispatcher started
+   DEAL_REQUEST_NEW,          // new request
+   DEAL_STOP_DEALING          // dealing dispatcher stopped
+  };
+//+------------------------------------------------------------------+
+//| Notification callback function                                   |
+//+------------------------------------------------------------------+
+typedef void (__stdcall *MTAPI_NOTIFY_FUNC)(int code);
+//+------------------------------------------------------------------+
+//| Notification callback function                                   |
+//+------------------------------------------------------------------+
+typedef void (__stdcall *MTAPI_NOTIFY_FUNC_EX)(int code,int type,void * data,void *param);
+//+------------------------------------------------------------------+
+//| MetaTrader Manager Interface                                     |
+//+------------------------------------------------------------------+
+class CManagerInterface
+  {
+public:
+//--- dummy methods for delphi
+   virtual int    __stdcall QueryInterface(REFIID riid,LPVOID* obj)=0;
+   virtual int    __stdcall AddRef() =0;
+//--- release
+   virtual int    __stdcall Release()=0;
+//--- service methods
+   virtual void   __stdcall MemFree(void* ptr)              =0;
+   virtual LPCSTR __stdcall ErrorDescription(const int code)=0;
+   virtual void   __stdcall WorkingDirectory(LPCSTR path)   =0;
+//--- connection
+   virtual int  __stdcall Connect(LPCSTR server)                =0;
+   virtual int  __stdcall Disconnect()                          =0;
+   virtual int  __stdcall IsConnected()                         =0;
+   virtual int  __stdcall Login(const int login,LPCSTR password)=0;
+   virtual int  __stdcall LoginSecured(LPCSTR key_path)         =0;
+   virtual int  __stdcall KeysSend(LPCSTR key_path)             =0;
+   virtual int  __stdcall Ping()                                =0;
+   virtual int  __stdcall PasswordChange(LPCSTR pass,const int is_investor)=0;
+   virtual int  __stdcall ManagerRights(ConManager *man)        =0;
+//--- server administration commands
+   virtual int  __stdcall SrvRestart()        =0;
+   virtual int  __stdcall SrvChartsSync()     =0;
+   virtual int  __stdcall SrvLiveUpdateStart()=0;
+   virtual int  __stdcall SrvFeedsRestart()   =0;
+//--- server configuration
+   //--- configuration request
+   virtual int  __stdcall CfgRequestCommon(ConCommon *cfg)=0;
+   virtual int  __stdcall CfgRequestTime(ConTime *cfg)    =0;
+   virtual int  __stdcall CfgRequestBackup(ConBackup *cfg)=0;
+   virtual int  __stdcall CfgRequestSymbolGroup(ConSymbolGroup *cfg)=0;
+   virtual ConAccess*      __stdcall CfgRequestAccess(int *total)    =0;
+   virtual ConDataServer*  __stdcall CfgRequestDataServer(int *total)=0;
+   virtual ConHoliday*     __stdcall CfgRequestHoliday(int *total)   =0;
+   virtual ConSymbol*      __stdcall CfgRequestSymbol(int *total)    =0;
+   virtual ConGroup*       __stdcall CfgRequestGroup(int *total)     =0;
+   virtual ConManager*     __stdcall CfgRequestManager(int *total)   =0;
+   virtual ConFeeder*      __stdcall CfgRequestFeeder(int *total)    =0;
+   virtual ConLiveUpdate*  __stdcall CfgRequestLiveUpdate(int *total)=0;
+   virtual ConSync*        __stdcall CfgRequestSync(int *total)      =0;
+   virtual ConPluginParam* __stdcall CfgRequestPlugin(int *total)    =0;
+   //--- configuration update
+   virtual int  __stdcall CfgUpdateCommon(const ConCommon* cfg)                        =0;
+   virtual int  __stdcall CfgUpdateAccess(const ConAccess* cfg,const int pos)          =0;
+   virtual int  __stdcall CfgUpdateDataServer(const ConDataServer *cfg,const int pos)  =0;
+   virtual int  __stdcall CfgUpdateTime(const ConTime *cfg)                            =0;
+   virtual int  __stdcall CfgUpdateHoliday(const ConHoliday *cfg,const int pos)        =0;
+   virtual int  __stdcall CfgUpdateSymbol(const ConSymbol *cfg)                        =0;
+   virtual int  __stdcall CfgUpdateSymbolGroup(const ConSymbolGroup *cfg,const int pos)=0;
+   virtual int  __stdcall CfgUpdateGroup(const ConGroup *cfg)                          =0;
+   virtual int  __stdcall CfgUpdateManager(const ConManager *cfg)                      =0;
+   virtual int  __stdcall CfgUpdateFeeder(const ConFeeder *cfg)                        =0;
+   virtual int  __stdcall CfgUpdateBackup(const ConBackup *cfg)                        =0;
+   virtual int  __stdcall CfgUpdateLiveUpdate(const ConLiveUpdate *cfg)                =0;
+   virtual int  __stdcall CfgUpdateSync(const ConSync *cfg)                            =0;
+   virtual int  __stdcall CfgUpdatePlugin(const ConPlugin *cfg,const PluginCfg *parupd,const int total)=0;
+   //--- configuration delete
+   virtual int  __stdcall CfgDeleteAccess(const int pos)    =0;
+   virtual int  __stdcall CfgDeleteDataServer(const int pos)=0;
+   virtual int  __stdcall CfgDeleteHoliday(const int pos)   =0;
+   virtual int  __stdcall CfgDeleteSymbol(const int pos)    =0;
+   virtual int  __stdcall CfgDeleteGroup(const int pos)     =0;
+   virtual int  __stdcall CfgDeleteManager(const int pos)   =0;
+   virtual int  __stdcall CfgDeleteFeeder(const int pos)    =0;
+   virtual int  __stdcall CfgDeleteLiveUpdate(const int pos)=0;
+   virtual int  __stdcall CfgDeleteSync(const int pos)      =0;
+   //--- configuration shift
+   virtual int  __stdcall CfgShiftAccess(const int pos,const int shift)    =0;
+   virtual int  __stdcall CfgShiftDataServer(const int pos,const int shift)=0;
+   virtual int  __stdcall CfgShiftHoliday(const int pos,const int shift)   =0;
+   virtual int  __stdcall CfgShiftSymbol(const int pos,const int shift)    =0;
+   virtual int  __stdcall CfgShiftGroup(const int pos,const int shift)     =0;
+   virtual int  __stdcall CfgShiftManager(const int pos,const int shift)   =0;
+   virtual int  __stdcall CfgShiftFeeder(const int pos,const int shift)    =0;
+   virtual int  __stdcall CfgShiftLiveUpdate(const int pos,const int shift)=0;
+   virtual int  __stdcall CfgShiftSync(const int pos,const int shift)      =0;
+   virtual int  __stdcall CfgShiftPlugin(const int pos,const int shift)    =0;
+//--- server feeders
+   virtual ServerFeed* __stdcall SrvFeeders(int *total)            =0;
+   virtual LPSTR       __stdcall SrvFeederLog(LPCSTR name,int *len)=0;
+//--- chart bases
+   virtual RateInfoOld* __stdcall ChartRequestObsolete(const ChartInfo *chart,__time32_t *timesign,int *total)           =0;
+   virtual int          __stdcall ChartAddObsolete(LPCSTR symbol,const int period,const RateInfoOld* rates,int *count)   =0;
+   virtual int          __stdcall ChartUpdateObsolete(LPCSTR symbol,const int period,const RateInfoOld* rates,int *count)=0;
+   virtual int          __stdcall ChartDeleteObsolete(LPCSTR symbol,const int period,const RateInfoOld* rates,int *count)=0;
+//--- performance info
+   virtual PerformanceInfo* __stdcall PerformanceRequest(__time32_t from,int *total)=0;
+//--- users/trades backups
+   virtual BackupInfo*  __stdcall BackupInfoUsers(const int mode,int *total) =0;
+   virtual BackupInfo*  __stdcall BackupInfoOrders(const int mode,int *total)=0;
+   virtual UserRecord*  __stdcall BackupRequestUsers(LPCSTR file,LPCSTR request,int *total) =0;
+   virtual TradeRecord* __stdcall BackupRequestOrders(LPCSTR file,LPCSTR request,int *total)=0;
+   virtual int          __stdcall BackupRestoreUsers(const UserRecord *users,const int total)     =0;
+   virtual TradeRestoreResult* __stdcall BackupRestoreOrders(const TradeRecord *trades,int *total)=0;
+//--- administrator databases commands
+   virtual UserRecord*  __stdcall AdmUsersRequest(LPCSTR group,int *total)          =0;
+   virtual TradeRecord* __stdcall AdmTradesRequest(LPCSTR group,const int open_only,int *total)=0;
+   virtual int          __stdcall AdmBalanceCheckObsolete(int *logins,int *total)   =0;
+   virtual int          __stdcall AdmBalanceFix(const int *logins,const int total)  =0;
+   virtual int          __stdcall AdmTradesDelete(const int *orders,const int total)=0;
+   virtual int          __stdcall AdmTradeRecordModify(const TradeRecord *trade)    =0;
+//--- symbols
+   virtual int          __stdcall SymbolsRefresh()                           =0;
+   virtual ConSymbol*   __stdcall SymbolsGetAll(int *total)                  =0;
+   virtual int          __stdcall SymbolGet(LPCSTR symbol,ConSymbol *cs)     =0;
+   virtual int          __stdcall SymbolInfoGet(LPCSTR symbol,SymbolInfo *si)=0;
+   virtual int          __stdcall SymbolAdd(LPCSTR symbol)                   =0;
+   virtual int          __stdcall SymbolHide(LPCSTR symbol)                  =0;
+//--- symbol commands
+   virtual int          __stdcall SymbolChangeObsolete(const SymbolPropertiesOld *prop)=0;
+   virtual int          __stdcall SymbolSendTick(LPCSTR symbol,const double bid,const double ask)=0;
+//--- manager commands
+   virtual ConGroup*    __stdcall GroupsRequest(int *total)                      =0;
+   virtual int          __stdcall MailSend(const MailBox* mail,const int *logins)=0;
+   virtual int          __stdcall NewsSend(const NewsTopic *news)                =0;
+//--- journal
+   virtual ServerLog*   __stdcall JournalRequest(const int mode,const __time32_t from,const __time32_t to,LPCSTR filter,int *total)=0;
+//--- databases: direct request to the server
+//--- users
+   virtual UserRecord*  __stdcall UsersRequest(int *total)                        =0;
+   virtual UserRecord*  __stdcall UserRecordsRequest(const int *logins,int *total)=0;
+   virtual int          __stdcall UserRecordNew(UserRecord *user)                 =0;
+   virtual int          __stdcall UserRecordUpdate(const UserRecord *user)        =0;
+   virtual int          __stdcall UsersGroupOp(const GroupCommandInfo *info,const int *logins)=0;
+   virtual int          __stdcall UserPasswordCheck(const int login,LPCSTR password)=0;
+   virtual int          __stdcall UserPasswordSet(const int login,LPCSTR password,const int change_investor,const int clean_pubkey)=0;
+   virtual OnlineRecord* __stdcall OnlineRequest(int *total)              =0;
+//--- orders
+   virtual int          __stdcall TradeTransaction(TradeTransInfo *info)           =0;
+   virtual TradeRecord* __stdcall TradesRequest(int *total)                        =0;
+   virtual TradeRecord* __stdcall TradeRecordsRequest(const int *orders,int *total)=0;
+   virtual TradeRecord* __stdcall TradesUserHistory(const int login,const __time32_t from,const __time32_t to,int *total)=0;
+   virtual int          __stdcall TradeCheckStops(const TradeTransInfo *trade,const double price)=0;
+//--- reports
+   virtual TradeRecord* __stdcall ReportsRequest(const ReportGroupRequest *req,const int *logins,int *total)    =0;
+   virtual DailyReport* __stdcall DailyReportsRequest(const DailyGroupRequest *req,const int *logins,int *total)=0;
+//--- external command
+   virtual int          __stdcall ExternalCommand(LPCSTR data_in,const int size_in,LPSTR *data_out,int *size_out)=0;
+//--- plugins
+   virtual int          __stdcall PluginUpdate(const ConPluginParam *plugin)=0;
+//--- pumping
+   virtual int          __stdcall PumpingSwitch(MTAPI_NOTIFY_FUNC pfnFunc,const HWND destwnd,const UINT eventmsg,const int flags)=0;
+   virtual ConGroup*    __stdcall GroupsGet(int *total)                                    =0;
+   virtual int          __stdcall GroupRecordGet(LPCSTR name,ConGroup *group)              =0;
+   virtual int          __stdcall SymbolInfoUpdated(SymbolInfo *si,const int max_info)     =0;
+   virtual UserRecord*  __stdcall UsersGet(int *total)                                     =0;
+   virtual int          __stdcall UserRecordGet(const int login,UserRecord *user)          =0;
+   virtual OnlineRecord* __stdcall OnlineGet(int *total)                                   =0;
+   virtual int          __stdcall OnlineRecordGet(const int login,OnlineRecord *user)      =0;
+   virtual TradeRecord* __stdcall TradesGet(int *total)                                    =0;
+   virtual TradeRecord* __stdcall TradesGetBySymbol(LPCSTR symbol,int *total)              =0;
+   virtual TradeRecord* __stdcall TradesGetByLogin(const int login,LPCSTR group,int *total)=0;
+   virtual TradeRecord* __stdcall TradesGetByMarket(int *total)                            =0;
+   virtual int          __stdcall TradeRecordGet(const int order,TradeRecord *trade)       =0;
+   virtual int          __stdcall TradeClearRollback(const int order)                      =0;
+   virtual MarginLevel* __stdcall MarginsGet(int *total)                                   =0;
+   virtual int          __stdcall MarginLevelGet(const int login,LPCSTR group,MarginLevel *margin)=0;
+   virtual RequestInfo* __stdcall RequestsGet(int *total)                                  =0;
+   virtual int          __stdcall RequestInfoGet(const int pos,RequestInfo *info)          =0;
+   virtual ConPlugin*   __stdcall PluginsGet(int *total)                                   =0;
+   virtual int          __stdcall PluginParamGet(const int pos,ConPluginParam *plugin)     =0;
+   virtual int          __stdcall MailLast(LPSTR path,int *length)                         =0;
+   virtual NewsTopic*   __stdcall NewsGet(int *total)                                      =0;
+   virtual int          __stdcall NewsTotal()                                              =0;
+   virtual int          __stdcall NewsTopicGet(const int pos,NewsTopic *news)              =0;
+   virtual void         __stdcall NewsBodyRequest(const int key)                           =0;
+   virtual LPSTR        __stdcall NewsBodyGet(const int key)                               =0;
+//--- dealing
+   virtual int          __stdcall DealerSwitch(MTAPI_NOTIFY_FUNC pfnFunc,const HWND destwnd,const UINT eventmsg)=0;
+   virtual int          __stdcall DealerRequestGet(RequestInfo *info)   =0;
+   virtual int          __stdcall DealerSend(const RequestInfo *info,const int requote,const int mode)=0;
+   virtual int          __stdcall DealerReject(const int id)            =0;
+   virtual int          __stdcall DealerReset(const int id)             =0;
+//---
+   virtual TickInfo*    __stdcall TickInfoLast(LPCSTR symbol,int *total)=0;
+   virtual int          __stdcall SymbolsGroupsGet(ConSymbolGroup *grp) =0;
+   virtual __time32_t   __stdcall ServerTime()                          =0;
+   virtual MailBox*     __stdcall MailsRequest(int *total)              =0;
+//--- risk management
+   virtual SymbolSummary* __stdcall SummaryGetAll(int *total)                            =0;
+   virtual int          __stdcall SummaryGet(LPCSTR symbol,SymbolSummary *info)          =0;
+   virtual int          __stdcall SummaryGetByCount(const int symbol,SymbolSummary *info)=0;
+   virtual int          __stdcall SummaryGetByType(const int sectype,SymbolSummary *info)=0;
+   virtual int          __stdcall SummaryCurrency(LPSTR cur,const int maxchars)          =0;
+   virtual ExposureValue* __stdcall ExposureGet(int *total)                              =0;
+   virtual int          __stdcall ExposureValueGet(LPCSTR cur,ExposureValue *info)       =0;
+//---
+   virtual int          __stdcall MarginLevelRequest(const int login,MarginLevel *level) =0;
+   virtual int          __stdcall HistoryCorrect(LPCSTR symbol,int *updated)             =0;
+//--- new chart bases
+   virtual RateInfo *   __stdcall ChartRequest(const ChartInfo *chart,__time32_t *timesign,int *total)            =0;
+   virtual int          __stdcall ChartAdd(LPCSTR symbol,const int period,const RateInfo *rates,int *count)   =0;
+   virtual int          __stdcall ChartUpdate(LPCSTR symbol,const int period,const RateInfo *rates,int *count)=0;
+   virtual int          __stdcall ChartDelete(LPCSTR symbol,const int period,const RateInfo *rates,int *count)=0;
+//--- ticks base
+   virtual TickRecord*  __stdcall TicksRequest(const TickRequest *request,int *total)=0;
+//--- internal methods
+   virtual int          __stdcall PumpingSwitchEx(MTAPI_NOTIFY_FUNC_EX pfnFunc,const int flags,void *param)=0;
+   virtual int          __stdcall UsersSyncStart(const __time32_t timestamp)=0;
+   virtual UserRecord*  __stdcall UsersSyncRead(int* users_total)=0;
+   virtual int*         __stdcall UsersSnapshot(int* users_total)=0;
+   virtual int          __stdcall TradesSyncStart(const __time32_t timestamp)=0;
+   virtual TradeRecord* __stdcall TradesSyncRead(int* trades_total)=0;
+   virtual int*         __stdcall TradesSnapshot(int* trades_total)=0;
+   virtual int          __stdcall DailySyncStart(const __time32_t timestamp)=0;
+   virtual DailyReport* __stdcall DailySyncRead(int* daily_total)=0;
+//--- profit recalculation
+   virtual int          __stdcall TradeCalcProfit(TradeRecord *trade)=0;
+//--- new symbol commands
+   virtual int          __stdcall SymbolChange(const SymbolProperties *prop) =0;
+//--- network statistics
+   virtual int          __stdcall BytesSent()=0;
+   virtual int          __stdcall BytesReceived()=0;
+//---
+   virtual int          __stdcall ManagerCommon(ConCommon *common)=0;
+//--- log access
+   virtual void         __stdcall LogsOut(const int code,LPCSTR source,LPCSTR msg)=0;
+   virtual void         __stdcall LogsMode(const int mode)=0;
+//--- check license
+   virtual int         __stdcall  LicenseCheck(LPCSTR license_name)=0;
+//--- gateway configs
+   virtual ConGatewayAccount* __stdcall CfgRequestGatewayAccount(int *total)=0;
+   virtual ConGatewayMarkup*  __stdcall CfgRequestGatewayMarkup(int *total)=0;
+   virtual ConGatewayRule*    __stdcall CfgRequestGatewayRule(int *total)=0;
+   //--- configuration update
+   virtual int          __stdcall CfgUpdateGatewayAccount(const ConGatewayAccount* cfg)=0;
+   virtual int          __stdcall CfgUpdateGatewayMarkup(const ConGatewayMarkup* cfg)=0;
+   virtual int          __stdcall CfgUpdateGatewayRule(const ConGatewayRule *cfg)=0;
+   //--- configuration delete
+   virtual int          __stdcall CfgDeleteGatewayAccount(const int pos)=0;
+   virtual int          __stdcall CfgDeleteGatewayMarkup(const int pos)=0;
+   virtual int          __stdcall CfgDeleteGatewayRule(const int pos)=0;
+   //--- configuration shift
+   virtual int          __stdcall CfgShiftGatewayAccount(const int pos,const int shift)=0;
+   virtual int          __stdcall CfgShiftGatewayMarkup(const int pos,const int shift)=0;
+   virtual int          __stdcall CfgShiftGatewayRule(const int pos,const int shift)=0;
+//--- administrator databases commands
+   virtual BalanceDiff* __stdcall AdmBalanceCheck(int *logins,int *total)=0;
+//--- notifications
+   virtual int          __stdcall NotificationsSend(LPWSTR metaquotes_ids,LPCWSTR message)=0;
+   virtual int          __stdcall NotificationsSend(const int* logins,const UINT logins_total,LPCWSTR message)=0;
+  };
+//+------------------------------------------------------------------+
+//| Functions                                                        |
+//+------------------------------------------------------------------+
+typedef int (*MtManVersion_t)(void);
+typedef int (*MtManCreate_t)(int version,CManagerInterface **man);
+//+------------------------------------------------------------------+
+//| Factory                                                          |
+//+------------------------------------------------------------------+
+#ifndef _MT4MANDLL
+class CManagerFactory
+  {
+private:
+   HMODULE           m_lib;
+   MtManVersion_t    m_pfnManVersion;
+   MtManCreate_t     m_pfnManCreate;
+public:
+   //--- constructor
+   CManagerFactory(LPCSTR lib_path=NULL):m_lib(NULL) 
+     {
+      Init(lib_path);
+     }
+   //--- destructor
+  ~CManagerFactory()
+     {
+      if(m_lib)
+        {
+         m_pfnManVersion=NULL;
+         m_pfnManCreate =NULL;
+         ::FreeLibrary(m_lib); 
+         m_lib=NULL;
+        }
+     }
+   //--- initialization
+   inline void Init(LPCSTR lib_path=NULL)
+     {
+      char path[256]="";
+      //---
+      if(lib_path!=NULL) 
+        {
+         strcpy_s(path,lib_path);
+         path[sizeof(path)-1]=0;
+        }
+      else               
+        { 
+         #ifndef _WIN64
+         strcpy_s(path,"mtmanapi.dll"); 
+         path[sizeof(path)-1]=0; 
+         #else
+         strcpy_s(path,"mtmanapi64.dll"); 
+         path[sizeof(path)-1]=0; 
+         #endif
+        }
+      //---
+      if(m_lib) 
+         ::FreeLibrary(m_lib);
+      if((m_lib=::LoadLibraryA(path))!=NULL)
+        {
+         m_pfnManVersion=reinterpret_cast<MtManVersion_t>(::GetProcAddress(m_lib,"MtManVersion"));
+         m_pfnManCreate =reinterpret_cast<MtManCreate_t>(::GetProcAddress(m_lib,"MtManCreate"));
+        }
+      else
+        {
+         m_pfnManVersion=NULL;
+         m_pfnManCreate =NULL;
+        }
+      //---
+     }
+   //--- winsock startup/cleanup
+   inline int WinsockStartup() const
+     {
+      WSADATA wsa;
+      return(WSAStartup(0x0202,&wsa)!=0 ? RET_ERROR:RET_OK);
+     }
+   inline void WinsockCleanup() const 
+     {
+      WSACleanup();
+     }
+   //---
+   inline int IsValid() const 
+     {
+      return(m_lib!=NULL && m_pfnManVersion!=NULL && m_pfnManCreate!=NULL) ? TRUE:FALSE;
+     }
+   inline int Version() const 
+     {
+      return(m_pfnManVersion?(*m_pfnManVersion)():0);
+     }
+   inline CManagerInterface* Create(const int version) const
+     {
+      CManagerInterface *man=NULL;
+      if(m_pfnManCreate) (*m_pfnManCreate)(version,&man);
+      return(man);
+     }
+  };
+#endif
+//+------------------------------------------------------------------+

socket/HP-Socket/Src/HPTypeDef.h

@@ -0,0 +1,328 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+/*****************************************************************************************************************************************************/
+/**************************************************************** Base Type Definitions **************************************************************/
+/*****************************************************************************************************************************************************/
+
+typedef const BYTE*	LPCBYTE, PCBYTE;
+
+/************************************************************************
+名称：连接 ID 数据类型
+描述：应用程序可以把 CONNID 定义为自身需要的类型（如：ULONG / ULONGLONG）
+************************************************************************/
+typedef ULONG_PTR	CONNID, HP_CONNID;
+
+/************************************************************************
+名称：通信组件服务状态
+描述：应用程序可以通过通信组件的 GetState() 方法获取组件当前服务状态
+************************************************************************/
+typedef enum EnServiceState
+{
+	SS_STARTING	= 0,	// 正在启动
+	SS_STARTED	= 1,	// 已经启动
+	SS_STOPPING	= 2,	// 正在停止
+	SS_STOPPED	= 3,	// 已经停止
+} En_HP_ServiceState;
+
+/************************************************************************
+名称：Socket 操作类型
+描述：应用程序的 OnClose() 事件中通过该参数标识是哪种操作导致的错误
+************************************************************************/
+typedef enum EnSocketOperation
+{
+	SO_UNKNOWN	= 0,	// Unknown
+	SO_ACCEPT	= 1,	// Acccept
+	SO_CONNECT	= 2,	// Connect
+	SO_SEND		= 3,	// Send
+	SO_RECEIVE	= 4,	// Receive
+	SO_CLOSE	= 5,	// Close
+} En_HP_SocketOperation;
+
+/************************************************************************
+名称：事件处理结果
+描述：事件的返回值，不同的返回值会影响通信组件的后续行为
+************************************************************************/
+typedef enum EnHandleResult
+{
+	HR_OK		= 0,	// 成功
+	HR_IGNORE	= 1,	// 忽略
+	HR_ERROR	= 2,	// 错误
+} En_HP_HandleResult;
+
+/************************************************************************
+名称：数据抓取结果
+描述：数据抓取操作的返回值
+************************************************************************/
+typedef enum EnFetchResult
+{
+	FR_OK				= 0,	// 成功
+	FR_LENGTH_TOO_LONG	= 1,	// 抓取长度过大
+	FR_DATA_NOT_FOUND	= 2,	// 找不到 ConnID 对应的数据
+} En_HP_FetchResult;
+
+/************************************************************************
+名称：数据发送策略
+描述：Server 组件和 Agent 组件的数据发送策略
+
+* 打包模式（默认）	：尽量把多个发送操作的数据组合在一起发送，增加传输效率
+* 安全模式			：尽量把多个发送操作的数据组合在一起发送，并控制传输速度，避免缓冲区溢出
+* 直接模式			：对每一个发送操作都直接投递，适用于负载不高但要求实时性较高的场合
+
+************************************************************************/
+typedef enum EnSendPolicy
+{
+	SP_PACK				= 0,	// 打包模式（默认）
+	SP_SAFE				= 1,	// 安全模式
+	SP_DIRECT			= 2,	// 直接模式
+} En_HP_SendPolicy;
+
+/************************************************************************
+名称：操作结果代码
+描述：组件 Start() / Stop() 方法执行失败时，可通过 GetLastError() 获取错误代码
+************************************************************************/
+typedef enum EnSocketError
+{
+	SE_OK						= NO_ERROR,	// 成功
+	SE_ILLEGAL_STATE			= 1,		// 当前状态不允许操作
+	SE_INVALID_PARAM			= 2,		// 非法参数
+	SE_SOCKET_CREATE			= 3,		// 创建 SOCKET 失败
+	SE_SOCKET_BIND				= 4,		// 绑定 SOCKET 失败
+	SE_SOCKET_PREPARE			= 5,		// 设置 SOCKET 失败
+	SE_SOCKET_LISTEN			= 6,		// 监听 SOCKET 失败
+	SE_CP_CREATE				= 7,		// 创建完成端口失败
+	SE_WORKER_THREAD_CREATE		= 8,		// 创建工作线程失败
+	SE_DETECT_THREAD_CREATE		= 9,		// 创建监测线程失败
+	SE_SOCKE_ATTACH_TO_CP		= 10,		// 绑定完成端口失败
+	SE_CONNECT_SERVER			= 11,		// 连接服务器失败
+	SE_NETWORK					= 12,		// 网络错误
+	SE_DATA_PROC				= 13,		// 数据处理错误
+	SE_DATA_SEND				= 14,		// 数据发送失败
+
+	/***** SSL Socket 扩展操作结果代码 *****/
+	SE_SSL_ENV_NOT_READY		= 101,		// SSL 环境未就绪
+} En_HP_SocketError;
+
+/************************************************************************
+名称：播送模式
+描述：UDP 组件的播送模式（组播或广播）
+************************************************************************/
+typedef enum EnCastMode
+{
+	CM_MULTICAST	= 0,	// 组播
+	CM_BROADCAST	= 1,	// 广播
+} En_HP_CastMode;
+
+
+/*****************************************************************************************************************************************************/
+/**************************************************************** SSL Type Definitions ***************************************************************/
+/*****************************************************************************************************************************************************/
+
+#ifdef _SSL_SUPPORT
+
+/************************************************************************
+名称：SSL 工作模式
+描述：标识 SSL 的工作模式，客户端模式或服务端模式
+************************************************************************/
+typedef enum EnSSLSessionMode
+{
+	SSL_SM_CLIENT	= 0,	// 客户端模式
+	SSL_SM_SERVER	= 1,	// 服务端模式
+} En_HP_SSLSessionMode;
+
+/************************************************************************
+名称：SSL 验证模式
+描述：SSL 验证模式选项，SSL_VM_PEER 可以和后面两个选项组合一起
+************************************************************************/
+typedef enum EnSSLVerifyMode
+{
+	SSL_VM_NONE					= 0x00,	// SSL_VERIFY_NONE
+	SSL_VM_PEER					= 0x01,	// SSL_VERIFY_PEER
+	SSL_VM_FAIL_IF_NO_PEER_CERT	= 0x02,	// SSL_VERIFY_FAIL_IF_NO_PEER_CERT
+	SSL_VM_CLIENT_ONCE			= 0x04,	// SSL_VERIFY_CLIENT_ONCE
+} En_HP_SSLVerifyMode;
+
+/************************************************************************
+名称：SNI 服务名称回调函数
+描述：根据服务器名称选择 SSL 证书
+参数：	
+		lpszServerName -- 服务器名称（域名）
+
+返回值：
+		0	 -- 成功，使用默认 SSL 证书
+		正数	 -- 成功，使用返回值对应的 SNI 主机证书
+		负数	 -- 失败，中断 SSL 握手
+
+************************************************************************/
+typedef int (CALLBACK *Fn_SNI_ServerNameCallback)(LPCTSTR lpszServerName);
+typedef Fn_SNI_ServerNameCallback	HP_Fn_SNI_ServerNameCallback;
+
+#endif
+
+/*****************************************************************************************************************************************************/
+/**************************************************************** HTTP Type Definitions **************************************************************/
+/*****************************************************************************************************************************************************/
+
+/************************************************************************
+名称：HTTP 版本
+描述：低字节：主版本号，高字节：次版本号
+************************************************************************/
+
+typedef enum EnHttpVersion
+{
+	HV_1_0	= MAKEWORD(1, 0),	// HTTP/1.0
+	HV_1_1	= MAKEWORD(1, 1)	// HTTP/1.1
+} En_HP_HttpVersion;
+
+/************************************************************************
+名称：URL 域
+描述：HTTP 请求行中 URL 段位的域定义
+************************************************************************/
+typedef enum EnHttpUrlField
+{ 
+	HUF_SCHEMA		= 0,	// Schema
+	HUF_HOST		= 1,	// Host
+	HUF_PORT		= 2,	// Port
+	HUF_PATH		= 3,	// Path
+	HUF_QUERY		= 4,	// Query String
+	HUF_FRAGMENT	= 5,	// Fragment
+	HUF_USERINFO	= 6,	// User Info
+	HUF_MAX			= 7,	// (Field Count)
+} En_HP_HttpUrlField;
+
+/************************************************************************
+名称：HTTP 解析结果标识
+描述：指示 HTTP 解析器是否继续执行解析操作
+************************************************************************/
+typedef enum EnHttpParseResult
+{
+	HPR_OK			= 0,	// 解析成功
+	HPR_SKIP_BODY	= 1,	// 跳过当前请求 BODY（仅用于 OnHeadersComplete 事件）
+	HPR_UPGRADE		= 2,	// 升级协议（仅用于 OnHeadersComplete 事件）
+	HPR_ERROR		= -1,	// 解析错误，终止解析，断开连接
+} En_HP_HttpParseResult;
+
+/************************************************************************
+名称：HTTP 协议升级类型
+描述：标识 HTTP 升级为哪种协议
+************************************************************************/
+typedef enum EnHttpUpgradeType
+{
+	HUT_NONE		= 0,	// 没有升级
+	HUT_WEB_SOCKET	= 1,	// WebSocket
+	HUT_HTTP_TUNNEL	= 2,	// HTTP 隧道
+	HUT_UNKNOWN		= -1,	// 未知类型
+} En_HP_HttpUpgradeType;
+
+/************************************************************************
+名称：HTTP 状态码
+描述：HTTP 标准状态码
+************************************************************************/
+typedef enum EnHttpStatusCode
+{ 
+	HSC_CONTINUE						= 100,
+	HSC_SWITCHING_PROTOCOLS				= 101,
+	HSC_PROCESSING						= 102,
+
+	HSC_OK								= 200,
+	HSC_CREATED							= 201,
+	HSC_ACCEPTED						= 202,
+	HSC_NON_AUTHORITATIVE_INFORMATION	= 203,
+	HSC_NO_CONTENT						= 204,
+	HSC_RESET_CONTENT					= 205,
+	HSC_PARTIAL_CONTENT					= 206,
+	HSC_MULTI_STATUS					= 207,
+	HSC_ALREADY_REPORTED				= 208,
+	HSC_IM_USED							= 226,
+
+	HSC_MULTIPLE_CHOICES				= 300,
+	HSC_MOVED_PERMANENTLY				= 301,
+	HSC_MOVED_TEMPORARILY				= 302,
+	HSC_SEE_OTHER						= 303,
+	HSC_NOT_MODIFIED					= 304,
+	HSC_USE_PROXY						= 305,
+	HSC_SWITCH_PROXY					= 306,
+	HSC_TEMPORARY_REDIRECT				= 307,
+	HSC_PERMANENT_REDIRECT				= 308,
+
+	HSC_BAD_REQUEST						= 400,
+	HSC_UNAUTHORIZED					= 401,
+	HSC_PAYMENT_REQUIRED				= 402,
+	HSC_FORBIDDEN						= 403,
+	HSC_NOT_FOUND						= 404,
+	HSC_METHOD_NOT_ALLOWED				= 405,
+	HSC_NOT_ACCEPTABLE					= 406,
+	HSC_PROXY_AUTHENTICATION_REQUIRED	= 407,
+	HSC_REQUEST_TIMEOUT					= 408,
+	HSC_CONFLICT						= 409,
+	HSC_GONE							= 410,
+	HSC_LENGTH_REQUIRED					= 411,
+	HSC_PRECONDITION_FAILED				= 412,
+	HSC_REQUEST_ENTITY_TOO_LARGE		= 413,
+	HSC_REQUEST_URI_TOO_LONG			= 414,
+	HSC_UNSUPPORTED_MEDIA_TYPE			= 415,
+	HSC_REQUESTED_RANGE_NOT_SATISFIABLE	= 416,
+	HSC_EXPECTATION_FAILED				= 417,
+	HSC_MISDIRECTED_REQUEST				= 421,
+	HSC_UNPROCESSABLE_ENTITY			= 422,
+	HSC_LOCKED							= 423,
+	HSC_FAILED_DEPENDENCY				= 424,
+	HSC_UNORDERED_COLLECTION			= 425,
+	HSC_UPGRADE_REQUIRED				= 426,
+	HSC_PRECONDITION_REQUIRED			= 428,
+	HSC_TOO_MANY_REQUESTS				= 429,
+	HSC_REQUEST_HEADER_FIELDS_TOO_LARGE	= 431,
+	HSC_UNAVAILABLE_FOR_LEGAL_REASONS	= 451,
+	HSC_RETRY_WITH						= 449,
+
+	HSC_INTERNAL_SERVER_ERROR			= 500,
+	HSC_NOT_IMPLEMENTED					= 501,
+	HSC_BAD_GATEWAY						= 502,
+	HSC_SERVICE_UNAVAILABLE				= 503,
+	HSC_GATEWAY_TIMEOUT					= 504,
+	HSC_HTTP_VERSION_NOT_SUPPORTED		= 505,
+	HSC_VARIANT_ALSO_NEGOTIATES			= 506,
+	HSC_INSUFFICIENT_STORAGE			= 507,
+	HSC_LOOP_DETECTED					= 508,
+	HSC_BANDWIDTH_LIMIT_EXCEEDED		= 509,
+	HSC_NOT_EXTENDED					= 510,
+	HSC_NETWORK_AUTHENTICATION_REQUIRED	= 511,
+
+	HSC_UNPARSEABLE_RESPONSE_HEADERS	= 600
+} En_HP_HttpStatusCode;
+
+/************************************************************************
+名称：Name/Value 结构体
+描述：字符串名值对结构体
+************************************************************************/
+typedef struct TNVPair
+{ 
+	LPCSTR name;
+	LPCSTR value;
+}	HP_TNVPair,
+	TParam, HP_TParam, *LPPARAM, *HP_LPPARAM,
+	THeader, HP_THeader, *LPHEADER, *HP_LPHEADER,
+	TCookie, HP_TCookie, *LPCOOKIE, *HP_LPCOOKIE;

socket/HP-Socket/Src/HttpHelper.cpp

@@ -0,0 +1,832 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "HttpHelper.h"
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+CStringA& GetHttpVersionStr(EnHttpVersion enVersion, CStringA& strResult)
+{
+	strResult.Format("HTTP/%d.%d", LOBYTE(enVersion), HIBYTE(enVersion));
+	return strResult;
+}
+
+CStringA& AdjustRequestPath(LPCSTR lpszPath, CStringA& strPath)
+{
+	strPath = lpszPath;
+
+	if(strPath.IsEmpty() || strPath.GetAt(0) != HTTP_PATH_SEPARATOR_CHAR)
+		strPath.Insert(0, HTTP_PATH_SEPARATOR_CHAR);
+
+	return strPath;
+}
+
+LPCSTR GetHttpDefaultStatusCodeDesc(EnHttpStatusCode enCode)
+{
+	switch(enCode)
+	{
+	case HSC_CONTINUE						: return "Continue";
+	case HSC_SWITCHING_PROTOCOLS			: return "Switching Protocols";
+	case HSC_PROCESSING						: return "Processing";
+
+	case HSC_OK								: return "OK";
+	case HSC_CREATED						: return "Created";
+	case HSC_ACCEPTED						: return "Accepted";
+	case HSC_NON_AUTHORITATIVE_INFORMATION	: return "Non-Authoritative Information";
+	case HSC_NO_CONTENT						: return "No Content";
+	case HSC_RESET_CONTENT					: return "Reset Content";
+	case HSC_PARTIAL_CONTENT				: return "Partial Content";
+	case HSC_MULTI_STATUS					: return "Multi-Status";
+	case HSC_ALREADY_REPORTED				: return "Already Reported";
+	case HSC_IM_USED						: return "IM Used";
+
+	case HSC_MULTIPLE_CHOICES				: return "Multiple Choices";
+	case HSC_MOVED_PERMANENTLY				: return "Moved Permanently";
+	case HSC_MOVED_TEMPORARILY				: return "Move temporarily";
+	case HSC_SEE_OTHER						: return "See Other";
+	case HSC_NOT_MODIFIED					: return "Not Modified";
+	case HSC_USE_PROXY						: return "Use Proxy";
+	case HSC_SWITCH_PROXY					: return "Switch Proxy";
+	case HSC_TEMPORARY_REDIRECT				: return "Temporary Redirect";
+	case HSC_PERMANENT_REDIRECT				: return "Permanent Redirect";
+
+	case HSC_BAD_REQUEST					: return "Bad Request";
+	case HSC_UNAUTHORIZED					: return "Unauthorized";
+	case HSC_PAYMENT_REQUIRED				: return "Payment Required";
+	case HSC_FORBIDDEN						: return "Forbidden";
+	case HSC_NOT_FOUND						: return "Not Found";
+	case HSC_METHOD_NOT_ALLOWED				: return "Method Not Allowed";
+	case HSC_NOT_ACCEPTABLE					: return "Not Acceptable";
+	case HSC_PROXY_AUTHENTICATION_REQUIRED	: return "Proxy Authentication Required";
+	case HSC_REQUEST_TIMEOUT				: return "Request Timeout";
+	case HSC_CONFLICT						: return "Conflict";
+	case HSC_GONE							: return "Gone";
+	case HSC_LENGTH_REQUIRED				: return "Length Required";
+	case HSC_PRECONDITION_FAILED			: return "Precondition Failed";
+	case HSC_REQUEST_ENTITY_TOO_LARGE		: return "Request Entity Too Large";
+	case HSC_REQUEST_URI_TOO_LONG			: return "Request-URI Too Long";
+	case HSC_UNSUPPORTED_MEDIA_TYPE			: return "Unsupported Media Type";
+	case HSC_REQUESTED_RANGE_NOT_SATISFIABLE: return "Requested Range Not Satisfiable";
+	case HSC_EXPECTATION_FAILED				: return "Expectation Failed";
+	case HSC_MISDIRECTED_REQUEST			: return "Misdirected Request";
+	case HSC_UNPROCESSABLE_ENTITY			: return "Unprocessable Entity";
+	case HSC_LOCKED							: return "Locked";
+	case HSC_FAILED_DEPENDENCY				: return "Failed Dependency";
+	case HSC_UNORDERED_COLLECTION			: return "Unordered Collection";
+	case HSC_UPGRADE_REQUIRED				: return "Upgrade Required";
+	case HSC_PRECONDITION_REQUIRED			: return "Precondition Required";
+	case HSC_TOO_MANY_REQUESTS				: return "Too Many Requests";
+	case HSC_REQUEST_HEADER_FIELDS_TOO_LARGE: return "Request Header Fields Too Large";
+	case HSC_UNAVAILABLE_FOR_LEGAL_REASONS	: return "Unavailable For Legal Reasons";
+	case HSC_RETRY_WITH						: return "Retry With";
+
+	case HSC_INTERNAL_SERVER_ERROR			: return "Internal Server Error";
+	case HSC_NOT_IMPLEMENTED				: return "Not Implemented";
+	case HSC_BAD_GATEWAY					: return "Bad Gateway";
+	case HSC_SERVICE_UNAVAILABLE			: return "Service Unavailable";
+	case HSC_GATEWAY_TIMEOUT				: return "Gateway Timeout";
+	case HSC_HTTP_VERSION_NOT_SUPPORTED		: return "HTTP Version Not Supported";
+	case HSC_VARIANT_ALSO_NEGOTIATES		: return "Variant Also Negotiates";
+	case HSC_INSUFFICIENT_STORAGE			: return "Insufficient Storage";
+	case HSC_LOOP_DETECTED					: return "Loop Detected";
+	case HSC_BANDWIDTH_LIMIT_EXCEEDED		: return "Bandwidth Limit Exceeded";
+	case HSC_NOT_EXTENDED					: return "Not Extended";
+	case HSC_NETWORK_AUTHENTICATION_REQUIRED: return "Network Authentication Required";
+
+	case HSC_UNPARSEABLE_RESPONSE_HEADERS	: return "Unparseable Response Headers";
+	default									: return "***";
+
+	}
+}
+
+static inline CStringA& AppendHeader(LPCSTR lpszName, LPCSTR lpszValue, CStringA& strValue)
+{
+	strValue.Append(lpszName);
+	strValue.Append(HTTP_HEADER_SEPARATOR);
+	strValue.Append(lpszValue);
+	strValue.Append(HTTP_CRLF);
+
+	return strValue;
+}
+
+void MakeRequestLine(LPCSTR lpszMethod, LPCSTR lpszPath, EnHttpVersion enVersion, CStringA& strValue)
+{
+	ASSERT(lpszMethod);
+
+	strValue.Format("%s %s HTTP/%d.%d%s", CStringA(lpszMethod).MakeUpper(), lpszPath, LOBYTE(enVersion), HIBYTE(enVersion), HTTP_CRLF);
+}
+
+void MakeStatusLine(EnHttpVersion enVersion, USHORT usStatusCode, LPCSTR lpszDesc, CStringA& strValue)
+{
+	if(!lpszDesc) lpszDesc = ::GetHttpDefaultStatusCodeDesc((EnHttpStatusCode)usStatusCode);
+	strValue.Format("HTTP/%d.%d %d %s%s", LOBYTE(enVersion), HIBYTE(enVersion), usStatusCode, lpszDesc, HTTP_CRLF);
+}
+
+void MakeHeaderLines(const THeader lpHeaders[], int iHeaderCount, const TCookieMap* pCookies, int iBodyLength, BOOL bRequest, int iConnFlag, LPCSTR lpszDefaultHost, USHORT usPort, CStringA& strValue)
+{
+	unordered_set<LPCSTR, str_hash_func::hash, str_hash_func::equal_to> szHeaderNames;
+
+	if(iHeaderCount > 0)
+	{
+		ASSERT(lpHeaders);
+
+		for(int i = 0; i < iHeaderCount; i++)
+		{
+			const THeader& header = lpHeaders[i];
+
+			if(header.name != nullptr)
+			{
+				ASSERT(strlen(header.name) > 0);
+
+				szHeaderNames.emplace(header.name);
+				AppendHeader(header.name, header.value, strValue);
+			}
+		}
+	}
+
+	if(	(!bRequest || iBodyLength > 0)											&&
+		(szHeaderNames.empty()													||	
+		(szHeaderNames.find(HTTP_HEADER_CONTENT_LENGTH) == szHeaderNames.end()	&&
+		szHeaderNames.find(HTTP_HEADER_TRANSFER_ENCODING) == szHeaderNames.end())))
+	{
+		char szBodyLength[16];
+		_itoa(iBodyLength, szBodyLength, 10);
+
+		AppendHeader(HTTP_HEADER_CONTENT_LENGTH, szBodyLength, strValue);
+	}
+
+	if(	(iConnFlag == 0 || iConnFlag == 1)										&&
+		(szHeaderNames.empty()													||	
+		szHeaderNames.find(HTTP_HEADER_CONNECTION) == szHeaderNames.end()		))
+	{
+		LPCSTR lpszValue = iConnFlag == 0 ? HTTP_CONNECTION_CLOSE_VALUE : HTTP_CONNECTION_KEEPALIVE_VALUE;
+		AppendHeader(HTTP_HEADER_CONNECTION, lpszValue, strValue);
+	}
+
+	if(	bRequest && lpszDefaultHost && lpszDefaultHost[0] != 0			&&
+		(szHeaderNames.empty()											||	
+		(szHeaderNames.find(HTTP_HEADER_HOST) == szHeaderNames.end())	))
+	{
+		CStringA strHost(lpszDefaultHost);
+		if(usPort != 0) strHost.AppendFormat(":%u", usPort);
+
+		AppendHeader(HTTP_HEADER_HOST, strHost, strValue);
+	}
+
+	szHeaderNames.clear();
+
+	if(pCookies != nullptr)
+	{
+		DWORD dwSize = (DWORD)pCookies->size();
+
+		if(dwSize > 0)
+		{
+			strValue.Append(HTTP_HEADER_COOKIE);
+			strValue.Append(HTTP_HEADER_SEPARATOR);
+
+			DWORD dwIndex = 0;
+
+			for(TCookieMapCI it = pCookies->begin(), end = pCookies->end(); it != end; ++it, ++dwIndex)
+			{
+				strValue.Append(it->first);
+				strValue.AppendChar(COOKIE_KV_SEP_CHAR);
+				strValue.Append(it->second);
+
+				if(dwIndex < dwSize - 1)
+					strValue.Append(HTTP_COOKIE_SEPARATOR);
+			}
+
+			strValue.Append(HTTP_CRLF);
+		}
+	}
+
+	strValue.Append(HTTP_CRLF);
+}
+
+void MakeHttpPacket(const CStringA& strHeader, const BYTE* pBody, int iLength, WSABUF szBuffer[2])
+{
+	ASSERT(pBody != nullptr || iLength == 0);
+
+	szBuffer[0].buf = (LPSTR)(LPCSTR)strHeader;
+	szBuffer[0].len = strHeader.GetLength();
+	szBuffer[1].buf = (LPSTR)(LPCSTR)pBody;
+	szBuffer[1].len = iLength;
+}
+
+BOOL MakeWSPacket(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], BYTE* pData, int iLength, ULONGLONG ullBodyLen, BYTE szHeader[HTTP_MAX_WS_HEADER_LEN], WSABUF szBuffer[2])
+{
+	ULONGLONG ullLength = (ULONGLONG)iLength;
+
+	ASSERT(pData != nullptr	|| iLength == 0);
+	ASSERT(ullBodyLen == 0	|| ullBodyLen >= ullLength);
+
+	if(ullBodyLen == 0)
+		ullBodyLen = ullLength;
+	else if(ullBodyLen < ullLength)
+	{
+		::SetLastError(ERROR_INVALID_PARAMETER);
+		return FALSE;
+	}
+
+	TBaseWSHeader bh(szHeader, TRUE);
+
+	int iHeaderLen = HTTP_MIN_WS_HEADER_LEN;
+
+	bh.set_fin(bFinal);
+	bh.set_rsv(iReserved);
+	bh.set_code(iOperationCode);
+	bh.set_mask(lpszMask ? TRUE : FALSE);
+
+	if(ullBodyLen < 126)
+		bh.set_len((BYTE)ullBodyLen);
+	else if(ullBodyLen <= 0xFFFF)
+	{
+		bh.set_len(126);
+		bh.set_extlen((USHORT)ullBodyLen);
+
+		iHeaderLen += 2;
+	}
+	else
+	{
+		bh.set_len(127);
+		*(ULONGLONG*)(szHeader + HTTP_MIN_WS_HEADER_LEN) = ::HToN64(ullBodyLen);
+
+		iHeaderLen += 8;
+	}
+
+	if(lpszMask)
+	{
+		memcpy(szHeader + iHeaderLen, lpszMask, 4);
+
+		for(int i = 0; i < iLength; i++)
+			pData[i] = pData[i] ^ lpszMask[i & 0x03];
+
+		iHeaderLen += 4;
+	}
+
+	szBuffer[0].buf = (LPSTR)(LPCSTR)szHeader;
+	szBuffer[0].len = iHeaderLen;
+	szBuffer[1].buf = (LPSTR)(LPCSTR)pData;
+	szBuffer[1].len = iLength;
+
+	return TRUE;
+}
+
+BOOL ParseUrl(const CStringA& strUrl, BOOL& bHttps, CStringA& strHost, USHORT& usPort, CStringA& strPath)
+{
+	int iSchemaLength	= (int)strlen(HTTP_SCHEMA);
+	CStringA strSchema	= strUrl.Left(iSchemaLength);
+
+	strSchema.MakeLower();
+
+	if(strSchema.Compare(HTTP_SCHEMA) == 0)
+		bHttps = FALSE;
+	else
+	{
+		iSchemaLength	= (int)strlen(HTTPS_SCHEMA);
+		strSchema		= strUrl.Left(iSchemaLength);
+
+		strSchema.MakeLower();
+
+		if(strSchema.Compare(HTTPS_SCHEMA) == 0)
+			bHttps = TRUE;
+		else
+			return FALSE;
+	}
+
+	int i = strUrl.Find(HTTP_PATH_SEPARATOR_CHAR, iSchemaLength);
+
+	if(i > 0)
+	{
+		strHost = strUrl.Mid(iSchemaLength, i - iSchemaLength);
+		strPath = strUrl.Mid(i);
+	}
+	else
+	{
+		strHost = strUrl.Mid(iSchemaLength);
+		strPath = HTTP_PATH_SEPARATOR;
+	}
+
+	if(strHost.IsEmpty() || !::isalnum(strHost.GetAt(0)))
+		return FALSE;
+
+	i = strHost.Find(HTTP_PORT_SEPARATOR_CHAR);
+
+	if(i > 0)
+	{
+		CStringA strPort = strHost.Mid(i + 1);
+		int iLength		 = strPort.GetLength();
+
+		if(iLength == 0)
+			return FALSE;
+
+		for(int j = 0; j < iLength; j++)
+		{
+			if(!::isdigit(strPort.GetAt(j)))
+				return FALSE;
+		}
+
+		usPort	= (USHORT)::atoi(strPort);
+		strHost = strHost.Mid(0, i);
+	}
+	else
+	{
+		usPort = bHttps ? HTTPS_DEFAULT_PORT : HTTP_DEFAULT_PORT;
+	}
+
+	return TRUE;
+}
+
+BOOL CodePageToUnicode(int iCodePage, const char szSrc[], WCHAR szDest[], int& iDestLength)
+{
+	ASSERT(szSrc);
+
+	int iSize = ::MultiByteToWideChar(iCodePage, 0, szSrc, -1, nullptr, 0);
+
+	if(iSize == 0 || iSize > iDestLength || !szDest || iDestLength == 0)
+	{
+		iDestLength = iSize;
+		return FALSE;
+	}
+
+	if(::MultiByteToWideChar(iCodePage, 0, szSrc, -1, szDest, iSize) != 0)
+		iDestLength = iSize;
+	else
+		iDestLength = 0;
+
+	return iDestLength != 0;
+}
+
+BOOL UnicodeToCodePage(int iCodePage, const WCHAR szSrc[], char szDest[], int& iDestLength)
+{
+	ASSERT(szSrc);
+
+	int iSize = ::WideCharToMultiByte(iCodePage, 0, szSrc, -1, nullptr, 0, nullptr, nullptr);
+
+	if(iSize == 0 || iSize > iDestLength || !szDest || iDestLength == 0)
+	{
+		iDestLength = iSize;
+		return FALSE;
+	}
+
+	if(::WideCharToMultiByte(iCodePage, 0, szSrc, -1, szDest, iSize, nullptr, nullptr) != 0)
+		iDestLength = iSize;
+	else
+		iDestLength = 0;
+
+	return iDestLength != 0;
+}
+
+BOOL GbkToUnicode(const char szSrc[], WCHAR szDest[], int& iDestLength)
+{
+	return CodePageToUnicode(CP_ACP, szSrc, szDest, iDestLength);
+}
+
+BOOL UnicodeToGbk(const WCHAR szSrc[], char szDest[], int& iDestLength)
+{
+	return UnicodeToCodePage(CP_ACP, szSrc, szDest, iDestLength);
+}
+
+BOOL Utf8ToUnicode(const char szSrc[], WCHAR szDest[], int& iDestLength)
+{
+	return CodePageToUnicode(CP_UTF8, szSrc, szDest, iDestLength);
+}
+
+BOOL UnicodeToUtf8(const WCHAR szSrc[], char szDest[], int& iDestLength)
+{
+	return UnicodeToCodePage(CP_UTF8, szSrc, szDest, iDestLength);
+}
+
+BOOL GbkToUtf8(const char szSrc[], char szDest[], int& iDestLength)
+{
+	int iMiddleLength = 0;
+	GbkToUnicode(szSrc, nullptr, iMiddleLength);
+
+	if(iMiddleLength == 0)
+	{
+		iDestLength = 0;
+		return FALSE;
+	}
+
+	unique_ptr<WCHAR[]> p(new WCHAR[iMiddleLength]);
+	VERIFY(GbkToUnicode(szSrc, p.get(), iMiddleLength));
+
+	return UnicodeToUtf8(p.get(), szDest, iDestLength);
+}
+
+BOOL Utf8ToGbk(const char szSrc[], char szDest[], int& iDestLength)
+{
+	int iMiddleLength = 0;
+	Utf8ToUnicode(szSrc, nullptr, iMiddleLength);
+
+	if(iMiddleLength == 0)
+	{
+		iDestLength = 0;
+		return FALSE;
+	}
+
+	unique_ptr<WCHAR[]> p(new WCHAR[iMiddleLength]);
+	VERIFY(Utf8ToUnicode(szSrc, p.get(), iMiddleLength));
+
+	return UnicodeToGbk(p.get(), szDest, iDestLength);
+}
+
+int Compress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	return CompressEx(lpszSrc, dwSrcLen, lpszDest, dwDestLen);
+}
+
+int CompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen, int iLevel, int iMethod, int iWindowBits, int iMemLevel, int iStrategy)
+{
+	z_stream stream;
+
+	stream.next_in	 = (z_const Bytef*)lpszSrc;
+	stream.avail_in	 = dwSrcLen;
+	stream.next_out	 = lpszDest;
+	stream.avail_out = dwDestLen;
+	stream.zalloc	 = nullptr;
+	stream.zfree	 = nullptr;
+	stream.opaque	 = nullptr;
+
+	int err = ::deflateInit2(&stream, iLevel, iMethod, iWindowBits, iMemLevel, iStrategy);
+
+	if(err != Z_OK) return err;
+
+	err = ::deflate(&stream, Z_FINISH);
+
+	if(err != Z_STREAM_END)
+	{
+		::deflateEnd(&stream);
+		return err == Z_OK ? Z_BUF_ERROR : err;
+	}
+
+	if(dwDestLen > stream.total_out)
+	{
+		lpszDest[stream.total_out]	= 0;
+		dwDestLen					= stream.total_out;
+	}
+
+	return ::deflateEnd(&stream);
+}
+
+int Uncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	return UncompressEx(lpszSrc, dwSrcLen, lpszDest, dwDestLen);
+}
+
+int UncompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen, int iWindowBits)
+{
+	z_stream stream;
+
+	stream.next_in	 = (z_const Bytef*)lpszSrc;
+	stream.avail_in	 = (uInt)dwSrcLen;
+	stream.next_out	 = lpszDest;
+	stream.avail_out = dwDestLen;
+	stream.zalloc	 = nullptr;
+	stream.zfree	 = nullptr;
+
+	int err = ::inflateInit2(&stream, iWindowBits);
+
+	if(err != Z_OK) return err;
+
+	err = ::inflate(&stream, Z_FINISH);
+
+	if(err != Z_STREAM_END)
+	{
+		::inflateEnd(&stream);
+		return (err == Z_NEED_DICT || (err == Z_BUF_ERROR && stream.avail_in == 0)) ? Z_DATA_ERROR : err;
+	}
+
+	if(dwDestLen > stream.total_out)
+	{
+		lpszDest[stream.total_out]	= 0;
+		dwDestLen					= stream.total_out;
+	}
+
+	return inflateEnd(&stream);
+}
+
+DWORD GuessCompressBound(DWORD dwSrcLen, BOOL bGZip)
+{
+	DWORD dwBound = ::compressBound(dwSrcLen);
+	
+	if(bGZip) dwBound += 11;
+
+	return dwBound;
+}
+
+int GZipCompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	return CompressEx(lpszSrc, dwSrcLen, lpszDest, dwDestLen, Z_DEFAULT_COMPRESSION, Z_DEFLATED, MAX_WBITS + 16);
+}
+
+int GZipUncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	return UncompressEx(lpszSrc, dwSrcLen, lpszDest, dwDestLen, MAX_WBITS + 32);
+}
+
+DWORD GZipGuessUncompressBound(const BYTE* lpszSrc, DWORD dwSrcLen)
+{
+	if(dwSrcLen < 20 || *(USHORT*)lpszSrc != 0x8B1F)
+		return 0;
+
+	return *(DWORD*)(lpszSrc + dwSrcLen - 4);
+}
+
+DWORD GuessBase64EncodeBound(DWORD dwSrcLen)
+{
+	return 4 * ((dwSrcLen + 2) / 3);
+}
+
+DWORD GuessBase64DecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen)
+{
+	if(dwSrcLen < 2)
+		return 0;
+
+	if(lpszSrc[dwSrcLen - 2] == '=')
+		dwSrcLen -= 2;
+	else if(lpszSrc[dwSrcLen - 1] == '=')
+			--dwSrcLen;
+
+	DWORD dwMod = dwSrcLen % 4;
+	DWORD dwAdd = dwMod == 2 ? 1 : (dwMod == 3 ? 2 : 0);
+
+	return 3 * (dwSrcLen / 4) + dwAdd;
+}
+
+int Base64Encode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	static const BYTE CODES[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+	DWORD dwRealLen = GuessBase64EncodeBound(dwSrcLen);
+
+	if(lpszDest == nullptr || dwDestLen < dwRealLen)
+	{
+		dwDestLen = dwRealLen;
+		return -5;
+	}
+
+	BYTE* p		= lpszDest;
+	DWORD leven	= 3 * (dwSrcLen / 3);
+	DWORD i		= 0;
+
+	for (; i < leven; i += 3)
+	{
+		*p++ = CODES[lpszSrc[0] >> 2];
+		*p++ = CODES[((lpszSrc[0] & 3) << 4) + (lpszSrc[1] >> 4)];
+		*p++ = CODES[((lpszSrc[1] & 0xf) << 2) + (lpszSrc[2] >> 6)];
+		*p++ = CODES[lpszSrc[2] & 0x3f];
+
+		lpszSrc += 3;
+	}
+
+	if(i < dwSrcLen)
+	{
+		BYTE a = lpszSrc[0];
+		BYTE b = (i + 1 < dwSrcLen) ? lpszSrc[1] : 0;
+
+		*p++ = CODES[a >> 2];
+		*p++ = CODES[((a & 3) << 4) + (b >> 4)];
+		*p++ = (i + 1 < dwSrcLen) ? CODES[((b & 0xf) << 2)] : '=';
+		*p++ = '=';
+	}  
+
+	ASSERT(dwRealLen == p - lpszDest);
+
+	if(dwDestLen > dwRealLen)
+	{
+		*p			= 0;
+		dwDestLen	= dwRealLen;
+	}
+
+	return 0;  
+}
+
+int Base64Decode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	static const BYTE MAP[256]	=
+	{ 
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 253, 255,
+		255, 253, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 253, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255,  62, 255, 255, 255,  63,
+		 52,  53,  54,  55,  56,  57,  58,  59,  60,  61, 255, 255,
+		255, 254, 255, 255, 255,   0,   1,   2,   3,   4,   5,   6,
+		  7,   8,   9,  10,  11,  12,  13,  14,  15,  16,  17,  18,
+		 19,  20,  21,  22,  23,  24,  25, 255, 255, 255, 255, 255,
+		255,  26,  27,  28,  29,  30,  31,  32,  33,  34,  35,  36,
+		 37,  38,  39,  40,  41,  42,  43,  44,  45,  46,  47,  48,
+		 49,  50,  51, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
+		255, 255, 255, 255
+	};
+
+	DWORD dwRealLen = GuessBase64DecodeBound(lpszSrc, dwSrcLen);
+
+	if(lpszDest == nullptr || dwDestLen < dwRealLen)
+	{
+		dwDestLen = dwRealLen;
+		return -5;
+	}
+
+	BYTE c;
+	int g = 3;
+	DWORD i, x, y, z;
+
+	for(i = x = y = z = 0; i < dwSrcLen || x != 0;)
+	{
+		c = i < dwSrcLen ? MAP[lpszSrc[i++]] : 254;
+
+		if(c == 255) {dwDestLen = 0; return -3;}
+		else if(c == 254) {c = 0; g--;}
+		else if(c == 253) continue;
+
+		z = (z << 6) | c;
+
+		if(++x == 4)
+		{
+			lpszDest[y++] = (BYTE)((z >> 16) & 255);
+			if (g > 1) lpszDest[y++] = (BYTE)((z >> 8) & 255);
+			if (g > 2) lpszDest[y++] = (BYTE)(z & 255);
+
+			x = z = 0;
+		}
+	}
+
+	BOOL isOK = (y == dwRealLen);
+
+	if(!isOK)
+		dwDestLen = 0;
+	else
+	{
+		if(dwDestLen > dwRealLen)
+		{
+			lpszDest[dwRealLen]	= 0;
+			dwDestLen			= dwRealLen;
+		}
+	}
+
+	return isOK ? 0 : -3;
+}
+
+DWORD GuessUrlEncodeBound(const BYTE* lpszSrc, DWORD dwSrcLen)
+{
+	DWORD dwAdd = 0;
+
+	for(DWORD i = 0; i < dwSrcLen; i++)
+	{
+		BYTE c	= lpszSrc[i];
+
+		if(!(isalnum(c) || c == ' ' || c == '.' || c == '-' || c == '_' || c == '*'))
+			dwAdd += 2;
+	}
+
+	return dwSrcLen + dwAdd;
+}
+
+DWORD GuessUrlDecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen)
+{
+	DWORD dwPercent = 0;
+
+	for(DWORD i = 0; i < dwSrcLen; i++)
+	{
+		if(lpszSrc[i] == '%')
+		{
+			++dwPercent;
+			i += 2;
+		}
+	}
+
+	DWORD dwSub = dwPercent * 2;
+
+	if(dwSrcLen < dwSub)
+		return 0;
+
+	return dwSrcLen - dwSub;
+}
+
+#define HEX_CHAR_TO_VALUE(c)			(c <= '9' ? c - '0' : (c <= 'F' ? c - 'A' + 0x0A : c - 'a' + 0X0A))
+#define HEX_DOUBLE_CHAR_TO_VALUE(pc)	(((HEX_CHAR_TO_VALUE(*(pc))) << 4) | (HEX_CHAR_TO_VALUE(*(pc + 1))))
+#define HEX_VALUE_TO_CHAR(n)			(n <= 9 ? n + '0' : (n <= 'F' ? n + 'A' - 0X0A : n + 'a' - 0X0A))
+#define HEX_VALUE_TO_DOUBLE_CHAR(pc, n)	{*(pc) = HEX_VALUE_TO_CHAR((n >> 4)); *((pc) + 1) = HEX_VALUE_TO_CHAR((n & 0X0F));}
+
+int UrlEncode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	if(lpszDest == nullptr || dwDestLen == 0)
+		goto ERROR_DEST_LEN;
+
+	BYTE c;
+	DWORD j = 0;
+
+	for(DWORD i = 0; i < dwSrcLen; i++)
+	{
+		if(j >= dwDestLen)
+			goto ERROR_DEST_LEN;
+
+		c = lpszSrc[i];
+
+		if (isalnum(c) || c == '.' || c == '-' || c == '_' || c == '*')
+			lpszDest[j++] = c;
+		else if(c == ' ')
+			lpszDest[j++] = '+';
+		else
+		{
+			if(j + 3 >= dwDestLen)
+				goto ERROR_DEST_LEN;
+
+			lpszDest[j++] = '%';
+			HEX_VALUE_TO_DOUBLE_CHAR(lpszDest + j, c);
+			j += 2;
+			
+		}
+	}
+
+	if(dwDestLen > j)
+	{
+		lpszDest[j]	= 0;
+		dwDestLen	= j;
+	}
+
+	return 0;
+
+ERROR_DEST_LEN:
+	dwDestLen = GuessUrlEncodeBound(lpszSrc, dwSrcLen);
+	return -5;
+}
+
+int UrlDecode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen)
+{
+	if(lpszDest == nullptr || dwDestLen == 0)
+		goto ERROR_DEST_LEN;
+
+	char c;
+	DWORD j = 0;
+
+	for(DWORD i = 0; i < dwSrcLen; i++)
+	{
+		if(j >= dwDestLen)
+			goto ERROR_DEST_LEN;
+
+		c = lpszSrc[i];
+
+		if(c == '+')
+			lpszDest[j++] = ' ';
+		else if(c != '%')
+			lpszDest[j++] = c;
+		else
+		{
+			if(i + 2 >= dwSrcLen)
+				goto ERROR_SRC_DATA;
+
+			lpszDest[j++] = HEX_DOUBLE_CHAR_TO_VALUE(lpszSrc + i + 1);
+			i += 2;
+		}
+	}
+
+	if(dwDestLen > j)
+	{
+		lpszDest[j]	= 0;
+		dwDestLen	= j;
+	}
+
+	return 0;
+
+ERROR_SRC_DATA:
+	dwDestLen = 0;
+	return -3;
+
+ERROR_DEST_LEN:
+	dwDestLen = GuessUrlDecodeBound(lpszSrc, dwSrcLen);
+	return -5;
+}

socket/HP-Socket/Src/HttpHelper.h

@@ -0,0 +1,1352 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "SocketHelper.h"
+#include "HttpCookie.h"
+
+#include "../../Common/Src/http/http_parser.h"
+#include "../../Common/Src/zlib/zutil.h"
+
+/************************************************************************
+名称：HTTP 全局常量
+描述：声明 HTTP 组件的公共全局常量
+************************************************************************/
+
+#define HTTP_DEFAULT_PORT					80
+#define HTTPS_DEFAULT_PORT					443
+
+#define HTTP_SCHEMA							"http://"
+#define HTTPS_SCHEMA						"https://"
+
+#define HTTP_CRLF							"\r\n"
+#define HTTP_PORT_SEPARATOR_CHAR			':'
+#define HTTP_PATH_SEPARATOR_CHAR			'/'
+#define HTTP_PATH_SEPARATOR					"/"
+#define HTTP_HEADER_SEPARATOR				": "
+#define HTTP_COOKIE_SEPARATOR				"; "
+#define HTTP_1_0_STR						"HTTP/1.0"
+#define HTTP_1_1_STR						"HTTP/1.1"
+
+#define HTTP_HEADER_HOST					"Host"
+#define HTTP_HEADER_COOKIE					"Cookie"
+#define HTTP_HEADER_SET_COOKIE				"Set-Cookie"
+#define HTTP_HEADER_CONTENT_TYPE			"Content-Type"
+#define HTTP_HEADER_CONTENT_LENGTH			"Content-Length"
+#define HTTP_HEADER_CONTENT_ENCODING		"Content-Encoding"
+#define HTTP_HEADER_TRANSFER_ENCODING		"Transfer-Encoding"
+#define HTTP_HEADER_CONNECTION				"Connection"
+#define HTTP_HEADER_UPGRADE					"Upgrade"
+#define HTTP_HEADER_VALUE_WEB_SOCKET		"WebSocket"
+
+#define HTTP_CONNECTION_CLOSE_VALUE			"close"
+#define HTTP_CONNECTION_KEEPALIVE_VALUE		"keep-alive"
+
+#define HTTP_METHOD_POST					"POST"
+#define HTTP_METHOD_PUT						"PUT"
+#define HTTP_METHOD_PATCH					"PATCH"
+#define HTTP_METHOD_GET						"GET"
+#define HTTP_METHOD_DELETE					"DELETE"
+#define HTTP_METHOD_HEAD					"HEAD"
+#define HTTP_METHOD_TRACE					"TRACE"
+#define HTTP_METHOD_OPTIONS					"OPTIONS"
+#define HTTP_METHOD_CONNECT					"CONNECT"
+
+#define HTTP_MIN_WS_HEADER_LEN				2
+#define HTTP_MAX_WS_HEADER_LEN				14
+
+#define MIN_HTTP_RELEASE_CHECK_INTERVAL		1000
+#define MIN_HTTP_RELEASE_DELAY				100
+#define MAX_HTTP_RELEASE_DELAY				(60 * 1000)
+#define DEFAULT_HTTP_RELEASE_DELAY			(3 * 1000)
+#define DEFAULT_HTTP_VERSION				HV_1_1
+
+#define DEFAULT_HTTP_SYNC_CONNECT_TIMEOUT	5000
+#define DEFAULT_HTTP_SYNC_REQUEST_TIMEOUT	10000
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+enum EnHttpSyncRequestProgress
+{
+	HSRP_DONE,
+	HSRP_WAITING,
+	HSRP_ERROR,
+	HSRP_CLOSE
+};
+
+struct TDyingConnection
+{
+	CONNID			connID;
+	DWORD			killTime;
+
+	TDyingConnection(CONNID id, DWORD kt = 0)
+	: connID		(id)
+	, killTime		(kt == 0 ? ::TimeGetTime() : kt)
+	{
+
+	}
+
+	static TDyingConnection* Construct(CONNID id, DWORD kt = 0)	{return new TDyingConnection(id, kt);}
+	static void Destruct(TDyingConnection* pObj)				{if(pObj) delete pObj;}
+
+};
+
+typedef unordered_multimap<CStringA, CStringA,
+		cstringa_hash_func::hash, cstringa_hash_func::equal_to>	THeaderMap;
+typedef THeaderMap::const_iterator								THeaderMapCI;
+typedef THeaderMap::iterator									THeaderMapI;
+
+typedef unordered_map<CStringA, CStringA,
+		cstringa_hash_func::hash, cstringa_hash_func::equal_to>	TCookieMap;
+typedef TCookieMap::const_iterator								TCookieMapCI;
+typedef TCookieMap::iterator									TCookieMapI;
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+struct TBaseWSHeader
+{
+public:
+	BOOL fin()
+	{
+		return (data >> 7) & 0x1;
+	}
+
+	void set_fin(BOOL v)
+	{
+		data |= ((v ? 1 : 0) << 7);
+	}
+
+	BYTE rsv()
+	{
+		return (data >> 4) & 0x7;
+	}
+
+	void set_rsv(BYTE v)
+	{
+		data |= ((v & 0x7) << 4);
+	}
+
+	BYTE code()
+	{
+		return data & 0xF;
+	}
+
+	void set_code(BYTE v)
+	{
+		data |= (v & 0xF);
+	}
+
+	BOOL mask()
+	{
+		return (data >> 15) & 0x1;
+	}
+
+	void set_mask(BOOL v)
+	{
+		data |= ((v ? 1 : 0) << 15);
+	}
+
+	BYTE len()
+	{
+		return (data >> 8) & 0x7F;
+	}
+
+	void set_len(BYTE v)
+	{
+		data |= ((v & 0x7F) << 8);
+	}
+
+	USHORT extlen()
+	{
+		return ntohs(data >> 16);
+	}
+
+	void set_extlen(USHORT v)
+	{
+		data |= (htons(v) << 16);
+	}
+
+	TBaseWSHeader(const BYTE* p, BOOL bZero = FALSE)
+	: data(*(UINT*)p)
+	{
+		if(bZero) data = 0;
+	}
+
+private:
+	UINT& data;
+};
+
+template<class T> struct TWSContext
+{
+public:
+	EnHandleResult Parse(const BYTE* pData, int iLength)
+	{
+		ASSERT(pData != nullptr && iLength > 0);
+
+		EnHandleResult hr	= HR_OK;
+		BYTE* pTemp			= (BYTE*)pData;
+		int iRemain			= iLength;
+		int iMin			= 0;
+
+		while(iRemain > 0)
+		{
+			if(m_bHeader)
+			{
+				iMin = min(m_iHeaderRemain, iRemain);
+				memcpy(m_szHeader + m_iHeaderLen - m_iHeaderRemain, pTemp, iMin);
+
+				m_iHeaderRemain	-= iMin;
+
+				if(m_iHeaderRemain == 0)
+				{
+					TBaseWSHeader bh(m_szHeader);
+
+					int iLen			= bh.len();
+					int iExtLen			= iLen < 126 ? 0 : (iLen == 126 ? 2 : 8);
+					int iMaskLen		= bh.mask() ? 4 : 0;
+					int iRealHeaderLen	= HTTP_MIN_WS_HEADER_LEN + iExtLen + iMaskLen;
+
+					if(m_iHeaderLen < iRealHeaderLen)
+					{
+						m_iHeaderRemain	= iRealHeaderLen - m_iHeaderLen;
+						m_iHeaderLen	= iRealHeaderLen;
+					}
+					else
+					{
+						m_ullBodyLen	= iExtLen == 0 ? iLen : (iExtLen == 2 ? bh.extlen() : NToH64(*(ULONGLONG*)(m_szHeader + HTTP_MIN_WS_HEADER_LEN)));
+						m_ullBodyRemain	= m_ullBodyLen;
+						m_lpszMask		= iMaskLen > 0 ? m_szHeader + HTTP_MIN_WS_HEADER_LEN + iExtLen : nullptr;
+
+						hr = m_pHttpObj->on_ws_message_header(bh.fin(), bh.rsv(), bh.code(), m_lpszMask, m_ullBodyLen);
+
+						if(hr == HR_ERROR)
+							break;
+
+						if(m_ullBodyLen > 0)
+							m_bHeader = FALSE;
+						else
+						{
+							hr = CompleteMessage();
+
+							if(hr == HR_ERROR)
+								break;
+						}
+					}
+				}
+			}
+			else
+			{
+				iMin = (int)min(m_ullBodyRemain, (ULONGLONG)iRemain);
+
+				if(m_lpszMask)
+				{
+					int iFactor = (m_ullBodyLen - m_ullBodyRemain) & 0x03;
+
+					for(int i = 0; i < iMin; i++)
+						pTemp[i] = pTemp[i] ^ m_lpszMask[(i + iFactor) & 0x03];
+				}
+
+				m_ullBodyRemain	-= iMin;
+
+				EnHandleResult hr = m_pHttpObj->on_ws_message_body(pTemp, iMin);
+
+				if(hr == HR_ERROR)
+					break;
+
+				if(m_ullBodyRemain == 0)
+				{
+					hr = CompleteMessage();
+
+					if(hr == HR_ERROR)
+						break;
+				}
+			}
+
+			pTemp	+= iMin;
+			iRemain	-= iMin;
+		}
+
+		return HR_OK;
+	}
+
+	BOOL GetMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain)
+	{
+		TBaseWSHeader bh(m_szHeader);
+
+		if(lpbFinal)			*lpbFinal			= bh.fin();
+		if(lpiReserved)			*lpiReserved		= bh.rsv();
+		if(lpiOperationCode)	*lpiOperationCode	= bh.code();
+		if(lpszMask)			*lpszMask			= m_lpszMask;
+		if(lpullBodyLen)		*lpullBodyLen		= m_ullBodyLen;
+		if(lpullBodyRemain)		*lpullBodyRemain	= m_ullBodyRemain;
+
+		return TRUE;
+	}
+
+	BOOL CopyData(const TWSContext& src)
+	{
+		if(&src == this)
+			return FALSE;
+
+		memcpy(m_szHeader, src.m_szHeader, HTTP_MAX_WS_HEADER_LEN);
+
+		if(src.m_lpszMask)
+			m_lpszMask = m_szHeader + (src.m_lpszMask - src.m_szHeader);
+		else
+			m_lpszMask = nullptr;
+
+		m_ullBodyLen	= src.m_ullBodyLen;
+		m_ullBodyRemain	= src.m_ullBodyRemain;
+
+		return TRUE;
+	}
+
+public:
+	TWSContext(T* pHttpObj) : m_pHttpObj(pHttpObj)
+	{
+		Reset();
+	}
+
+private:
+	EnHandleResult CompleteMessage()
+	{
+		EnHandleResult hr = m_pHttpObj->on_ws_message_complete();
+
+		Reset();
+
+		return hr;
+	}
+
+	void Reset()
+	{
+		m_bHeader		= TRUE;
+		m_lpszMask		= nullptr;
+		m_iHeaderLen	= HTTP_MIN_WS_HEADER_LEN;
+		m_iHeaderRemain	= HTTP_MIN_WS_HEADER_LEN;
+		m_ullBodyLen	= 0;
+		m_ullBodyRemain	= 0;
+	}
+
+private:
+	T* m_pHttpObj;
+
+	BYTE m_szHeader[HTTP_MAX_WS_HEADER_LEN];
+	const BYTE* m_lpszMask;
+
+	BOOL m_bHeader;
+	int m_iHeaderLen;
+	int m_iHeaderRemain;
+	ULONGLONG m_ullBodyLen;
+	ULONGLONG m_ullBodyRemain;
+};
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+/* Http 上下文结构 */
+template<class T, class S> struct THttpObjT
+{
+public:
+	EnHandleResult Execute(const BYTE* pData, int iLength)
+	{
+		ASSERT(pData != nullptr && iLength > 0);
+
+		if(m_parser.upgrade)
+		{
+			if(m_enUpgrade == HUT_WEB_SOCKET)
+				return m_pwsContext->Parse(pData, iLength);
+			else
+				return m_pContext->DoFireSuperReceive(m_pSocket, pData, iLength);
+		}
+
+		EnHandleResult hr = HR_OK;
+		int iPased		  = (int)::http_parser_execute(&m_parser, &sm_settings, (LPCSTR)pData, iLength);
+
+		if(m_parser.upgrade)
+			hr = Upgrade(pData, iLength, iPased);
+		else if(m_parser.http_errno != HPE_OK)
+		{
+			m_pContext->FireParseError(m_pSocket, m_parser.http_errno, ::http_errno_description(HTTP_PARSER_ERRNO(&m_parser)));
+			hr = HR_ERROR;
+		}
+		else
+			ASSERT(iPased == iLength);
+
+		return hr;
+	}
+
+	static int on_message_begin(http_parser* p)
+	{
+		THttpObjT* pSelf = Self(p);
+
+		pSelf->ResetHeaderState(FALSE, FALSE);
+
+		return pSelf->m_pContext->FireMessageBegin(pSelf->m_pSocket);
+	}
+
+	static int on_url(http_parser* p, const char* at, size_t length)
+	{
+		EnHttpParseResult hpr	= HPR_OK;
+		THttpObjT* pSelf		= Self(p);
+
+		pSelf->AppendBuffer(at, length);
+
+		if(p->state != s_req_http_start)
+			return hpr;
+
+		hpr = pSelf->ParseUrl();
+
+		if(hpr == HPR_OK)
+			hpr = pSelf->m_pContext->FireRequestLine(pSelf->m_pSocket, ::http_method_str((http_method)p->method), pSelf->GetBuffer());
+
+		pSelf->ResetBuffer();
+
+		return hpr;
+	}
+
+	static int on_status(http_parser* p, const char* at, size_t length)
+	{
+		EnHttpParseResult hpr	= HPR_OK;
+		THttpObjT* pSelf		= Self(p);
+
+		pSelf->AppendBuffer(at, length);
+
+		if(p->state != s_res_line_almost_done)
+			return hpr;
+
+		hpr = pSelf->m_pContext->FireStatusLine(pSelf->m_pSocket, p->status_code, pSelf->GetBuffer());
+		pSelf->ResetBuffer();
+
+		return hpr;
+	}
+
+	static int on_header_field(http_parser* p, const char* at, size_t length)
+	{
+		EnHttpParseResult hpr	= HPR_OK;
+		THttpObjT* pSelf		= Self(p);
+
+		pSelf->AppendBuffer(at, length);
+
+		if(p->state != s_header_value_discard_ws)
+			return hpr;
+
+		pSelf->m_strCurHeader = pSelf->GetBuffer();
+		pSelf->ResetBuffer();
+
+		return hpr;
+	}
+
+	static int on_header_value(http_parser* p, const char* at, size_t length)
+	{
+		EnHttpParseResult hpr	= HPR_OK;
+		THttpObjT* pSelf		= Self(p);
+
+		pSelf->AppendBuffer(at, length);
+
+		if(p->state != s_header_almost_done && p->state != s_header_field_start)
+			return hpr;
+
+		pSelf->m_headers.emplace(move(THeaderMap::value_type(pSelf->m_strCurHeader, pSelf->GetBuffer())));
+		hpr = pSelf->m_pContext->FireHeader(pSelf->m_pSocket, pSelf->m_strCurHeader, pSelf->GetBuffer());
+
+		if(hpr != HPR_ERROR)
+		{
+			if(pSelf->m_bRequest && pSelf->m_strCurHeader == HTTP_HEADER_COOKIE)
+				hpr = pSelf->ParseCookie();
+			else if(!pSelf->m_bRequest && pSelf->m_strCurHeader == HTTP_HEADER_SET_COOKIE)
+				hpr = pSelf->ParseSetCookie();
+		}
+
+		pSelf->ResetBuffer();
+
+		return hpr;
+	}
+
+	static int on_headers_complete(http_parser* p)
+	{
+		THttpObjT* pSelf = Self(p);
+
+		pSelf->CheckUpgrade();
+		pSelf->ResetHeaderBuffer();
+
+		return pSelf->m_pContext->FireHeadersComplete(pSelf->m_pSocket);
+	}
+
+	static int on_body(http_parser* p, const char* at, size_t length)
+	{
+		THttpObjT* pSelf = Self(p);
+
+		return pSelf->m_pContext->FireBody(pSelf->m_pSocket, (const BYTE*)at, (int)length);
+	}
+
+	static int on_chunk_header(http_parser* p)
+	{
+		THttpObjT* pSelf = Self(p);
+
+		if(p->state == s_chunk_data || p->state == s_header_field_start)
+			return pSelf->m_pContext->FireChunkHeader(pSelf->m_pSocket, (int)p->content_length);
+
+		return HPR_OK;
+	}
+
+	static int on_chunk_complete(http_parser* p)
+	{
+		THttpObjT* pSelf = Self(p);
+
+		if(p->state == s_headers_done || p->state == s_message_done)
+			return pSelf->m_pContext->FireChunkComplete(pSelf->m_pSocket);
+
+		return HPR_OK;
+	}
+
+	static int on_message_complete(http_parser* p)
+	{
+		THttpObjT* pSelf		= Self(p);
+		EnHttpParseResult hpr	= pSelf->m_pContext->FireMessageComplete(pSelf->m_pSocket);
+
+		return hpr;
+	}
+
+	EnHandleResult on_ws_message_header(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen)
+	{
+		return m_pContext->FireWSMessageHeader(m_pSocket, bFinal, iReserved, iOperationCode, lpszMask, ullBodyLen);
+	}
+
+	EnHandleResult on_ws_message_body(const BYTE* pData, int iLength)
+	{
+		return m_pContext->FireWSMessageBody(m_pSocket, pData, iLength);
+	}
+
+	EnHandleResult on_ws_message_complete()
+	{
+		return m_pContext->FireWSMessageComplete(m_pSocket);
+	}
+
+private:
+
+	EnHandleResult Upgrade(const BYTE* pData, int iLength, int iPased)
+	{
+		ASSERT(m_parser.upgrade);
+
+		if(m_pContext->FireUpgrade(m_pSocket, m_enUpgrade) != HPR_OK)
+			return HR_ERROR;
+
+		ResetHeaderState();
+
+		if(m_enUpgrade == HUT_WEB_SOCKET)
+			m_pwsContext = new TWSContext<THttpObjT<T, S>>(this);
+
+		if(iPased < iLength)
+			return Execute(pData + iPased, iLength - iPased);
+
+		return HR_OK;
+	}
+
+	void CheckUpgrade()
+	{
+		if(!m_parser.upgrade)
+			return;
+
+		if(m_bRequest && m_parser.method == HTTP_CONNECT)
+			m_enUpgrade = HUT_HTTP_TUNNEL;
+		else
+		{
+			LPCSTR lpszValue;
+			if(GetHeader(HTTP_HEADER_UPGRADE, &lpszValue) && _stricmp(HTTP_HEADER_VALUE_WEB_SOCKET, lpszValue) == 0)
+				m_enUpgrade = HUT_WEB_SOCKET;
+			else
+				m_enUpgrade = HUT_UNKNOWN;
+		}
+	}
+
+	EnHttpParseResult ParseUrl()
+	{
+		http_parser_url url = {0};
+
+		BOOL isConnect	= m_parser.method == HTTP_CONNECT;
+		int rs			= ::http_parser_parse_url(m_strBuffer, m_strBuffer.GetLength(), isConnect, &url);
+
+		if(rs != HPE_OK)
+		{
+			m_parser.http_errno = HPE_INVALID_URL;
+			return HPR_ERROR;
+		}
+
+		m_usUrlFieldSet		= url.field_set;
+		LPCSTR lpszBuffer	= m_strBuffer;
+
+		for(int i = 0; i < UF_MAX; i++)
+		{
+			if((url.field_set & (1 << i)) != 0)
+				m_pstrUrlFileds[i].SetString((lpszBuffer + url.field_data[i].off), url.field_data[i].len);
+		}
+
+		return HPR_OK;
+	}
+
+	EnHttpParseResult ParseCookie()
+	{
+		int i = 0;
+
+		do 
+		{
+			CStringA tk = m_strBuffer.Tokenize(COOKIE_FIELD_SEP, i);
+
+			if(i == -1)
+				break;
+
+			int j = tk.Trim().Find(COOKIE_KV_SEP_CHAR);
+
+			if(j <= 0)
+				continue;
+			/*
+			{
+				m_parser.http_errno = HPE_INVALID_HEADER_TOKEN;
+				return HPR_ERROR;
+			}
+			*/
+
+			AddCookie(tk.Left(j), tk.Mid(j + 1));
+
+		} while(TRUE);
+
+		return HPR_OK;
+	}
+
+	EnHttpParseResult ParseSetCookie()
+	{
+		CCookieMgr* pCookieMgr = m_pContext->GetCookieMgr();
+
+		if(pCookieMgr == nullptr)
+			return HPR_OK;
+
+		LPCSTR lpszDomain	= GetDomain();
+		LPCSTR lpszPath		= GetPath();
+
+		unique_ptr<CCookie> pCookie(CCookie::FromString(m_strBuffer, lpszDomain, lpszPath));
+
+		if(pCookie == nullptr)
+			return HPR_ERROR;
+
+		if(pCookie->Match(lpszDomain, lpszPath, TRUE, m_pContext->IsSecure()))
+		{
+			if(pCookie->IsExpired())
+				DeleteCookie(pCookie->name);
+			else
+				AddCookie(pCookie->name, pCookie->value);
+		}
+
+		if(pCookieMgr->IsEnableThirdPartyCookie() || pCookie->IsSameDomain(lpszDomain))
+			pCookieMgr->SetCookie(*pCookie);
+
+		return HPR_OK;
+	}
+
+public:
+	DWORD GetFreeTime() const		{return m_dwFreeTime;}
+	void SetFree()					{m_dwFreeTime = ::TimeGetTime();}
+
+	BOOL IsUpgrade()				{return m_parser.upgrade;}
+	BOOL IsKeepAlive()				{return ::http_should_keep_alive(&m_parser);}
+	USHORT GetVersion()				{return MAKEWORD(m_parser.http_major, m_parser.http_minor);}
+	ULONGLONG GetContentLength()	{return m_parser.content_length;}
+
+	LPCSTR GetMethod()				{return ::http_method_str((http_method)(m_parser.method));}
+	USHORT GetUrlFieldSet()			{return m_usUrlFieldSet;}
+	USHORT GetStatusCode()			{return m_parser.status_code;}
+
+	EnHttpUpgradeType GetUpgradeType()	{return m_enUpgrade;}
+
+	THeaderMap& GetHeaderMap()		{return m_headers;}
+	TCookieMap& GetCookieMap()		{return m_cookies;}
+
+	BOOL HasReleased()				{return m_bReleased;}
+	void Release()					{m_bReleased = TRUE;}
+
+	LPCSTR GetContentType()
+	{
+		LPCSTR lpszValue = nullptr;
+		GetHeader(HTTP_HEADER_CONTENT_TYPE, &lpszValue);
+
+		return lpszValue;
+	}
+
+	LPCSTR GetContentEncoding()
+	{
+		LPCSTR lpszValue = nullptr;
+		GetHeader(HTTP_HEADER_CONTENT_ENCODING, &lpszValue);
+
+		return lpszValue;
+	}
+
+	LPCSTR GetTransferEncoding()
+	{
+		LPCSTR lpszValue = nullptr;
+		GetHeader(HTTP_HEADER_TRANSFER_ENCODING, &lpszValue);
+
+		return lpszValue;
+	}
+
+	LPCSTR GetHost()
+	{
+		LPCSTR lpszValue = nullptr;
+		GetHeader(HTTP_HEADER_HOST, &lpszValue);
+
+		return lpszValue;
+	}
+
+	USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr)
+	{
+		if(lpszErrorDesc)
+			*lpszErrorDesc = ::http_errno_description(HTTP_PARSER_ERRNO(&m_parser));
+
+		return m_parser.http_errno;
+	}
+
+	LPCSTR GetUrlField(EnHttpUrlField enField)
+	{
+		ASSERT(m_bRequest && enField < HUF_MAX);
+
+		if(!m_bRequest || enField >= HUF_MAX)
+			return nullptr;
+
+		return m_pstrUrlFileds[enField];
+	}
+
+	LPCSTR GetPath()
+	{
+		if(m_bRequest)
+			return GetUrlField(HUF_PATH);
+		else
+			return *m_pstrRequestPath;
+	}
+
+	LPCSTR GetDomain()
+	{
+		ASSERT(!m_bRequest);
+
+		return m_pContext->GetRemoteDomain(m_pSocket);
+	}
+
+	LPCSTR GetRequestPath()
+	{
+		if(m_bRequest)
+			return nullptr;
+
+		return *m_pstrRequestPath;
+	}
+
+	void SetRequestPath(LPCSTR lpszPath)
+	{
+		ASSERT(!m_bRequest);
+
+		if(!m_bRequest)
+			*m_pstrRequestPath = lpszPath;
+	}
+
+	BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue)
+	{
+		ASSERT(lpszName);
+
+		BOOL isOK		= FALSE;
+		THeaderMapCI it = m_headers.find(lpszName);
+
+		if(it != m_headers.end())
+		{
+			*lpszValue	= it->second;
+			isOK		= TRUE;
+		}
+
+		return isOK;
+	}
+
+	BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount)
+	{
+		ASSERT(lpszName);
+
+		if(lpszValue == nullptr || dwCount == 0)
+		{
+			dwCount = (DWORD)m_headers.count(lpszName);
+			return FALSE;
+		}
+
+		pair<THeaderMapCI, THeaderMapCI> range = m_headers.equal_range(lpszName);
+
+		THeaderMapCI it	= range.first;
+		DWORD dwIndex	= 0;
+
+		while(it != range.second)
+		{
+			if(dwIndex < dwCount)
+				lpszValue[dwIndex] = it->second;
+
+			++dwIndex;
+			++it;
+		}
+
+		BOOL isOK	= (dwIndex > 0 && dwIndex <= dwCount);
+		dwCount		= dwIndex;
+
+		return isOK;
+	}
+
+	BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount)
+	{
+		DWORD dwSize = (DWORD)m_headers.size();
+
+		if(lpHeaders == nullptr || dwCount == 0 || dwSize == 0 || dwSize > dwCount)
+		{
+			dwCount = dwSize;
+			return FALSE;
+		}
+
+		DWORD dwIndex = 0;
+
+		for(THeaderMapCI it = m_headers.begin(), end = m_headers.end(); it != end; ++it, ++dwIndex)
+		{
+			lpHeaders[dwIndex].name  = it->first;
+			lpHeaders[dwIndex].value = it->second;
+		}
+
+		dwCount = dwSize;
+		return TRUE;
+	}
+
+	BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount)
+	{
+		DWORD dwSize = (DWORD)m_headers.size();
+
+		if(lpszName == nullptr || dwCount == 0 || dwSize == 0 || dwSize > dwCount)
+		{
+			dwCount = dwSize;
+			return FALSE;
+		}
+
+		DWORD dwIndex = 0;
+
+		for(THeaderMapCI it = m_headers.begin(), end = m_headers.end(); it != end; ++it, ++dwIndex)
+			lpszName[dwIndex] = it->first;
+
+		dwCount = dwSize;
+		return TRUE;
+	}
+
+	BOOL AddCookie(LPCSTR lpszName, LPCSTR lpszValue, BOOL bRelpace = TRUE)
+	{
+		ASSERT(lpszName);
+
+		TCookieMapI it = m_cookies.find(lpszName);
+
+		if(it == m_cookies.end())
+			return m_cookies.emplace(move(TCookieMap::value_type(lpszName, lpszValue))).second;
+
+		BOOL isOK = FALSE;
+
+		if(bRelpace)
+		{
+			it->second	= lpszValue;
+			isOK		= TRUE;
+		}
+
+		return isOK;
+	}
+
+	BOOL DeleteCookie(LPCSTR lpszName)
+	{
+		ASSERT(lpszName);
+
+		return m_cookies.erase(lpszName) > 0;
+	}
+
+	void DeleteAllCookies()
+	{
+		m_cookies.clear();
+	}
+
+	BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue)
+	{
+		ASSERT(lpszName);
+
+		BOOL isOK		= FALSE;
+		TCookieMapCI it = m_cookies.find(lpszName);
+
+		if(it != m_cookies.end())
+		{
+			*lpszValue	= it->second;
+			isOK		= TRUE;
+		}
+
+		return isOK;
+	}
+
+	BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount)
+	{
+		DWORD dwSize = (DWORD)m_cookies.size();
+
+		if(lpCookies == nullptr || dwCount == 0 || dwSize == 0 || dwSize > dwCount)
+		{
+			dwCount = dwSize;
+			return FALSE;
+		}
+
+		DWORD dwIndex = 0;
+
+		for(TCookieMapCI it = m_cookies.begin(), end = m_cookies.end(); it != end; ++it, ++dwIndex)
+		{
+			lpCookies[dwIndex].name  = it->first;
+			lpCookies[dwIndex].value = it->second;
+		}
+
+		dwCount = dwSize;
+		return TRUE;
+	}
+
+	BOOL ReloadCookies()
+	{
+		CCookieMgr* pCookieMgr = m_pContext->GetCookieMgr();
+
+		if(pCookieMgr == nullptr)
+			return TRUE;
+
+		DeleteAllCookies();
+
+		CCookieSet cookies;
+
+		if(!pCookieMgr->GetCookies(cookies, GetDomain(), GetPath(), TRUE, m_pContext->IsSecure()))
+			return FALSE;
+
+		for(CCookieSetCI it = cookies.begin(), end = cookies.end(); it != end; ++it)
+			AddCookie(it->name, it->value);
+
+		return TRUE;
+	}
+
+	BOOL GetWSMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain)
+	{
+		if(!m_pwsContext)
+			return FALSE;
+
+		return m_pwsContext->GetMessageState(lpbFinal, lpiReserved, lpiOperationCode, lpszMask, lpullBodyLen, lpullBodyRemain);
+	}
+
+public:
+	THttpObjT			(BOOL bRequest, T* pContext, S* pSocket)
+	: m_pContext		(pContext)
+	, m_pSocket			(pSocket)
+	, m_bRequest		(bRequest)
+	, m_bReleased		(FALSE)
+	, m_dwFreeTime		(0)
+	, m_usUrlFieldSet	(0)
+	, m_pstrUrlFileds	(nullptr)
+	, m_enUpgrade		(HUT_NONE)
+	, m_pwsContext		(nullptr)
+	{
+		if(m_bRequest)
+			m_pstrUrlFileds	  = new CStringA[HUF_MAX];
+		else
+			m_pstrRequestPath = new CStringA;
+
+		ResetParser();
+	}
+
+	~THttpObjT()
+	{
+		if(m_bRequest)
+			delete[] m_pstrUrlFileds;
+		else
+			delete m_pstrRequestPath;
+
+		ReleaseWSContext();
+	}
+
+	static THttpObjT* Construct(BOOL bRequest, T* pContext, S* pSocket)
+		{return new THttpObjT(bRequest, pContext, pSocket);}
+
+	static void Destruct(THttpObjT* pHttpObj)
+		{if(pHttpObj) delete pHttpObj;}
+
+	void Reset()
+	{
+		ResetParser();
+		ResetHeaderState();
+		ReleaseWSContext();
+
+		m_bReleased  = FALSE;
+		m_enUpgrade  = HUT_NONE;
+		m_dwFreeTime = 0;
+	}
+
+	void Renew(T* pContext, S* pSocket)
+	{
+		m_pContext	= pContext;
+		m_pSocket	= pSocket;
+
+		Reset();
+	}
+
+	BOOL CopyData(const THttpObjT& src)
+	{
+		if(&src == this)
+			return FALSE;
+		if(m_bRequest != src.m_bRequest)
+			return FALSE;
+
+		void* p			= m_parser.data;
+		m_parser		= src.m_parser;
+		m_parser.data	= p;
+
+		m_headers = src.m_headers;
+		m_cookies = src.m_cookies;
+
+		if(m_bRequest)
+		{
+			m_usUrlFieldSet = src.m_usUrlFieldSet;
+
+			for(int i = 0;i < HUF_MAX; i++)
+				m_pstrUrlFileds[i] = src.m_pstrUrlFileds[i];
+		}
+		else
+		{
+			*m_pstrRequestPath = *src.m_pstrRequestPath;
+		}
+
+		m_enUpgrade = src.m_enUpgrade;
+
+		return TRUE;
+	}
+
+	BOOL CopyWSContext(const THttpObjT& src)
+	{
+		if(&src == this)
+			return FALSE;
+		if(m_bRequest != src.m_bRequest)
+			return FALSE;
+
+		if(!src.m_pwsContext && !m_pwsContext)
+			;
+		else if(!src.m_pwsContext && m_pwsContext)
+		{
+			delete m_pwsContext;
+			m_pwsContext = nullptr;
+		}
+		else
+		{
+			if(!m_pwsContext)
+				m_pwsContext = new TWSContext<THttpObjT<T, S>>(this);
+
+			m_pwsContext->CopyData(*src.m_pwsContext);
+		}
+
+		return TRUE;
+	}
+
+private:
+
+	void ResetParser()
+	{
+		::http_parser_init(&m_parser, m_bRequest ? HTTP_REQUEST : HTTP_RESPONSE);
+		m_parser.data = this;		
+	}
+
+	void ResetHeaderState(BOOL bClearCookies = TRUE, BOOL bResetRequestPath = TRUE)
+	{
+		if(m_bRequest)
+		{
+			if(m_usUrlFieldSet != 0)
+			{
+				m_usUrlFieldSet = 0;
+
+				for(int i = 0; i < HUF_MAX; i++)
+					m_pstrUrlFileds[i].Empty();
+			}
+		}
+		else
+		{
+			if(bResetRequestPath)
+				m_pstrRequestPath->Empty();
+		}
+
+		if(m_bRequest || bClearCookies)
+			DeleteAllCookies();
+			
+		m_headers.clear();
+		ResetHeaderBuffer();
+	}
+
+	void ResetHeaderBuffer()
+	{
+		ResetBuffer();
+		m_strCurHeader.Empty();
+	}
+
+	void ReleaseWSContext()
+	{
+		if(m_pwsContext)
+		{
+			delete m_pwsContext;
+			m_pwsContext = nullptr;
+		}
+	}
+
+	void AppendBuffer(const char* at, size_t length)	{m_strBuffer.Append(at, (int)length);}
+	void ResetBuffer()									{m_strBuffer.Empty();}
+	LPCSTR GetBuffer()									{return m_strBuffer;}
+
+	static THttpObjT* Self(http_parser* p)				{return (THttpObjT*)(p->data);}
+	static T* SelfContext(http_parser* p)				{return Self(p)->m_pContext;}
+	static S* SelfSocketObj(http_parser* p)				{return Self(p)->m_pSocket;}
+
+private:
+	BOOL		m_bRequest;
+	BOOL		m_bReleased;
+	T*			m_pContext;
+	S*			m_pSocket;
+	http_parser	m_parser;
+	THeaderMap	m_headers;
+	TCookieMap	m_cookies;
+	CStringA	m_strBuffer;
+	CStringA	m_strCurHeader;
+
+	USHORT		m_usUrlFieldSet;
+
+	union
+	{
+		CStringA* m_pstrUrlFileds;
+		CStringA* m_pstrRequestPath;
+	};
+
+	EnHttpUpgradeType	m_enUpgrade;
+	DWORD				m_dwFreeTime;
+
+	TWSContext<THttpObjT<T, S>>* m_pwsContext;
+
+	static http_parser_settings sm_settings;
+};
+
+template<class T, class S> http_parser_settings THttpObjT<T, S>::sm_settings = 
+{
+	on_message_begin,
+	on_url,
+	on_status,
+	on_header_field,
+	on_header_value,
+	on_headers_complete,
+	on_body,
+	on_message_complete,
+	on_chunk_header,
+	on_chunk_complete
+};
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+template<BOOL is_request, class T, class S> class CHttpObjPoolT
+{
+	typedef THttpObjT<T, S>		THttpObj;
+	typedef CRingPool<THttpObj>	TSSLHttpObjList;
+	typedef CCASQueue<THttpObj>	TSSLHttpObjQueue;
+
+public:
+	THttpObj* PickFreeHttpObj(T* pContext, S* pSocket)
+	{
+		DWORD dwIndex;
+		THttpObj* pHttpObj = nullptr;
+
+		if(m_lsFreeHttpObj.TryLock(&pHttpObj, dwIndex))
+		{
+			if(::GetTimeGap32(pHttpObj->GetFreeTime()) >= m_dwHttpObjLockTime)
+				VERIFY(m_lsFreeHttpObj.ReleaseLock(nullptr, dwIndex));
+			else
+			{
+				VERIFY(m_lsFreeHttpObj.ReleaseLock(pHttpObj, dwIndex));
+				pHttpObj = nullptr;
+			}
+		}
+
+		if(pHttpObj)
+			pHttpObj->Renew(pContext, pSocket);
+		else
+		{
+			pHttpObj = THttpObj::Construct(is_request, pContext, pSocket);
+			ASSERT(pHttpObj);
+		}
+		
+		return pHttpObj;
+	}
+
+	void PutFreeHttpObj(THttpObj* pHttpObj)
+	{
+		pHttpObj->SetFree();
+
+		if(!m_lsFreeHttpObj.TryPut(pHttpObj))
+		{
+			m_lsGCHttpObj.PushBack(pHttpObj);
+
+			if(m_lsGCHttpObj.Size() > m_dwHttpObjPoolSize)
+				ReleaseGCHttpObj();
+		}
+	}
+
+	void Prepare()
+	{
+		m_lsFreeHttpObj.Reset(m_dwHttpObjPoolHold);
+	}
+
+	void Clear()
+	{
+		THttpObj* pHttpObj = nullptr;
+
+		while(m_lsFreeHttpObj.TryGet(&pHttpObj))
+			delete pHttpObj;
+
+		VERIFY(m_lsFreeHttpObj.IsEmpty());
+		m_lsFreeHttpObj.Reset();
+
+		ReleaseGCHttpObj(TRUE);
+		VERIFY(m_lsGCHttpObj.IsEmpty());
+	}
+
+private:
+	void ReleaseGCHttpObj(BOOL bForce = FALSE)
+	{
+		THttpObj* pHttpObj	= nullptr;
+		DWORD now			= ::TimeGetTime();
+
+		while(m_lsGCHttpObj.PopFront(&pHttpObj))
+		{
+			if(bForce || (int)(now - pHttpObj->GetFreeTime()) >= (int)m_dwHttpObjLockTime)
+				delete pHttpObj;
+			else
+			{
+				m_lsGCHttpObj.PushBack(pHttpObj);
+				break;
+			}
+		}
+	}
+
+public:
+	void SetHttpObjLockTime	(DWORD dwHttpObjLockTime)	{m_dwHttpObjLockTime = dwHttpObjLockTime;}
+	void SetHttpObjPoolSize	(DWORD dwHttpObjPoolSize)	{m_dwHttpObjPoolSize = dwHttpObjPoolSize;}
+	void SetHttpObjPoolHold	(DWORD dwHttpObjPoolHold)	{m_dwHttpObjPoolHold = dwHttpObjPoolHold;}
+
+	DWORD GetHttpObjLockTime()	{return m_dwHttpObjLockTime;}
+	DWORD GetHttpObjPoolSize()	{return m_dwHttpObjPoolSize;}
+	DWORD GetHttpObjPoolHold()	{return m_dwHttpObjPoolHold;}
+
+public:
+	CHttpObjPoolT(	DWORD dwPoolSize = DEFAULT_HTTPOBJ_POOL_SIZE,
+					DWORD dwPoolHold = DEFAULT_HTTPOBJ_POOL_HOLD,
+					DWORD dwLockTime = DEFAULT_HTTPOBJ_LOCK_TIME)
+	: m_dwHttpObjPoolSize(dwPoolSize)
+	, m_dwHttpObjPoolHold(dwPoolHold)
+	, m_dwHttpObjLockTime(dwLockTime)
+	{
+
+	}
+
+	~CHttpObjPoolT()	{Clear();}
+
+	DECLARE_NO_COPY_CLASS(CHttpObjPoolT)
+
+public:
+	static const DWORD DEFAULT_HTTPOBJ_LOCK_TIME;
+	static const DWORD DEFAULT_HTTPOBJ_POOL_SIZE;
+	static const DWORD DEFAULT_HTTPOBJ_POOL_HOLD;
+
+private:
+	DWORD				m_dwHttpObjLockTime;
+	DWORD				m_dwHttpObjPoolSize;
+	DWORD				m_dwHttpObjPoolHold;
+
+	TSSLHttpObjList		m_lsFreeHttpObj;
+	TSSLHttpObjQueue	m_lsGCHttpObj;
+};
+
+template<BOOL is_request, class T, class S> const DWORD CHttpObjPoolT<is_request, T, S>::DEFAULT_HTTPOBJ_LOCK_TIME	= 10 * 1000;
+template<BOOL is_request, class T, class S> const DWORD CHttpObjPoolT<is_request, T, S>::DEFAULT_HTTPOBJ_POOL_SIZE	= 150;
+template<BOOL is_request, class T, class S> const DWORD CHttpObjPoolT<is_request, T, S>::DEFAULT_HTTPOBJ_POOL_HOLD	= 600;
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+extern CStringA& GetHttpVersionStr(EnHttpVersion enVersion, CStringA& strResult);
+extern CStringA& AdjustRequestPath(LPCSTR lpszPath, CStringA& strPath);
+extern LPCSTR GetHttpDefaultStatusCodeDesc(EnHttpStatusCode enCode);
+extern void MakeRequestLine(LPCSTR lpszMethod, LPCSTR lpszPath, EnHttpVersion enVersion, CStringA& strValue);
+extern void MakeStatusLine(EnHttpVersion enVersion, USHORT usStatusCode, LPCSTR lpszDesc, CStringA& strValue);
+extern void MakeHeaderLines(const THeader lpHeaders[], int iHeaderCount, const TCookieMap* pCookies, int iBodyLength, BOOL bRequest, int iConnFlag, LPCSTR lpszDefaultHost, USHORT usPort, CStringA& strValue);
+extern void MakeHttpPacket(const CStringA& strHeader, const BYTE* pBody, int iLength, WSABUF szBuffer[2]);
+extern BOOL MakeWSPacket(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], BYTE* pData, int iLength, ULONGLONG ullBodyLen, BYTE szHeader[HTTP_MAX_WS_HEADER_LEN], WSABUF szBuffer[2]);
+extern BOOL ParseUrl(const CStringA& strUrl, BOOL& bHttps, CStringA& strHost, USHORT& usPort, CStringA& strPath);
+
+// CP_XXX -> UNICODE
+BOOL CodePageToUnicode(int iCodePage, const char szSrc[], WCHAR szDest[], int& iDestLength);
+// UNICODE -> CP_XXX
+BOOL UnicodeToCodePage(int iCodePage, const WCHAR szSrc[], char szDest[], int& iDestLength);
+// GBK -> UNICODE
+BOOL GbkToUnicode(const char szSrc[], WCHAR szDest[], int& iDestLength);
+// UNICODE -> GBK
+BOOL UnicodeToGbk(const WCHAR szSrc[], char szDest[], int& iDestLength);
+// UTF8 -> UNICODE
+BOOL Utf8ToUnicode(const char szSrc[], WCHAR szDest[], int& iDestLength);
+// UNICODE -> UTF8
+BOOL UnicodeToUtf8(const WCHAR szSrc[], char szDest[], int& iDestLength);
+// GBK -> UTF8
+BOOL GbkToUtf8(const char szSrc[], char szDest[], int& iDestLength);
+// UTF8 -> GBK
+BOOL Utf8ToGbk(const char szSrc[], char szDest[], int& iDestLength);
+
+// 普通压缩（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int Compress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// 高级压缩（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int CompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen, int iLevel = Z_DEFAULT_COMPRESSION, int iMethod = Z_DEFLATED, int iWindowBits = DEF_WBITS, int iMemLevel = DEF_MEM_LEVEL, int iStrategy = Z_DEFAULT_STRATEGY);
+// 普通解压（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int Uncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// 高级解压（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int UncompressEx(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen, int iWindowBits = DEF_WBITS);
+// 推测压缩结果长度
+DWORD GuessCompressBound(DWORD dwSrcLen, BOOL bGZip = FALSE);
+
+// Gzip 压缩（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int GZipCompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// Gzip 解压（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int GZipUncompress(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// 推测 Gzip 解压结果长度（如果返回 0 或不合理值则说明输入内容并非有效的 Gzip 格式）
+DWORD GZipGuessUncompressBound(const BYTE* lpszSrc, DWORD dwSrcLen);
+
+// 计算 Base64 编码后长度
+DWORD GuessBase64EncodeBound(DWORD dwSrcLen);
+// 计算 Base64 解码后长度
+DWORD GuessBase64DecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
+// Base64 编码（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int Base64Encode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// Base64 解码（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int Base64Decode(const BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+
+// 计算 URL 编码后长度
+DWORD GuessUrlEncodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
+// 计算 URL 解码后长度
+DWORD GuessUrlDecodeBound(const BYTE* lpszSrc, DWORD dwSrcLen);
+// URL 编码（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int UrlEncode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);
+// URL 解码（返回值：0 -> 成功，-3 -> 输入数据不正确，-5 -> 输出缓冲区不足）
+int UrlDecode(BYTE* lpszSrc, DWORD dwSrcLen, BYTE* lpszDest, DWORD& dwDestLen);

socket/HP-Socket/Src/SocketHelper.cpp

@@ -0,0 +1,750 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "../../Common/Src/GeneralHelper.h"
+#include "../../Common/Src/SysHelper.h"
+#include "SocketHelper.h"
+
+#include <mstcpip.h>
+#pragma comment(lib, "ws2_32")
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+DWORD GetDefaultWorkerThreadCount()
+{
+	static DWORD s_dwtc = min((::SysGetNumberOfProcessors() * 2 + 2), MAX_WORKER_THREAD_COUNT);
+	return s_dwtc;
+}
+
+DWORD GetDefaultTcpSocketBufferSize()
+{
+	static DWORD s_dtsbs = ::SysGetPageSize();
+	return s_dtsbs;
+}
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+ULONG GetIPv4InAddr(LPCTSTR lpszAddress)
+{
+	if (!lpszAddress || lpszAddress[0] == 0)
+		return INADDR_NONE;
+
+#if _WIN32_WINNT >= _WIN32_WINNT_VISTA
+	IN_ADDR addr;
+	if (::InetPton(AF_INET, lpszAddress, &addr.s_addr) == 1)
+		return addr.s_addr;
+
+	return INADDR_NONE;
+#else
+	return ::inet_addr(CT2A(lpszAddress));
+#endif
+}
+
+BOOL IsIPAddress(LPCTSTR lpszAddress)
+{
+	return GetIPv4InAddr(lpszAddress) != INADDR_NONE;
+}
+
+BOOL GetIPAddress(LPCTSTR lpszHost, LPTSTR lpszIP, int& iIPLen)
+{
+	BOOL isOK = TRUE;
+
+	if(IsIPAddress(lpszHost))
+	{
+		int iHostLen = lstrlen(lpszHost);
+		
+		if(iHostLen > 0)
+			++iHostLen;
+
+		if(iHostLen > 0 && iIPLen >= iHostLen)
+			lstrcpy(lpszIP, lpszHost);
+		else
+			isOK = FALSE;
+
+		iIPLen = iHostLen;
+	}
+	else
+	{
+		IN_ADDR addr;
+
+		if(GetOptimalIPByHostName(lpszHost, addr))
+			isOK = IN_ADDR_2_IP(addr, lpszIP, iIPLen);
+		else
+			isOK = FALSE;
+	}
+
+	return isOK;
+}
+
+BOOL GetOptimalIPByHostName(LPCTSTR lpszHost, IN_ADDR& addr)
+{
+	addr.s_addr	= 0;
+
+	addrinfo*	pInfo = nullptr;
+	addrinfo	hints = {0};
+
+	hints.ai_flags	= AI_ALL;
+	hints.ai_family	= AF_INET;
+
+	int rs = ::getaddrinfo((CT2A)lpszHost, nullptr, &hints, &pInfo);
+
+	if(rs == NO_ERROR)
+	{
+		IN_ADDR inAddr;
+		ULONG addrs[3]  = {0};
+		char** pptr		= nullptr;
+
+		for(addrinfo* pCur = pInfo; pCur != nullptr; pCur = pCur->ai_next)
+		{
+			if(pCur->ai_family == AF_INET)
+			{
+				inAddr	= ((SOCKADDR_IN*)(pCur->ai_addr))->sin_addr;
+				UCHAR a	= inAddr.s_net;
+				UCHAR b	= inAddr.s_host;
+
+				if(addrs[0] == 0 && a == 127)
+				{
+					addrs[0] = inAddr.s_addr;
+					break;
+				}
+				else if(	addrs[1] == 0							&& 
+							(
+								(a == 10)							||
+								(a == 172 && b >= 16 && b <= 31)	||
+								(a == 192 && b == 168)
+								)
+							)
+					addrs[1] = inAddr.s_addr;
+				else if(addrs[2] == 0)
+					addrs[2] = inAddr.s_addr;
+			}
+		}
+
+		::freeaddrinfo(pInfo);
+
+		for(int i = 0; i < 3; i++)
+		{
+			if(addrs[i] != 0)
+			{
+				addr.s_addr = addrs[i];
+				break;
+			}
+		}
+	}
+
+	return addr.s_addr != 0;
+}
+
+BOOL IN_ADDR_2_IP(const IN_ADDR& addr, LPTSTR lpszAddress, int& iAddressLen)
+{
+	BOOL isOK = TRUE;
+
+	TCHAR szAddr[16];
+	wsprintf(szAddr, _T("%hu.%hu.%hu.%hu"), addr.s_net, addr.s_host, addr.s_lh, addr.s_impno);
+
+	int iIPLen = lstrlen(szAddr) + 1;
+
+	if(iAddressLen >= iIPLen)
+		memcpy(lpszAddress, szAddr, iIPLen * sizeof(TCHAR));
+	else
+		isOK = FALSE;
+
+	iAddressLen = iIPLen;
+
+	return isOK;
+}
+
+BOOL sockaddr_IN_2_A(const SOCKADDR_IN& addr, ADDRESS_FAMILY& usFamily, LPTSTR lpszAddress, int& iAddressLen, USHORT& usPort)
+{
+	usFamily = addr.sin_family;
+	usPort	 = ntohs(addr.sin_port);
+
+	return IN_ADDR_2_IP(addr.sin_addr, lpszAddress, iAddressLen);
+}
+
+BOOL sockaddr_A_2_IN(ADDRESS_FAMILY usFamily, LPCTSTR lpszAddress, USHORT usPort, SOCKADDR_IN& addr)
+{
+	ASSERT(usFamily == AF_INET);
+
+	addr.sin_family			= usFamily;
+	addr.sin_port			= htons(usPort);
+	addr.sin_addr.s_addr	= GetIPv4InAddr(lpszAddress);
+
+	return addr.sin_addr.s_addr != INADDR_NONE;
+}
+
+BOOL GetSocketAddress(SOCKET socket, LPTSTR lpszAddress, int& iAddressLen, USHORT& usPort, BOOL bLocal)
+{
+	sockaddr addr;
+
+	int addr_len = sizeof(addr);
+	int result	 = bLocal ? getsockname(socket, &addr, &addr_len) : getpeername(socket, &addr, &addr_len);
+
+	if(result == NO_ERROR)
+	{
+		ADDRESS_FAMILY usFamily;
+		return sockaddr_IN_2_A((sockaddr_in&)addr, usFamily, lpszAddress, iAddressLen, usPort);
+	}
+
+	return FALSE;
+}
+
+BOOL GetSocketLocalAddress(SOCKET socket, LPTSTR lpszAddress, int& iAddressLen, USHORT& usPort)
+{
+	return GetSocketAddress(socket, lpszAddress, iAddressLen, usPort, TRUE);
+}
+
+BOOL GetSocketRemoteAddress(SOCKET socket, LPTSTR lpszAddress, int& iAddressLen, USHORT& usPort)
+{
+	return GetSocketAddress(socket, lpszAddress, iAddressLen, usPort, FALSE);
+}
+
+ULONGLONG NToH64(ULONGLONG value)
+{
+	return (((ULONGLONG)ntohl((u_long)((value << 32) >> 32))) << 32) | ntohl((u_long)(value >> 32));
+}
+
+ULONGLONG HToN64(ULONGLONG value)
+{
+	return (((ULONGLONG)htonl((u_long)((value << 32) >> 32))) << 32) | htonl((u_long)(value >> 32));
+}
+
+PVOID GetExtensionFuncPtr(SOCKET sock, GUID guid)
+{
+	DWORD dwBytes;
+	PVOID pfn = nullptr;
+
+	::WSAIoctl	(
+					sock,
+					SIO_GET_EXTENSION_FUNCTION_POINTER,
+					&guid,
+					sizeof(guid),
+					&pfn,
+					sizeof(pfn),
+					&dwBytes,
+					nullptr,
+					nullptr
+				);
+
+	return pfn;
+}
+
+LPFN_ACCEPTEX Get_AcceptEx_FuncPtr(SOCKET sock)
+{
+	GUID guid = WSAID_ACCEPTEX;
+	return (LPFN_ACCEPTEX)GetExtensionFuncPtr(sock, guid);
+}
+
+LPFN_GETACCEPTEXSOCKADDRS Get_GetAcceptExSockaddrs_FuncPtr(SOCKET sock)
+{
+	GUID guid = WSAID_GETACCEPTEXSOCKADDRS;
+	return (LPFN_GETACCEPTEXSOCKADDRS)GetExtensionFuncPtr(sock, guid);
+}
+
+LPFN_CONNECTEX Get_ConnectEx_FuncPtr(SOCKET sock)
+{
+	GUID guid = WSAID_CONNECTEX;
+	return (LPFN_CONNECTEX)GetExtensionFuncPtr(sock, guid);
+}
+
+LPFN_TRANSMITFILE Get_TransmitFile_FuncPtr(SOCKET sock)
+{
+	GUID guid = WSAID_TRANSMITFILE;
+	return (LPFN_TRANSMITFILE)GetExtensionFuncPtr(sock, guid);
+}
+
+LPFN_DISCONNECTEX Get_DisconnectEx_FuncPtr	(SOCKET sock)
+{
+	GUID guid = WSAID_DISCONNECTEX;
+	return (LPFN_DISCONNECTEX)GetExtensionFuncPtr(sock, guid);
+}
+
+HRESULT ReadSmallFile(LPCTSTR lpszFileName, CAtlFile& file, CAtlFileMapping<>& fmap, DWORD dwMaxFileSize)
+{
+	ASSERT(lpszFileName != nullptr);
+
+	HRESULT hr = file.Create(lpszFileName, GENERIC_READ, FILE_SHARE_READ, OPEN_EXISTING);
+
+	if(SUCCEEDED(hr))
+	{
+		ULONGLONG ullLen;
+		hr = file.GetSize(ullLen);
+
+		if(SUCCEEDED(hr))
+		{
+			if(ullLen > 0 && ullLen <= dwMaxFileSize)
+				hr = fmap.MapFile(file);
+			else if(ullLen == 0)
+				hr = HRESULT_FROM_WIN32(ERROR_FILE_INVALID);
+			else
+				hr = HRESULT_FROM_WIN32(ERROR_FILE_TOO_LARGE);
+		}
+	}
+
+	return hr;
+}
+
+HRESULT MakeSmallFilePackage(LPCTSTR lpszFileName, CAtlFile& file, CAtlFileMapping<>& fmap, WSABUF szBuf[3], const LPWSABUF pHead, const LPWSABUF pTail)
+{
+	DWORD dwMaxFileSize = MAX_SMALL_FILE_SIZE - (pHead ? pHead->len : 0) - (pTail ? pTail->len : 0);
+	ASSERT(dwMaxFileSize <= MAX_SMALL_FILE_SIZE);
+
+	HRESULT hr = ReadSmallFile(lpszFileName, file, fmap, dwMaxFileSize);
+
+	if(SUCCEEDED(hr))
+	{
+		szBuf[1].len = (ULONG)fmap.GetMappingSize();
+		szBuf[1].buf = fmap;
+
+		if(pHead) memcpy(&szBuf[0], pHead, sizeof(WSABUF));
+		else	  memset(&szBuf[0], 0, sizeof(WSABUF));
+
+		if(pTail) memcpy(&szBuf[2], pTail, sizeof(WSABUF));
+		else	  memset(&szBuf[2], 0, sizeof(WSABUF));
+	}
+
+	return hr;
+}
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+BOOL PostIocpCommand(HANDLE hIOCP, EnIocpCommand enCmd, ULONG_PTR ulParam)
+{
+	return ::PostQueuedCompletionStatus(hIOCP, enCmd, ulParam, nullptr);
+}
+
+BOOL PostIocpExit(HANDLE hIOCP)
+{
+	return PostIocpCommand(hIOCP, IOCP_CMD_EXIT, 0);
+}
+
+BOOL PostIocpAccept(HANDLE hIOCP)
+{
+	return PostIocpCommand(hIOCP, IOCP_CMD_ACCEPT, 0);
+}
+
+BOOL PostIocpDisconnect(HANDLE hIOCP, CONNID dwConnID)
+{
+	return PostIocpCommand(hIOCP, IOCP_CMD_DISCONNECT, dwConnID);
+}
+
+BOOL PostIocpSend(HANDLE hIOCP, CONNID dwConnID)
+{
+	return PostIocpCommand(hIOCP, IOCP_CMD_SEND, dwConnID);
+}
+
+BOOL PostIocpClose(HANDLE hIOCP, CONNID dwConnID, int iErrorCode)
+{
+	return PostIocpCommand(hIOCP, (EnIocpCommand)iErrorCode, dwConnID);
+}
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+int SSO_SetSocketOption(SOCKET sock, int level, int name, LPVOID val, int len)
+{
+	return setsockopt(sock, level, name, (CHAR*)val, len);
+}
+
+int SSO_GetSocketOption(SOCKET sock, int level, int name, LPVOID val, int* len)
+{
+	return getsockopt(sock, level, name, (CHAR*)val, len);
+}
+
+int SSO_IoctlSocket(SOCKET sock, long cmd, u_long* arg)
+{
+	return ioctlsocket(sock, cmd, arg);
+}
+
+int SSO_WSAIoctl(SOCKET sock, DWORD dwIoControlCode, LPVOID lpvInBuffer, DWORD cbInBuffer, LPVOID lpvOutBuffer, DWORD cbOutBuffer, LPDWORD lpcbBytesReturned)
+{
+	return ::WSAIoctl(sock, dwIoControlCode, lpvInBuffer, cbInBuffer, lpvOutBuffer, cbOutBuffer, lpcbBytesReturned, nullptr, nullptr);
+}
+
+int SSO_UpdateAcceptContext(SOCKET soClient, SOCKET soBind)
+{
+	return setsockopt(soClient, SOL_SOCKET, SO_UPDATE_ACCEPT_CONTEXT, (CHAR*)&soBind, sizeof(SOCKET));
+}
+
+int SSO_UpdateConnectContext(SOCKET soClient, int iOption)
+{
+	return setsockopt(soClient, SOL_SOCKET, SO_UPDATE_CONNECT_CONTEXT, (CHAR*)&iOption, sizeof(int));
+}
+
+int SSO_NoDelay(SOCKET sock, BOOL bNoDelay)
+{
+	return setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, (CHAR*)&bNoDelay, sizeof(BOOL));
+}
+
+int SSO_DontLinger(SOCKET sock, BOOL bDont)
+{
+	return setsockopt(sock, SOL_SOCKET, SO_DONTLINGER, (CHAR*)&bDont, sizeof(BOOL));
+}
+
+int SSO_Linger(SOCKET sock, USHORT l_onoff, USHORT l_linger)
+{
+	linger ln = {l_onoff, l_linger};
+	return setsockopt(sock, SOL_SOCKET, SO_LINGER, (CHAR*)&ln, sizeof(linger));
+}
+
+int SSO_KeepAlive(SOCKET sock, BOOL bKeepAlive)
+{
+	return setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, (CHAR*)&bKeepAlive, sizeof(BOOL));
+}
+
+int SSO_KeepAliveVals(SOCKET sock, u_long onoff, u_long time, u_long interval)
+{
+	int result		 = NO_ERROR;
+	tcp_keepalive in = {onoff, time, interval};
+	DWORD dwBytes;
+
+	if(::WSAIoctl	(
+						sock, 
+						SIO_KEEPALIVE_VALS, 
+						(LPVOID)&in, 
+						sizeof(in), 
+						nullptr, 
+						0, 
+						&dwBytes, 
+						nullptr, 
+						nullptr
+					) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+		if(result == WSAEWOULDBLOCK)
+			result = NO_ERROR;
+	}
+
+	return result;
+}
+
+int SSO_RecvBuffSize(SOCKET sock, int size)
+{
+	return setsockopt(sock, SOL_SOCKET, SO_RCVBUF, (CHAR*)&size, sizeof(int));
+}
+
+int SSO_SendBuffSize(SOCKET sock, int size)
+{
+	return setsockopt(sock, SOL_SOCKET, SO_SNDBUF, (CHAR*)&size, sizeof(int));
+}
+
+int SSO_ReuseAddress(SOCKET sock, BOOL bReuse)
+{
+	return setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (CHAR*)&bReuse, sizeof(BOOL));
+}
+
+int SSO_UDP_ConnReset(SOCKET sock, BOOL bNewBehavior)
+{
+	int result = NO_ERROR;
+	DWORD dwBytes;
+
+	if(::WSAIoctl	(
+						sock, 
+						SIO_UDP_CONNRESET, 
+						(LPVOID)&bNewBehavior, 
+						sizeof(bNewBehavior), 
+						nullptr, 
+						0, 
+						&dwBytes, 
+						nullptr, 
+						nullptr
+					) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+		if(result == WSAEWOULDBLOCK)
+			result = NO_ERROR;
+	}
+
+	return result;
+}
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+CONNID GenerateConnectionID()
+{
+	static volatile CONNID s_dwConnID = 0;
+
+	CONNID dwConnID	= ::InterlockedIncrement(&s_dwConnID);
+	
+	if(dwConnID == 0)
+		dwConnID = ::InterlockedIncrement(&s_dwConnID);
+
+	return dwConnID;
+}
+
+int ManualCloseSocket(SOCKET sock, int iShutdownFlag, BOOL bGraceful, BOOL bReuseAddress)
+{
+	if(!bGraceful)
+		SSO_Linger(sock, 1, 0);
+
+	if(bReuseAddress)
+		SSO_ReuseAddress(sock, bReuseAddress);
+
+	if(iShutdownFlag != 0xFF)
+		shutdown(sock, iShutdownFlag);
+
+	return closesocket(sock);
+}
+
+int PostAccept(LPFN_ACCEPTEX pfnAcceptEx, SOCKET soListen, SOCKET soClient, TBufferObj* pBufferObj)
+{
+	int result = PostAcceptNotCheck(pfnAcceptEx, soListen, soClient, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostAcceptNotCheck(LPFN_ACCEPTEX pfnAcceptEx, SOCKET soListen, SOCKET soClient, TBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	pBufferObj->client		= soClient;
+	pBufferObj->operation	= SO_ACCEPT;
+
+	if(!pfnAcceptEx	(
+						soListen,
+						pBufferObj->client,
+						pBufferObj->buff.buf,
+						0,
+						sizeof(SOCKADDR_IN) + 16,
+						sizeof(SOCKADDR_IN) + 16,
+						nullptr,
+						&pBufferObj->ov
+					)
+	)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+int PostConnect(LPFN_CONNECTEX pfnConnectEx, SOCKET soClient, SOCKADDR_IN& soAddrIN, TBufferObj* pBufferObj)
+{
+	int result = PostConnectNotCheck(pfnConnectEx, soClient, soAddrIN, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostConnectNotCheck(LPFN_CONNECTEX pfnConnectEx, SOCKET soClient, SOCKADDR_IN& soAddrIN, TBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	pBufferObj->client		= soClient;
+	pBufferObj->operation	= SO_CONNECT;
+
+	if(!pfnConnectEx	(
+							soClient,
+							(SOCKADDR*)&soAddrIN,
+							sizeof(SOCKADDR_IN),
+							nullptr,
+							0,
+							nullptr,
+							&pBufferObj->ov
+						)
+	)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+int PostSend(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	int result = PostSendNotCheck(pSocketObj, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostSendNotCheck(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	DWORD dwBytes			= 0;
+	pBufferObj->client		= pSocketObj->socket;
+	pBufferObj->operation	= SO_SEND;
+
+	if(::WSASend(
+					pBufferObj->client,
+					&pBufferObj->buff,
+					1,
+					&dwBytes,
+					0,
+					&pBufferObj->ov,
+					nullptr
+				) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+int PostReceive(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	int result = PostReceiveNotCheck(pSocketObj, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostReceiveNotCheck(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	DWORD dwFlag			= 0; 
+	DWORD dwBytes			= 0; 
+	pBufferObj->client		= pSocketObj->socket;
+	pBufferObj->operation	= SO_RECEIVE;
+
+	if(::WSARecv(
+					pBufferObj->client,
+					&pBufferObj->buff,
+					1,
+					&dwBytes,
+					&dwFlag,
+					&pBufferObj->ov,
+					nullptr
+				) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+int PostSendTo(SOCKET sock, TUdpBufferObj* pBufferObj)
+{
+	int result = PostSendToNotCheck(sock, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostSendToNotCheck(SOCKET sock, TUdpBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	DWORD dwBytes			= 0;
+	pBufferObj->operation	= SO_SEND;
+	pBufferObj->addrLen		= sizeof(SOCKADDR_IN);
+
+	if(::WSASendTo	(
+						sock,
+						&pBufferObj->buff,
+						1,
+						&dwBytes,
+						0,
+						(sockaddr*)&pBufferObj->remoteAddr,
+						pBufferObj->addrLen,
+						&pBufferObj->ov,
+						nullptr
+					) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+int PostReceiveFrom(SOCKET sock, TUdpBufferObj* pBufferObj)
+{
+	int result = PostReceiveFromNotCheck(sock, pBufferObj);
+
+	if(result == WSA_IO_PENDING)
+		result = NO_ERROR;
+
+	return result;
+}
+
+int PostReceiveFromNotCheck(SOCKET sock, TUdpBufferObj* pBufferObj)
+{
+	int result				= NO_ERROR;
+	DWORD dwFlag			= 0;
+	DWORD dwBytes			= 0;
+	pBufferObj->operation	= SO_RECEIVE;
+	pBufferObj->addrLen		= sizeof(SOCKADDR_IN);
+
+	::ZeroMemory(&pBufferObj->remoteAddr, pBufferObj->addrLen);
+
+	if(::WSARecvFrom(
+						sock,
+						&pBufferObj->buff,
+						1,
+						&dwBytes,
+						&dwFlag,
+						(sockaddr*)&pBufferObj->remoteAddr,
+						&pBufferObj->addrLen,
+						&pBufferObj->ov,
+						nullptr
+					) == SOCKET_ERROR)
+	{
+		result = ::WSAGetLastError();
+	}
+
+	return result;
+}
+
+///////////////////////////////////////////////////////////////////////////////////////////////////////
+
+LPCTSTR GetSocketErrorDesc(EnSocketError enCode)
+{
+	switch(enCode)
+	{
+	case SE_OK:						return _T("SUCCESS");
+	case SE_ILLEGAL_STATE:			return _T("Illegal State");
+	case SE_INVALID_PARAM:			return _T("Invalid Parameter");
+	case SE_SOCKET_CREATE:			return _T("Create SOCKET Fail");
+	case SE_SOCKET_BIND:			return _T("Bind SOCKET Fail");
+	case SE_SOCKET_PREPARE:			return _T("Prepare SOCKET Fail");
+	case SE_SOCKET_LISTEN:			return _T("Listen SOCKET Fail");
+	case SE_CP_CREATE:				return _T("Create IOCP Fail");
+	case SE_WORKER_THREAD_CREATE:	return _T("Create Worker Thread Fail");
+	case SE_DETECT_THREAD_CREATE:	return _T("Create Detector Thread Fail");
+	case SE_SOCKE_ATTACH_TO_CP:		return _T("Attach SOCKET to IOCP Fail");
+	case SE_CONNECT_SERVER:			return _T("Connect to Server Fail");
+	case SE_NETWORK:				return _T("Network Error");
+	case SE_DATA_PROC:				return _T("Process Data Error");
+	case SE_DATA_SEND:				return _T("Send Data Fail");
+
+	case SE_SSL_ENV_NOT_READY:		return _T("SSL environment not ready");
+
+	default: ASSERT(FALSE);			return _T("UNKNOWN ERROR");
+	}
+}
+
+DWORD GetHPSocketVersion()
+{
+	static DWORD s_dwVersion = (HP_VERSION_MAJOR << 24) | (HP_VERSION_MINOR << 16) | (HP_VERSION_REVISE << 8) | HP_VERSION_BUILD;
+
+	return s_dwVersion;
+}

socket/HP-Socket/Src/SocketHelper.h

@@ -0,0 +1,628 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include <ws2tcpip.h>
+#include <mswsock.h>
+#include <malloc.h>
+
+#include <atlfile.h>
+
+#include "SocketInterface.h"
+#include "../../Common/Src/WaitFor.h"
+#include "../../Common/Src/bufferpool.h"
+#include "../../Common/Src/RingBuffer.h"
+
+/************************************************************************
+名称：全局常量
+描述：声明组件的公共全局常量
+************************************************************************/
+
+/* HP-Socket 版本号 */
+#define HP_VERSION_MAJOR						4
+#define HP_VERSION_MINOR						2
+#define HP_VERSION_REVISE						1
+#define HP_VERSION_BUILD						5
+
+/* IOCP 最大工作线程数 */
+#define MAX_WORKER_THREAD_COUNT					500
+/* IOCP Socket 缓冲区最小值 */
+#define MIN_SOCKET_BUFFER_SIZE					64
+/* 小文件最大字节数 */
+#define MAX_SMALL_FILE_SIZE						0x3FFFFF
+/* 最大连接时长 */
+#define MAX_CONNECTION_PERIOD					(MAXLONG / 2)
+
+/* Server/Agent 默认最大连接数 */
+#define DEFAULT_MAX_CONNECTION_COUNT			10000
+/* Server/Agent 默认 IOCP 工作线程数 */
+#define DEFAULT_WORKER_THREAD_COUNT				GetDefaultWorkerThreadCount()
+/* Server/Agent 默认 Socket 缓存对象锁定时间 */
+#define DEFAULT_FREE_SOCKETOBJ_LOCK_TIME		(10 * 1000)
+/* Server/Agent 默认 Socket 缓存池大小 */
+#define DEFAULT_FREE_SOCKETOBJ_POOL				150
+/* Server/Agent 默认 Socket 缓存池回收阀值 */
+#define DEFAULT_FREE_SOCKETOBJ_HOLD				600
+/* Server/Agent 默认内存块缓存池大小 */
+#define DEFAULT_FREE_BUFFEROBJ_POOL				300
+/* Server/Agent 默认内存块缓存池回收阀值 */
+#define DEFAULT_FREE_BUFFEROBJ_HOLD				1200
+/* Client 默认内存块缓存池大小 */
+#define DEFAULT_CLIENT_FREE_BUFFER_POOL_SIZE	10
+/* Client 默认内存块缓存池回收阀值 */
+#define DEFAULT_CLIENT_FREE_BUFFER_POOL_HOLD	40
+/* Agent 默认绑定地址 */
+#define  DEFAULT_BIND_ADDRESS					_T("0.0.0.0")
+
+/* TCP 默认通信数据缓冲区大小 */
+#define DEFAULT_TCP_SOCKET_BUFFER_SIZE			GetDefaultTcpSocketBufferSize()
+/* TCP 默认心跳包间隔 */
+#define DEFALUT_TCP_KEEPALIVE_TIME				(30 * 1000)
+/* TCP 默认心跳确认包检测间隔 */
+#define DEFALUT_TCP_KEEPALIVE_INTERVAL			(10 * 1000)
+/* TCP Server 默认 Listen 队列大小 */
+#define DEFAULT_TCP_SERVER_SOCKET_LISTEN_QUEUE	SOMAXCONN
+/* TCP Server 默认预投递 Accept 数量 */
+#define DEFAULT_TCP_SERVER_ACCEPT_SOCKET_COUNT	300
+
+/* UDP 默认数据报文最大长度 */
+#define DEFAULT_UDP_MAX_DATAGRAM_SIZE			1472
+/* UDP 默认 Receive 预投递数量 */
+#define DEFAULT_UDP_POST_RECEIVE_COUNT			300
+/* UDP 默认监测包尝试次数 */
+#define DEFAULT_UDP_DETECT_ATTEMPTS				3
+/* UDP 默认监测包发送间隔 */
+#define DEFAULT_UDP_DETECT_INTERVAL				20
+
+/* TCP Pack 包长度位数 */
+#define TCP_PACK_LENGTH_BITS					22
+/* TCP Pack 包长度掩码 */
+#define TCP_PACK_LENGTH_MASK					0x3FFFFF
+/* TCP Pack 包最大长度硬限制 */
+#define TCP_PACK_MAX_SIZE_LIMIT					0x3FFFFF
+/* TCP Pack 包默认最大长度 */
+#define TCP_PACK_DEFAULT_MAX_SIZE				0x040000
+/* TCP Pack 包头标识值硬限制 */
+#define TCP_PACK_HEADER_FLAG_LIMIT				0x0003FF
+/* TCP Pack 包头默认标识值 */
+#define TCP_PACK_DEFAULT_HEADER_FLAG			0x000000
+
+DWORD GetDefaultWorkerThreadCount();
+DWORD GetDefaultTcpSocketBufferSize();
+
+/************************************************************************
+名称：Windows Socket 组件初始化类
+描述：自动加载和卸载 Windows Socket 组件
+************************************************************************/
+class CInitSocket
+{
+public:
+	CInitSocket(LPWSADATA lpWSAData = nullptr, BYTE minorVersion = 2, BYTE majorVersion = 2)
+	{
+		LPWSADATA lpTemp = lpWSAData;
+		if(!lpTemp)
+			lpTemp	= (LPWSADATA)_alloca(sizeof(WSADATA));
+
+		m_iResult	= ::WSAStartup(MAKEWORD(majorVersion, minorVersion), lpTemp);
+	}
+
+	~CInitSocket()
+	{
+		if(IsValid())
+			::WSACleanup();
+	}
+
+	int		GetResult()	{return m_iResult;}
+	BOOL	IsValid()	{return m_iResult == 0;}
+
+private:
+	int		m_iResult;
+};
+
+/* Server 组件和 Agent 组件内部使用的事件处理结果常量 */
+
+// 连接已关闭
+#define HR_CLOSED	0xFF
+
+/* 关闭连接标识 */
+enum EnSocketCloseFlag
+{
+	SCF_NONE	= 0,	// 不触发事件
+	SCF_CLOSE	= 1,	// 触发 正常关闭 OnClose 事件
+	SCF_ERROR	= 2		// 触发 异常关闭 OnClose 事件
+};
+
+/* 数据缓冲区基础结构 */
+template<class T> struct TBufferObjBase
+{
+	WSAOVERLAPPED		ov;
+	EnSocketOperation	operation;
+	WSABUF				buff;
+
+	int					capacity;
+	CPrivateHeap&		heap;
+
+	T* next;
+	T* last;
+
+	static T* Construct(CPrivateHeap& heap, DWORD dwCapacity)
+	{
+		T* pBufferObj = (T*)heap.Alloc(sizeof(T) + dwCapacity);
+		ASSERT(pBufferObj);
+
+		ZeroMemory(pBufferObj, sizeof(T));
+		
+		pBufferObj->TBufferObjBase::TBufferObjBase(heap, dwCapacity);
+		pBufferObj->buff.buf = ((char*)pBufferObj) + sizeof(T);
+
+		return pBufferObj;
+	}
+
+	static void Destruct(T* pBufferObj)
+	{
+		ASSERT(pBufferObj);
+		pBufferObj->heap.Free(pBufferObj);
+	}
+
+	TBufferObjBase(CPrivateHeap& hp, DWORD dwCapacity)
+	: heap(hp)
+	, capacity((int)dwCapacity)
+	{
+		ASSERT(capacity > 0);
+	}
+
+	int Cat(const BYTE* pData, int length)
+	{
+		ASSERT(pData != nullptr && length > 0);
+
+		int cat = min(Remain(), length);
+
+		if(cat > 0)
+		{
+			memcpy(buff.buf + buff.len, pData, cat);
+			buff.len += cat;
+		}
+
+		return cat;
+	}
+
+	void Reset()	{buff.len = 0;}
+	int Remain()	{return capacity - buff.len;}
+	BOOL IsFull()	{return buff.len == capacity;}
+};
+
+/* 数据缓冲区结构 */
+struct TBufferObj : public TBufferObjBase<TBufferObj>
+{
+	SOCKET client;
+};
+
+/* UDP 数据缓冲区结构 */
+struct TUdpBufferObj : public TBufferObjBase<TUdpBufferObj>
+{
+	SOCKADDR_IN	remoteAddr;
+	int			addrLen;
+};
+
+/* 数据缓冲区链表模板 */
+template<class T> struct TBufferObjListT : public TSimpleList<T>
+{
+public:
+	int Cat(const BYTE* pData, int length)
+	{
+		ASSERT(pData != nullptr && length > 0);
+
+		int remain = length;
+
+		while(remain > 0)
+		{
+			T* pItem = Back();
+
+			if(pItem == nullptr || pItem->IsFull())
+				pItem = PushBack(bfPool.PickFreeItem());
+
+			int cat  = pItem->Cat(pData, remain);
+
+			pData	+= cat;
+			remain	-= cat;
+		}
+
+		return length;
+	}
+
+	T* PushTail(const BYTE* pData, int length)
+	{
+		ASSERT(pData != nullptr && length > 0 && length <= (int)bfPool.GetItemCapacity());
+
+		T* pItem = PushBack(bfPool.PickFreeItem());
+		pItem->Cat(pData, length);
+
+		return pItem;
+	}
+
+	void Release()
+	{
+		bfPool.PutFreeItem(*this);
+	}
+
+public:
+	TBufferObjListT(CNodePoolT<T>& pool) : bfPool(pool)
+	{
+	}
+
+private:
+	CNodePoolT<T>& bfPool;
+};
+
+/* 数据缓冲区对象池 */
+typedef CNodePoolT<TBufferObj>			CBufferObjPool;
+/* UDP 数据缓冲区对象池 */
+typedef CNodePoolT<TUdpBufferObj>		CUdpBufferObjPool;
+/* 数据缓冲区链表模板 */
+typedef TBufferObjListT<TBufferObj>		TBufferObjList;
+/* UDP 数据缓冲区链表模板 */
+typedef TBufferObjListT<TUdpBufferObj>	TUdpBufferObjList;
+
+/* 数据缓冲区结构链表 */
+typedef CRingPool<TBufferObj>		TBufferObjPtrList;
+
+/* Udp 数据缓冲区结构链表 */
+typedef CRingPool<TUdpBufferObj>	TUdpBufferObjPtrList;
+
+/* Socket 缓冲区基础结构 */
+struct TSocketObjBase
+{
+	CONNID		connID;
+	SOCKADDR_IN	remoteAddr;
+	PVOID		extra;
+	PVOID		reserved;
+	PVOID		reserved2;
+	BOOL		valid;
+
+	union
+	{
+		DWORD	freeTime;
+		DWORD	connTime;
+	};
+
+	DWORD		activeTime;
+
+	CCriSec		csSend;
+
+	volatile BOOL smooth;
+	volatile long pending;
+	volatile long sndCount;
+
+	CReentrantSpinGuard csRecv;
+
+	static BOOL IsExist(TSocketObjBase* pSocketObj)
+		{return pSocketObj != nullptr;}
+
+	static BOOL IsValid(TSocketObjBase* pSocketObj)
+		{return pSocketObj != nullptr && pSocketObj->valid;}
+
+	static void Invalid(TSocketObjBase* pSocketObj)
+		{ASSERT(IsExist(pSocketObj)); pSocketObj->valid = FALSE;}
+
+	static BOOL IsSmooth(TSocketObjBase* pSocketObj)
+		{ASSERT(IsExist(pSocketObj)); return pSocketObj->valid && pSocketObj->smooth;}
+
+	static BOOL IsPending(TSocketObjBase* pSocketObj)
+		{ASSERT(IsExist(pSocketObj)); return pSocketObj->valid && pSocketObj->pending > 0;}
+
+	static void Release(TSocketObjBase* pSocketObj)
+	{
+		ASSERT(IsExist(pSocketObj));
+
+		pSocketObj->freeTime = ::TimeGetTime();
+	}
+
+	int Pending() {return pending;}
+
+	void Reset(CONNID dwConnID)
+	{
+		connID	 = dwConnID;
+		valid	 = TRUE;
+		smooth	 = TRUE;
+		pending	 = 0;
+		sndCount = 0;
+		extra	 = nullptr;
+		reserved = nullptr;
+		reserved2= nullptr;
+	}
+};
+
+/* 数据缓冲区结构 */
+struct TSocketObj : public TSocketObjBase
+{
+	SOCKET			socket;
+	CStringA		host;
+	TBufferObjList	sndBuff;
+	
+	TSocketObj(CBufferObjPool& bfPool)
+	: sndBuff(bfPool)
+	{
+
+	}
+
+	static void Release(TSocketObj* pSocketObj)
+	{
+		__super::Release(pSocketObj);
+
+		pSocketObj->sndBuff.Release();
+	}
+
+	void Reset(CONNID dwConnID, SOCKET soClient)
+	{
+		__super::Reset(dwConnID);
+		
+		host.Empty();
+
+		socket = soClient;
+	}
+
+	BOOL GetRemoteHost(LPCSTR* lpszHost, USHORT* pusPort = nullptr)
+	{
+		*lpszHost = host;
+
+		if(pusPort)
+			*pusPort = ntohs(remoteAddr.sin_port);
+
+		return (*lpszHost != nullptr && (*lpszHost)[0] != 0);
+	}
+};
+
+/* UDP 数据缓冲区结构 */
+struct TUdpSocketObj : public TSocketObjBase
+{
+	TUdpBufferObjList	sndBuff;
+	volatile DWORD		detectFails;
+
+	TUdpSocketObj(CUdpBufferObjPool& bfPool)
+	: sndBuff(bfPool)
+	{
+
+	}
+
+	static void Release(TUdpSocketObj* pSocketObj)
+	{
+		__super::Release(pSocketObj);
+
+		pSocketObj->sndBuff.Release();
+	}
+
+	void Reset(CONNID dwConnID)
+	{
+		__super::Reset(dwConnID);
+		detectFails = 0;
+	}
+};
+
+/* 有效 TSocketObj 缓存 */
+typedef CRingCache2<TSocketObj, CONNID, true>		TSocketObjPtrPool;
+/* 失效 TSocketObj 缓存 */
+typedef CRingPool<TSocketObj>						TSocketObjPtrList;
+/* 失效 TSocketObj 垃圾回收结构链表 */
+typedef CCASQueue<TSocketObj>						TSocketObjPtrQueue;
+
+/* 有效 TUdpSocketObj 缓存 */
+typedef CRingCache2<TUdpSocketObj, CONNID, true>	TUdpSocketObjPtrPool;
+/* 失效 TUdpSocketObj 缓存 */
+typedef CRingPool<TUdpSocketObj>					TUdpSocketObjPtrList;
+/* 失效 TUdpSocketObj 垃圾回收结构链表 */
+typedef CCASQueue<TUdpSocketObj>					TUdpSocketObjPtrQueue;
+
+/* SOCKADDR_IN 比较器 */
+struct sockaddr_func
+{
+	struct hash
+	{
+		size_t operator() (const SOCKADDR_IN* pA) const
+		{
+			return ((pA->sin_family << 16) | ntohs(pA->sin_port)) ^ pA->sin_addr.s_addr;
+		}
+	};
+
+	struct equal_to
+	{
+		bool operator () (const SOCKADDR_IN* pA, const SOCKADDR_IN* pB) const
+		{
+			return memcmp(pA, pB, offsetof(SOCKADDR_IN, sin_zero)) == 0;
+		}
+	};
+
+};
+
+/* 地址-连接 ID 哈希表 */
+typedef unordered_map<SOCKADDR_IN*, CONNID, sockaddr_func::hash, sockaddr_func::equal_to>
+										TSockAddrMap;
+/* 地址-连接 ID 哈希表迭代器 */
+typedef TSockAddrMap::iterator			TSockAddrMapI;
+/* 地址-连接 ID 哈希表 const 迭代器 */
+typedef TSockAddrMap::const_iterator	TSockAddrMapCI;
+
+/* IClient 组件关闭上下文 */
+struct TClientCloseContext
+{
+	BOOL bFireOnClose;
+	EnSocketOperation enOperation;
+	int iErrorCode;
+
+	TClientCloseContext(BOOL bFire = TRUE, EnSocketOperation enOp = SO_CLOSE, int iCode = SE_OK)
+	{
+		Reset(bFire, enOp, iCode);
+	}
+
+	void Reset(BOOL bFire = TRUE, EnSocketOperation enOp = SO_CLOSE, int iCode = SE_OK)
+	{
+		bFireOnClose = bFire;
+		enOperation	 = enOp;
+		iErrorCode	 = iCode;
+	}
+
+};
+
+/*****************************************************************************************************/
+/******************************************** 公共帮助方法 ********************************************/
+/*****************************************************************************************************/
+
+// 获取 HPSocket 版本号（4 个字节分别为：主版本号，子版本号，修正版本号，构建编号）
+DWORD GetHPSocketVersion();
+
+/* 获取错误描述文本 */
+LPCTSTR GetSocketErrorDesc(EnSocketError enCode);
+/* IPv4 字符串地址转换为整数 */
+ULONG GetIPv4InAddr(LPCTSTR lpszAddress);
+/* 检查字符串是否符合 IP 地址格式 */
+BOOL IsIPAddress(LPCTSTR lpszAddress);
+/* 通过主机名获取 IP 地址 */
+BOOL GetIPAddress(LPCTSTR lpszHost, __out LPTSTR lpszIP, __inout int& iIPLenth);
+/* 通过主机名获取最优的 IP 地址 */
+BOOL GetOptimalIPByHostName(LPCTSTR lpszHost, __out IN_ADDR& addr);
+/* 获取 IN_ADDR 结构的 IP 地址 */
+BOOL IN_ADDR_2_IP(const IN_ADDR& addr, __out LPTSTR lpszAddress, __inout int& iAddressLen);
+/* 把 SOCKADDR_IN 结构转换为地址数据 */
+BOOL sockaddr_IN_2_A(const SOCKADDR_IN& addr, __out ADDRESS_FAMILY& usFamily, __out LPTSTR lpszAddress, __inout int& iAddressLen, __out USHORT& usPort);
+/* 把地址数据转换为 SOCKADDR_IN 结构 */
+BOOL sockaddr_A_2_IN(ADDRESS_FAMILY usFamily, LPCTSTR lpszAddress, USHORT usPort, __out SOCKADDR_IN& addr);
+/* 获取 Socket 的本地或远程地址信息 */
+BOOL GetSocketAddress(SOCKET socket, __out LPTSTR lpszAddress, __inout int& iAddressLen, __out USHORT& usPort, BOOL bLocal = TRUE);
+/* 获取 Socket 的本地地址信息 */
+BOOL GetSocketLocalAddress(SOCKET socket, __out LPTSTR lpszAddress, __inout int& iAddressLen, __out USHORT& usPort);
+/* 获取 Socket 的远程地址信息 */
+BOOL GetSocketRemoteAddress(SOCKET socket, __out LPTSTR lpszAddress, __inout int& iAddressLen, __out USHORT& usPort);
+
+/* 64 位网络字节序转主机字节序 */
+ULONGLONG NToH64(ULONGLONG value);
+/* 64 位主机字节序转网络字节序 */
+ULONGLONG HToN64(ULONGLONG value);
+
+/* 获取 Socket 的某个扩展函数的指针 */
+PVOID GetExtensionFuncPtr					(SOCKET sock, GUID guid);
+/* 获取 AcceptEx 扩展函数指针 */
+LPFN_ACCEPTEX Get_AcceptEx_FuncPtr			(SOCKET sock);
+/* 获取 GetAcceptExSockaddrs 扩展函数指针 */
+LPFN_GETACCEPTEXSOCKADDRS Get_GetAcceptExSockaddrs_FuncPtr(SOCKET sock);
+/* 获取 ConnectEx 扩展函数指针 */
+LPFN_CONNECTEX Get_ConnectEx_FuncPtr		(SOCKET sock);
+/* 获取 TransmitFile 扩展函数指针 */
+LPFN_TRANSMITFILE Get_TransmitFile_FuncPtr	(SOCKET sock);
+/* 获取 DisconnectEx 扩展函数指针 */
+LPFN_DISCONNECTEX Get_DisconnectEx_FuncPtr	(SOCKET sock);
+
+HRESULT ReadSmallFile(LPCTSTR lpszFileName, CAtlFile& file, CAtlFileMapping<>& fmap, DWORD dwMaxFileSize = MAX_SMALL_FILE_SIZE);
+HRESULT MakeSmallFilePackage(LPCTSTR lpszFileName, CAtlFile& file, CAtlFileMapping<>& fmap, WSABUF szBuf[3], const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr);
+
+/************************************************************************
+名称：IOCP 指令投递帮助方法
+描述：简化 IOCP 指令投递
+************************************************************************/
+
+/* IOCP 命令 */
+enum EnIocpCommand
+{
+	IOCP_CMD_EXIT		= 0x00000000,	// 退出程序
+	IOCP_CMD_ACCEPT		= 0xFFFFFFF1,	// 接受连接
+	IOCP_CMD_DISCONNECT	= 0xFFFFFFF2,	// 断开连接
+	IOCP_CMD_SEND		= 0xFFFFFFF3	// 发送数据
+};
+
+/* IOCP 命令处理动作 */
+enum EnIocpAction
+{
+	IOCP_ACT_GOON		= 0,	// 继续执行
+	IOCP_ACT_CONTINUE	= 1,	// 重新执行
+	IOCP_ACT_BREAK		= 2		// 中断执行
+};
+
+BOOL PostIocpCommand(HANDLE hIOCP, EnIocpCommand enCmd, ULONG_PTR ulParam);
+BOOL PostIocpExit(HANDLE hIOCP);
+BOOL PostIocpAccept(HANDLE hIOCP);
+BOOL PostIocpDisconnect(HANDLE hIOCP, CONNID dwConnID);
+BOOL PostIocpSend(HANDLE hIOCP, CONNID dwConnID);
+BOOL PostIocpClose(HANDLE hIOCP, CONNID dwConnID, int iErrorCode);
+
+/************************************************************************
+名称：setsockopt() 帮助方法
+描述：简化常用的 setsockopt() 调用
+************************************************************************/
+
+int SSO_SetSocketOption		(SOCKET sock, int level, int name, LPVOID val, int len);
+int SSO_GetSocketOption		(SOCKET sock, int level, int name, LPVOID val, int* len);
+int SSO_IoctlSocket			(SOCKET sock, long cmd, u_long* arg);
+int SSO_WSAIoctl			(SOCKET sock, DWORD dwIoControlCode, LPVOID lpvInBuffer, DWORD cbInBuffer, LPVOID lpvOutBuffer, DWORD cbOutBuffer, LPDWORD lpcbBytesReturned);
+
+int SSO_UpdateAcceptContext	(SOCKET soClient, SOCKET soBind);
+int SSO_UpdateConnectContext(SOCKET soClient, int iOption);
+int SSO_NoDelay				(SOCKET sock, BOOL bNoDelay = TRUE);
+int SSO_DontLinger			(SOCKET sock, BOOL bDont = TRUE);
+int SSO_Linger				(SOCKET sock, USHORT l_onoff, USHORT l_linger);
+int SSO_KeepAlive			(SOCKET sock, BOOL bKeepAlive = TRUE);
+int SSO_KeepAliveVals		(SOCKET sock, u_long onoff, u_long time, u_long interval);
+int SSO_RecvBuffSize		(SOCKET sock, int size);
+int SSO_SendBuffSize		(SOCKET sock, int size);
+int SSO_ReuseAddress		(SOCKET sock, BOOL bReuse = TRUE);
+int SSO_UDP_ConnReset		(SOCKET sock, BOOL bNewBehavior = TRUE);
+
+/************************************************************************
+名称：Socket 操作方法
+描述：Socket 操作包装方法
+************************************************************************/
+
+/* 检测 IOCP 操作返回值：NO_ERROR 则返回 TRUE */
+#define IOCP_NO_ERROR(result)	(result == NO_ERROR)
+/* 检测 IOCP 操作返回值：WSA_IO_PENDING 则返回 TRUE */
+#define IOCP_PENDING(result)	(result == WSA_IO_PENDING)
+/* 检测 IOCP 操作返回值：NO_ERROR 或 WSA_IO_PENDING 则返回 TRUE */
+#define IOCP_SUCCESS(result)	(IOCP_NO_ERROR(result) || IOCP_PENDING(result))
+
+/* 生成 Connection ID */
+CONNID GenerateConnectionID	();
+/* 关闭 Socket */
+int ManualCloseSocket		(SOCKET sock, int iShutdownFlag = 0xFF, BOOL bGraceful = TRUE, BOOL bReuseAddress = FALSE);
+/* 投递 AccceptEx()，并把 WSA_IO_PENDING 转换为 NO_ERROR */
+int PostAccept				(LPFN_ACCEPTEX pfnAcceptEx, SOCKET soListen, SOCKET soClient, TBufferObj* pBufferObj);
+/* 投递 AccceptEx() */
+int PostAcceptNotCheck		(LPFN_ACCEPTEX pfnAcceptEx, SOCKET soListen, SOCKET soClient, TBufferObj* pBufferObj);
+/* 投递 ConnectEx()，并把 WSA_IO_PENDING 转换为 NO_ERROR */
+int PostConnect				(LPFN_CONNECTEX pfnConnectEx, SOCKET soClient, SOCKADDR_IN& soAddrIN, TBufferObj* pBufferObj);
+/* 投递 ConnectEx() */
+int PostConnectNotCheck		(LPFN_CONNECTEX pfnConnectEx, SOCKET soClient, SOCKADDR_IN& soAddrIN, TBufferObj* pBufferObj);
+/* 投递 WSASend()，并把 WSA_IO_PENDING 转换为 NO_ERROR */
+int PostSend				(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+/* 投递 WSASend() */
+int PostSendNotCheck		(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+/* 投递 WSARecv() ，并把 WSA_IO_PENDING 转换为 NO_ERROR*/
+int PostReceive				(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+/* 投递 WSARecv() */
+int PostReceiveNotCheck		(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+/* 投递 WSASendTo() ，并把 WSA_IO_PENDING 转换为 NO_ERROR*/
+int PostSendTo				(SOCKET sock, TUdpBufferObj* pBufferObj);
+/* 投递 WSASendTo() */
+int PostSendToNotCheck		(SOCKET sock, TUdpBufferObj* pBufferObj);
+/* 投递 WSARecvFrom() ，并把 WSA_IO_PENDING 转换为 NO_ERROR*/
+int PostReceiveFrom			(SOCKET sock, TUdpBufferObj* pBufferObj);
+/* 投递 WSARecvFrom() */
+int PostReceiveFromNotCheck	(SOCKET sock, TUdpBufferObj* pBufferObj);

socket/HP-Socket/Src/SocketInterface.h

@@ -0,0 +1,1985 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include <winsock2.h>
+
+#include "HPTypeDef.h"
+
+/*****************************************************************************************************************************************************/
+/***************************************************************** TCP/UDP Interfaces ****************************************************************/
+/*****************************************************************************************************************************************************/
+
+/************************************************************************
+名称：复合 Socket 组件接口
+描述：定义复合 Socket 组件的所有操作方法和属性访问方法，复合 Socket 组件同时管理多个 Socket 连接
+************************************************************************/
+class IComplexSocket
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：关闭通信组件
+	* 描述：关闭通信组件，关闭完成后断开所有连接并释放所有资源
+	*		
+	* 参数：	
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 GetLastError() 获取错误代码
+	*/
+	virtual BOOL Stop	()																		= 0;
+
+	/*
+	* 名称：发送数据
+	* 描述：向指定连接发送数据
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			pBuffer		-- 发送缓冲区
+	*			iLength		-- 发送缓冲区长度
+	*			iOffset		-- 发送缓冲区指针偏移量
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL Send	(CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset = 0)	= 0;
+
+	/*
+	* 名称：发送多组数据
+	* 描述：向指定连接发送多组数据
+	*		TCP - 顺序发送所有数据包 
+	*		UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） 
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			pBuffers	-- 发送缓冲区数组
+	*			iCount		-- 发送缓冲区数目
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL SendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount)	= 0;
+
+	/*
+	* 名称：断开连接
+	* 描述：断开某个连接
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			bForce		-- 是否强制断开连接
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败
+	*/
+	virtual BOOL Disconnect(CONNID dwConnID, BOOL bForce = TRUE)					= 0;
+
+	/*
+	* 名称：断开超时连接
+	* 描述：断开超过指定时长的连接
+	*		
+	* 参数：		dwPeriod	-- 时长（毫秒）
+	*			bForce		-- 是否强制断开连接
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败
+	*/
+	virtual BOOL DisconnectLongConnections(DWORD dwPeriod, BOOL bForce = TRUE)		= 0;
+
+	/*
+	* 名称：断开静默连接
+	* 描述：断开超过指定时长的静默连接
+	*		
+	* 参数：		dwPeriod	-- 时长（毫秒）
+	*			bForce		-- 是否强制断开连接
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败
+	*/
+	virtual BOOL DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce = TRUE)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/*
+	* 名称：设置连接的附加数据
+	* 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序自身决定
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			pv			-- 数据
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败（无效的连接 ID）
+	*/
+	virtual BOOL SetConnectionExtra		(CONNID dwConnID, PVOID pExtra)			= 0;
+
+	/*
+	* 名称：获取连接的附加数据
+	* 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序自身决定
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			ppv			-- 数据指针
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败（无效的连接 ID）
+	*/
+	virtual BOOL GetConnectionExtra			(CONNID dwConnID, PVOID* ppExtra)	= 0;
+
+	/* 检测是否为安全连接（SSL/HTTPS） */
+	virtual BOOL IsSecure				()									= 0;
+	/* 检查通信组件是否已启动 */
+	virtual BOOL HasStarted				()									= 0;
+	/* 查看通信组件当前状态 */
+	virtual EnServiceState GetState		()									= 0;
+	/* 获取连接数 */
+	virtual DWORD GetConnectionCount	()									= 0;
+	/* 获取所有连接的 CONNID */
+	virtual BOOL GetAllConnectionIDs	(CONNID pIDs[], DWORD& dwCount)		= 0;
+	/* 获取某个连接时长（毫秒） */
+	virtual BOOL GetConnectPeriod		(CONNID dwConnID, DWORD& dwPeriod)	= 0;
+	/* 获取某个连接静默时间（毫秒） */
+	virtual BOOL GetSilencePeriod		(CONNID dwConnID, DWORD& dwPeriod)	= 0;
+	/* 获取某个连接的本地地址信息 */
+	virtual BOOL GetLocalAddress		(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)	= 0;
+	/* 获取某个连接的远程地址信息 */
+	virtual BOOL GetRemoteAddress		(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)	= 0;
+	/* 获取最近一次失败操作的错误代码 */
+	virtual EnSocketError GetLastError	()									= 0;
+	/* 获取最近一次失败操作的错误描述 */
+	virtual LPCTSTR GetLastErrorDesc	()									= 0;
+	/* 获取连接中未发出数据的长度 */
+	virtual BOOL GetPendingDataLength	(CONNID dwConnID, int& iPending)	= 0;
+
+	/* 设置数据发送策略 */
+	virtual void SetSendPolicy				(EnSendPolicy enSendPolicy)		= 0;
+	/* 设置最大连接数（组件会根据设置值预分配内存，因此需要根据实际情况设置，不宜过大）*/
+	virtual void SetMaxConnectionCount		(DWORD dwMaxConnectionCount)	= 0;
+	/* 设置 Socket 缓存对象锁定时间（毫秒，在锁定期间该 Socket 缓存对象不能被获取使用） */
+	virtual void SetFreeSocketObjLockTime	(DWORD dwFreeSocketObjLockTime)	= 0;
+	/* 设置 Socket 缓存池大小（通常设置为平均并发连接数的 1/3 - 1/2） */
+	virtual void SetFreeSocketObjPool		(DWORD dwFreeSocketObjPool)		= 0;
+	/* 设置内存块缓存池大小（通常设置为 Socket 缓存池大小的 2 - 3 倍） */
+	virtual void SetFreeBufferObjPool		(DWORD dwFreeBufferObjPool)		= 0;
+	/* 设置 Socket 缓存池回收阀值（通常设置为 Socket 缓存池大小的 3 倍） */
+	virtual void SetFreeSocketObjHold		(DWORD dwFreeSocketObjHold)		= 0;
+	/* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */
+	virtual void SetFreeBufferObjHold		(DWORD dwFreeBufferObjHold)		= 0;
+	/* 设置工作线程数量（通常设置为 2 * CPU + 2） */
+	virtual void SetWorkerThreadCount		(DWORD dwWorkerThreadCount)		= 0;
+	/* 设置是否标记静默时间（设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效，默认：TRUE） */
+	virtual void SetMarkSilence				(BOOL bMarkSilence)				= 0;
+
+	/* 获取数据发送策略 */
+	virtual EnSendPolicy GetSendPolicy		()	= 0;
+	/* 获取最大连接数 */
+	virtual DWORD GetMaxConnectionCount		()	= 0;
+	/* 获取 Socket 缓存对象锁定时间 */
+	virtual DWORD GetFreeSocketObjLockTime	()	= 0;
+	/* 获取 Socket 缓存池大小 */
+	virtual DWORD GetFreeSocketObjPool		()	= 0;
+	/* 获取内存块缓存池大小 */
+	virtual DWORD GetFreeBufferObjPool		()	= 0;
+	/* 获取 Socket 缓存池回收阀值 */
+	virtual DWORD GetFreeSocketObjHold		()	= 0;
+	/* 获取内存块缓存池回收阀值 */
+	virtual DWORD GetFreeBufferObjHold		()	= 0;
+	/* 获取工作线程数量 */
+	virtual DWORD GetWorkerThreadCount		()	= 0;
+	/* 检测是否标记静默时间 */
+	virtual BOOL IsMarkSilence				()	= 0;
+
+public:
+	virtual ~IComplexSocket() {}
+};
+
+/************************************************************************
+名称：通信服务端组件接口
+描述：定义通信服务端组件的所有操作方法和属性访问方法
+************************************************************************/
+class IServer : public IComplexSocket
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：启动通信组件
+	* 描述：启动服务端通信组件，启动完成后可开始接收客户端连接并收发数据
+	*		
+	* 参数：		lpszBindAddress	-- 监听地址
+	*			usPort			-- 监听端口
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 GetLastError() 获取错误代码
+	*/
+	virtual BOOL Start	(LPCTSTR lpszBindAddress, USHORT usPort)							= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 获取监听 Socket 的地址信息 */
+	virtual BOOL GetListenAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)	= 0;
+};
+
+/************************************************************************
+名称：TCP 通信服务端组件接口
+描述：定义 TCP 通信服务端组件的所有操作方法和属性访问方法
+************************************************************************/
+class ITcpServer : public IServer
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送小文件
+	* 描述：向指定连接发送 4096 KB 以下的小文件
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszFileName	-- 文件路径
+	*			pHead			-- 头部附加数据
+	*			pTail			-- 尾部附加数据
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL SendSmallFile(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置 Accept 预投递数量（根据负载调整设置，Accept 预投递数量越大则支持的并发连接请求越多） */
+	virtual void SetAcceptSocketCount	(DWORD dwAcceptSocketCount)		= 0;
+	/* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */
+	virtual void SetSocketBufferSize	(DWORD dwSocketBufferSize)		= 0;
+	/* 设置监听 Socket 的等候队列大小（根据并发连接数量调整设置） */
+	virtual void SetSocketListenQueue	(DWORD dwSocketListenQueue)		= 0;
+	/* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */
+	virtual void SetKeepAliveTime		(DWORD dwKeepAliveTime)			= 0;
+	/* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */
+	virtual void SetKeepAliveInterval	(DWORD dwKeepAliveInterval)		= 0;
+
+	/* 获取 Accept 预投递数量 */
+	virtual DWORD GetAcceptSocketCount	()	= 0;
+	/* 获取通信数据缓冲区大小 */
+	virtual DWORD GetSocketBufferSize	()	= 0;
+	/* 获取监听 Socket 的等候队列大小 */
+	virtual DWORD GetSocketListenQueue	()	= 0;
+	/* 获取正常心跳包间隔 */
+	virtual DWORD GetKeepAliveTime		()	= 0;
+	/* 获取异常心跳包间隔 */
+	virtual DWORD GetKeepAliveInterval	()	= 0;
+};
+
+/************************************************************************
+名称：UDP 通信服务端组件接口
+描述：定义 UDP 通信服务端组件的所有操作方法和属性访问方法
+************************************************************************/
+class IUdpServer : public IServer
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */
+	virtual void SetMaxDatagramSize		(DWORD dwMaxDatagramSize)	= 0;
+	/* 获取数据报文最大长度 */
+	virtual DWORD GetMaxDatagramSize	()							= 0;
+
+	/* 设置 Receive 预投递数量（根据负载调整设置，Receive 预投递数量越大则丢包概率越小） */
+	virtual void SetPostReceiveCount	(DWORD dwPostReceiveCount)	= 0;
+	/* 获取 Receive 预投递数量 */
+	virtual DWORD GetPostReceiveCount	()							= 0;
+
+	/* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */
+	virtual void SetDetectAttempts		(DWORD dwDetectAttempts)	= 0;
+	/* 设置监测包发送间隔（秒，0 不发送监测包） */
+	virtual void SetDetectInterval		(DWORD dwDetectInterval)	= 0;
+	/* 获取心跳检查次数 */
+	virtual DWORD GetDetectAttempts		()							= 0;
+	/* 获取心跳检查间隔 */
+	virtual DWORD GetDetectInterval		()							= 0;
+};
+
+/************************************************************************
+名称：通信代理组件接口
+描述：定义通信代理组件的所有操作方法和属性访问方法，代理组件本质是一个同时连接多个服务器的客户端组件
+************************************************************************/
+class IAgent : public IComplexSocket
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：启动通信组件
+	* 描述：启动通信代理组件，启动完成后可开始连接远程服务器
+	*		
+	* 参数：		lpszBindAddress	-- 绑定地址（默认：nullptr，绑定 0.0.0.0）
+	*			bAsyncConnect	-- 是否采用异步 Connect
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 GetLastError() 获取错误代码
+	*/
+	virtual BOOL Start			(LPCTSTR lpszBindAddress = nullptr, BOOL bAsyncConnect = TRUE)				= 0;
+
+	/*
+	* 名称：连接服务器
+	* 描述：连接服务器，连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件
+	*		
+	* 参数：		lpszRemoteAddress	-- 服务端地址
+	*			usPort				-- 服务端端口
+	*			pdwConnID			-- 连接 ID（默认：nullptr，不获取连接 ID）
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL Connect		(LPCTSTR lpszRemoteAddress, USHORT usPort, CONNID* pdwConnID = nullptr)		= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 获取某个连接的远程主机信息 */
+	virtual BOOL GetRemoteHost	(CONNID dwConnID, TCHAR lpszHost[], int& iHostLen, USHORT& usPort)			= 0;
+
+};
+
+/************************************************************************
+名称：TCP 通信代理组件接口
+描述：定义 TCP 通信代理组件的所有操作方法和属性访问方法
+************************************************************************/
+class ITcpAgent : public IAgent
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送小文件
+	* 描述：向指定连接发送 4096 KB 以下的小文件
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszFileName	-- 文件路径
+	*			pHead			-- 头部附加数据
+	*			pTail			-- 尾部附加数据
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL SendSmallFile(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置是否启用地址重用机制（默认：不启用） */
+	virtual void SetReuseAddress		(BOOL bReuseAddress)			= 0;
+	/* 检测是否启用地址重用机制 */
+	virtual BOOL IsReuseAddress			()								= 0;
+
+	/* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */
+	virtual void SetSocketBufferSize	(DWORD dwSocketBufferSize)		= 0;
+	/* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */
+	virtual void SetKeepAliveTime		(DWORD dwKeepAliveTime)			= 0;
+	/* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */
+	virtual void SetKeepAliveInterval	(DWORD dwKeepAliveInterval)		= 0;
+
+	/* 获取通信数据缓冲区大小 */
+	virtual DWORD GetSocketBufferSize	()	= 0;
+	/* 获取正常心跳包间隔 */
+	virtual DWORD GetKeepAliveTime		()	= 0;
+	/* 获取异常心跳包间隔 */
+	virtual DWORD GetKeepAliveInterval	()	= 0;
+};
+
+/************************************************************************
+名称：通信客户端组件接口
+描述：定义通信客户端组件的所有操作方法和属性访问方法
+************************************************************************/
+class IClient
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：启动通信组件
+	* 描述：启动客户端通信组件并连接服务端，启动完成后可开始收发数据
+	*		
+	* 参数：		lpszRemoteAddress	-- 服务端地址
+	*			usPort				-- 服务端端口
+	*			bAsyncConnect		-- 是否采用异步 Connect
+	*			lpszBindAddress		-- 绑定地址（默认：nullptr，TcpClient/UdpClient -> 不执行绑定操作，UdpCast 绑定 -> 0.0.0.0）
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 GetLastError() 获取错误代码
+	*/
+	virtual BOOL Start	(LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr)	= 0;
+
+	/*
+	* 名称：关闭通信组件
+	* 描述：关闭客户端通信组件，关闭完成后断开与服务端的连接并释放所有资源
+	*		
+	* 参数：	
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 GetLastError() 获取错误代码
+	*/
+	virtual BOOL Stop	()																		= 0;
+
+	/*
+	* 名称：发送数据
+	* 描述：向服务端发送数据
+	*		
+	* 参数：		pBuffer		-- 发送缓冲区
+	*			iLength		-- 发送缓冲区长度
+	*			iOffset		-- 发送缓冲区指针偏移量
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL Send	(const BYTE* pBuffer, int iLength, int iOffset = 0)						= 0;
+
+	/*
+	* 名称：发送多组数据
+	* 描述：向服务端发送多组数据
+	*		TCP - 顺序发送所有数据包 
+	*		UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） 
+	*		
+	* 参数：		pBuffers	-- 发送缓冲区数组
+	*			iCount		-- 发送缓冲区数目
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL SendPackets(const WSABUF pBuffers[], int iCount)								= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置连接的附加数据 */
+	virtual void SetExtra					(PVOID pExtra)										= 0;
+
+	/* 获取连接的附加数据 */
+	virtual PVOID GetExtra					()													= 0;
+
+	/* 检测是否为安全连接（SSL/HTTPS） */
+	virtual BOOL IsSecure					()													= 0;
+	/* 检查通信组件是否已启动 */
+	virtual BOOL HasStarted					()													= 0;
+	/* 查看通信组件当前状态 */
+	virtual EnServiceState	GetState		()													= 0;
+	/* 获取最近一次失败操作的错误代码 */
+	virtual EnSocketError	GetLastError	()													= 0;
+	/* 获取最近一次失败操作的错误描述 */
+	virtual LPCTSTR			GetLastErrorDesc()													= 0;
+	/* 获取该组件对象的连接 ID */
+	virtual CONNID			GetConnectionID	()													= 0;
+	/* 获取 Client Socket 的地址信息 */
+	virtual BOOL GetLocalAddress		(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)	= 0;
+	/* 获取连接的远程主机信息 */
+	virtual BOOL GetRemoteHost			(TCHAR lpszHost[], int& iHostLen, USHORT& usPort)		= 0;
+	/* 获取连接中未发出数据的长度 */
+	virtual BOOL GetPendingDataLength	(int& iPending)											= 0;
+
+	/* 设置内存块缓存池大小（通常设置为 -> PUSH 模型：5 - 10；PULL 模型：10 - 20 ） */
+	virtual void SetFreeBufferPoolSize		(DWORD dwFreeBufferPoolSize)						= 0;
+	/* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */
+	virtual void SetFreeBufferPoolHold		(DWORD dwFreeBufferPoolHold)						= 0;
+
+	/* 获取内存块缓存池大小 */
+	virtual DWORD GetFreeBufferPoolSize		()													= 0;
+	/* 获取内存块缓存池回收阀值 */
+	virtual DWORD GetFreeBufferPoolHold		()													= 0;
+
+public:
+	virtual ~IClient() {}
+};
+
+/************************************************************************
+名称：TCP 通信客户端组件接口
+描述：定义 TCP 通信客户端组件的所有操作方法和属性访问方法
+************************************************************************/
+class ITcpClient : public IClient
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送小文件
+	* 描述：向服务端发送 4096 KB 以下的小文件
+	*		
+	* 参数：		lpszFileName	-- 文件路径
+	*			pHead			-- 头部附加数据
+	*			pTail			-- 尾部附加数据
+	* 返回值：	TRUE	-- 成功
+	*			FALSE	-- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码
+	*/
+	virtual BOOL SendSmallFile(LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为：(N * 1024) - sizeof(TBufferObj)） */
+	virtual void SetSocketBufferSize	(DWORD dwSocketBufferSize)	= 0;
+	/* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */
+	virtual void SetKeepAliveTime		(DWORD dwKeepAliveTime)		= 0;
+	/* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */
+	virtual void SetKeepAliveInterval	(DWORD dwKeepAliveInterval)	= 0;
+
+	/* 获取通信数据缓冲区大小 */
+	virtual DWORD GetSocketBufferSize	()	= 0;
+	/* 获取正常心跳包间隔 */
+	virtual DWORD GetKeepAliveTime		()	= 0;
+	/* 获取异常心跳包间隔 */
+	virtual DWORD GetKeepAliveInterval	()	= 0;
+};
+
+/************************************************************************
+名称：UDP 通信客户端组件接口
+描述：定义 UDP 通信客户端组件的所有操作方法和属性访问方法
+************************************************************************/
+class IUdpClient : public IClient
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */
+	virtual void SetMaxDatagramSize	(DWORD dwMaxDatagramSize)	= 0;
+	/* 获取数据报文最大长度 */
+	virtual DWORD GetMaxDatagramSize()							= 0;
+
+	/* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */
+	virtual void SetDetectAttempts	(DWORD dwDetectAttempts)	= 0;
+	/* 设置监测包发送间隔（秒，0 不发送监测包） */
+	virtual void SetDetectInterval	(DWORD dwDetectInterval)	= 0;
+	/* 获取心跳检查次数 */
+	virtual DWORD GetDetectAttempts	()							= 0;
+	/* 获取心跳检查间隔 */
+	virtual DWORD GetDetectInterval	()							= 0;
+};
+
+/************************************************************************
+名称：UDP 传播组件接口
+描述：定义 UDP 传播（组播或广播）组件的所有操作方法和属性访问方法
+************************************************************************/
+class IUdpCast : public IClient
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */
+	virtual void SetMaxDatagramSize	(DWORD dwMaxDatagramSize)		= 0;
+	/* 获取数据报文最大长度 */
+	virtual DWORD GetMaxDatagramSize()								= 0;
+
+	/* 设置是否启用地址重用机制（默认：不启用） */
+	virtual void SetReuseAddress	(BOOL bReuseAddress)			= 0;
+	/* 检测是否启用地址重用机制 */
+	virtual BOOL IsReuseAddress		()								= 0;
+
+	/* 设置传播模式（组播或广播） */
+	virtual void SetCastMode		(EnCastMode enCastMode)			= 0;
+	/* 获取传播模式 */
+	virtual EnCastMode GetCastMode	()								= 0;
+
+	/* 设置组播报文的 TTL（0 - 255） */
+	virtual void SetMultiCastTtl	(int iMCTtl)					= 0;
+	/* 获取组播报文的 TTL */
+	virtual int GetMultiCastTtl		()								= 0;
+
+	/* 设置是否启用组播环路（TRUE or FALSE） */
+	virtual void SetMultiCastLoop	(BOOL bMCLoop)					= 0;
+	/* 检测是否启用组播环路 */
+	virtual BOOL IsMultiCastLoop	()								= 0;
+
+	/* 获取当前数据报的远程地址信息（通常在 OnReceive 事件中调用） */
+	virtual BOOL GetRemoteAddress	(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)	= 0;
+};
+
+/************************************************************************
+名称：双接口模版类
+描述：定义双接口转换方法
+************************************************************************/
+template<class F, class S> class DualInterface : public F, public S
+{
+public:
+
+	/* this 转换为 F* */
+	inline static F* ToF(DualInterface* pThis)
+	{
+		return (F*)(pThis);
+	}
+
+	/* F* 转换为 this */
+	inline static DualInterface* FromF(F* pF)
+	{
+		return (DualInterface*)(pF);
+	}
+
+	/* this 转换为 S* */
+	inline static S* ToS(DualInterface* pThis)
+	{
+		return (S*)(F2S(ToF(pThis)));
+	}
+
+	/* S* 转换为 this */
+	inline static DualInterface* FromS(S* pS)
+	{
+		return FromF(S2F(pS));
+	}
+
+	/* S* 转换为 F* */
+	inline static F* S2F(S* pS)
+	{
+		return (F*)((char*)pS - sizeof(F));
+	}
+
+	/* F* 转换为 S* */
+	inline static S* F2S(F* pF)
+	{
+		return (S*)((char*)pF + sizeof(F));
+	}
+
+public:
+	~DualInterface() {}
+};
+
+/************************************************************************
+名称：Server/Agent PULL 模型组件接口
+描述：定义 Server/Agent 组件的 PULL 模型组件的所有操作方法
+************************************************************************/
+class IPullSocket
+{
+public:
+
+	/*
+	* 名称：抓取数据
+	* 描述：用户通过该方法从 Socket 组件中抓取数据
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			pData		-- 抓取缓冲区
+	*			iLength		-- 抓取数据长度
+	* 返回值：	EnFetchResult
+	*/
+	virtual EnFetchResult Fetch	(CONNID dwConnID, BYTE* pData, int iLength)	= 0;
+
+	/*
+	* 名称：窥探数据（不会移除缓冲区数据）
+	* 描述：用户通过该方法从 Socket 组件中窥探数据
+	*		
+	* 参数：		dwConnID	-- 连接 ID
+	*			pData		-- 窥探缓冲区
+	*			iLength		-- 窥探数据长度
+	* 返回值：	EnFetchResult
+	*/
+	virtual EnFetchResult Peek	(CONNID dwConnID, BYTE* pData, int iLength)	= 0;
+
+public:
+	virtual ~IPullSocket() {}
+};
+
+/************************************************************************
+名称：Client PULL 模型组件接口
+描述：定义 Client 组件的 PULL 模型组件的所有操作方法
+************************************************************************/
+class IPullClient
+{
+public:
+
+	/*
+	* 名称：抓取数据
+	* 描述：用户通过该方法从 Socket 组件中抓取数据
+	*		
+	* 参数：		pData		-- 抓取缓冲区
+	*			iLength		-- 抓取数据长度
+	* 返回值：	EnFetchResult
+	*/
+	virtual EnFetchResult Fetch	(BYTE* pData, int iLength)	= 0;
+
+	/*
+	* 名称：窥探数据（不会移除缓冲区数据）
+	* 描述：用户通过该方法从 Socket 组件中窥探数据
+	*		
+	* 参数：		pData		-- 窥探缓冲区
+	*			iLength		-- 窥探数据长度
+	* 返回值：	EnFetchResult
+	*/
+	virtual EnFetchResult Peek	(BYTE* pData, int iLength)	= 0;
+
+public:
+	virtual ~IPullClient() {}
+};
+
+/************************************************************************
+名称：TCP PULL 模型组件接口
+描述：继承了 PULL 和 Socket 接口
+************************************************************************/
+typedef	DualInterface<IPullSocket, ITcpServer>	ITcpPullServer;
+typedef	DualInterface<IPullSocket, ITcpAgent>	ITcpPullAgent;
+typedef	DualInterface<IPullClient, ITcpClient>	ITcpPullClient;
+
+/************************************************************************
+名称：Server/Agent PACK 模型组件接口
+描述：定义 Server/Agent 组件的 PACK 模型组件的所有操作方法
+************************************************************************/
+class IPackSocket
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */
+	virtual void SetMaxPackSize		(DWORD dwMaxPackSize)			= 0;
+	/* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */
+	virtual void SetPackHeaderFlag	(USHORT usPackHeaderFlag)		= 0;
+
+	/* 获取数据包最大长度 */
+	virtual DWORD GetMaxPackSize	()								= 0;
+	/* 获取包头标识 */
+	virtual USHORT GetPackHeaderFlag()								= 0;
+
+public:
+	virtual ~IPackSocket() {}
+};
+
+/************************************************************************
+名称：Client PACK 模型组件接口
+描述：定义 Client 组件的 PACK 模型组件的所有操作方法
+************************************************************************/
+class IPackClient
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */
+	virtual void SetMaxPackSize		(DWORD dwMaxPackSize)			= 0;
+	/* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */
+	virtual void SetPackHeaderFlag	(USHORT usPackHeaderFlag)		= 0;
+
+	/* 获取数据包最大长度 */
+	virtual DWORD GetMaxPackSize	()								= 0;
+	/* 获取包头标识 */
+	virtual USHORT GetPackHeaderFlag()								= 0;
+
+public:
+	virtual ~IPackClient() {}
+};
+
+/************************************************************************
+名称：TCP PACK 模型组件接口
+描述：继承了 PACK 和 Socket 接口
+************************************************************************/
+typedef	DualInterface<IPackSocket, ITcpServer>	ITcpPackServer;
+typedef	DualInterface<IPackSocket, ITcpAgent>	ITcpPackAgent;
+typedef	DualInterface<IPackClient, ITcpClient>	ITcpPackClient;
+
+/************************************************************************
+名称：Socket 监听器基接口
+描述：定义组件监听器的公共方法
+************************************************************************/
+template<class T> class ISocketListenerT
+{
+public:
+
+	/*
+	* 名称：握手完成通知
+	* 描述：连接完成握手时，Socket 监听器将收到该通知，监听器接收到该通知后才能开始
+	*		数据收发操作
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnHandShake(T* pSender, CONNID dwConnID)												= 0;
+
+	/*
+	* 名称：已发送数据通知
+	* 描述：成功发送数据后，Socket 监听器将收到该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			pData		-- 已发送数据缓冲区
+	*			iLength		-- 已发送数据长度
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 该通知不允许返回 HR_ERROR（调试模式下引发断言错误）
+	*/
+	virtual EnHandleResult OnSend(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength)					= 0;
+
+	/*
+	* 名称：数据到达通知（PUSH 模型）
+	* 描述：对于 PUSH 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			pData		-- 已接收数据缓冲区
+	*			iLength		-- 已接收数据长度
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				= 0;
+
+	/*
+	* 名称：数据到达通知（PULL 模型）
+	* 描述：对于 PULL 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			iLength		-- 已接收数据长度
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnReceive(T* pSender, CONNID dwConnID, int iLength)									= 0;
+
+	/*
+	* 名称：通信错误通知
+	* 描述：通信发生错误后，Socket 监听器将收到该通知，并关闭连接
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			enOperation	-- Socket 操作类型
+	*			iErrorCode	-- 错误代码
+	* 返回值：	忽略返回值
+	*/
+	virtual EnHandleResult OnClose(T* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode)	= 0;
+
+public:
+	virtual ~ISocketListenerT() {}
+};
+
+template<class T> class IComplexSocketListenerT : public ISocketListenerT<T>
+{
+public:
+
+	/*
+	* 名称：关闭通信组件通知
+	* 描述：通信组件关闭时，Socket 监听器将收到该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	* 返回值：忽略返回值
+	*/
+	virtual EnHandleResult OnShutdown(T* pSender)																= 0;
+
+};
+
+/************************************************************************
+名称：服务端 Socket 监听器接口
+描述：定义服务端 Socket 监听器的所有事件
+************************************************************************/
+template<class T> class IServerListenerT : public IComplexSocketListenerT<T>
+{
+public:
+
+	/*
+	* 名称：准备监听通知
+	* 描述：通信服务端组件启动时，在监听 Socket 创建完成并开始执行监听前，Socket 监听
+	*		器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			soListen	-- 监听 Socket
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 终止启动通信服务组件
+	*/
+	virtual EnHandleResult OnPrepareListen(T* pSender, SOCKET soListen)						= 0;
+
+	/*
+	* 名称：接收连接通知
+	* 描述：接收到客户端连接请求时，Socket 监听器将收到该通知，监听器可以在通知处理方
+	*		法中执行 Socket 选项设置或拒绝客户端连接等额外工作
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			soClient	-- TCP: 客户端 Socket 句柄，UDP: 客户端 Socket SOCKADDR_IN 指针
+	* 返回值：	HR_OK / HR_IGNORE	-- 接受连接
+	*			HR_ERROR			-- 拒绝连接
+	*/
+	virtual EnHandleResult OnAccept(T* pSender, CONNID dwConnID, UINT_PTR soClient)			= 0;
+};
+
+/************************************************************************
+名称：TCP 服务端 Socket 监听器接口
+描述：定义 TCP 服务端 Socket 监听器的所有事件
+************************************************************************/
+class ITcpServerListener : public IServerListenerT<ITcpServer>
+{
+public:
+
+};
+
+/************************************************************************
+名称：PUSH 模型服务端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpServerListener : public ITcpServerListener
+{
+public:
+	virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen)							{return HR_IGNORE;}
+	virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient)				{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID)								{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength)						{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+	virtual EnHandleResult OnShutdown(ITcpServer* pSender)													{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：PULL 模型服务端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpPullServerListener : public CTcpServerListener
+{
+public:
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength)						= 0;
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)	{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：UDP 服务端 Socket 监听器接口
+描述：定义 UDP 服务端 Socket 监听器的所有事件
+************************************************************************/
+class IUdpServerListener : public IServerListenerT<IUdpServer>
+{
+public:
+
+};
+
+/************************************************************************
+名称：UDP 服务端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CUdpServerListener : public IUdpServerListener
+{
+public:
+	virtual EnHandleResult OnPrepareListen(IUdpServer* pSender, SOCKET soListen)						{return HR_IGNORE;}
+	virtual EnHandleResult OnAccept(IUdpServer* pSender, CONNID dwConnID, UINT_PTR pSockAddr)			{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(IUdpServer* pSender, CONNID dwConnID)							{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(IUdpServer* pSender, CONNID dwConnID, int iLength)					{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(IUdpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)	{return HR_IGNORE;}
+	virtual EnHandleResult OnShutdown(IUdpServer* pSender)												{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：通信代理 Socket 监听器接口
+描述：定义 通信代理 Socket 监听器的所有事件
+************************************************************************/
+template<class T> class IAgentListenerT : public IComplexSocketListenerT<T>
+{
+public:
+
+	/*
+	* 名称：准备连接通知
+	* 描述：通信客户端组件启动时，在客户端 Socket 创建完成并开始执行连接前，Socket 监听
+	*		器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			socket		-- 客户端 Socket
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 终止启动通信客户端组件
+	*/
+	virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket)		= 0;
+
+	/*
+	* 名称：连接完成通知
+	* 描述：与服务端成功建立连接时，Socket 监听器将收到该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 同步连接：终止启动通信客户端组件
+	*								   异步连接：关闭连接
+	*/
+	virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID)							= 0;
+};
+
+/************************************************************************
+名称：TCP 通信代理 Socket 监听器接口
+描述：定义 TCP 通信代理 Socket 监听器的所有事件
+************************************************************************/
+class ITcpAgentListener : public IAgentListenerT<ITcpAgent>
+{
+public:
+
+};
+
+/************************************************************************
+名称：PUSH 模型通信代理 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpAgentListener : public ITcpAgentListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket)				{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength)						{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+	virtual EnHandleResult OnShutdown(ITcpAgent* pSender)													{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：PULL 通信代理 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpPullAgentListener : public CTcpAgentListener
+{
+public:
+	virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength)						= 0;
+	virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength)	{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：客户端 Socket 监听器接口
+描述：定义客户端 Socket 监听器的所有事件
+************************************************************************/
+
+template<class T> class IClientListenerT : public ISocketListenerT<T>
+{
+public:
+	
+	/*
+	* 名称：准备连接通知
+	* 描述：通信客户端组件启动时，在客户端 Socket 创建完成并开始执行连接前，Socket 监听
+	*		器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			socket		-- 客户端 Socket
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 终止启动通信客户端组件
+	*/
+	virtual EnHandleResult OnPrepareConnect(T* pSender, CONNID dwConnID, SOCKET socket)						= 0;
+
+	/*
+	* 名称：连接完成通知
+	* 描述：与服务端成功建立连接时，Socket 监听器将收到该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 同步连接：终止启动通信客户端组件
+	*								   异步连接：关闭连接
+	*/
+	virtual EnHandleResult OnConnect(T* pSender, CONNID dwConnID)											= 0;
+};
+
+/************************************************************************
+名称：TCP 客户端 Socket 监听器接口
+描述：定义 TCP 客户端 Socket 监听器的所有事件
+************************************************************************/
+class ITcpClientListener : public IClientListenerT<ITcpClient>
+{
+public:
+
+};
+
+/************************************************************************
+名称：PUSH 模型客户端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpClientListener : public ITcpClientListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket)			{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID)								{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength)						{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：PULL 客户端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CTcpPullClientListener : public CTcpClientListener
+{
+public:
+	virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength)						= 0;
+	virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)	{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：UDP 客户端 Socket 监听器接口
+描述：定义 UDP 客户端 Socket 监听器的所有事件
+************************************************************************/
+class IUdpClientListener : public IClientListenerT<IUdpClient>
+{
+public:
+
+};
+
+/************************************************************************
+名称：UDP 户端 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CUdpClientListener : public IUdpClientListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(IUdpClient* pSender, CONNID dwConnID, SOCKET socket)			{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(IUdpClient* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(IUdpClient* pSender, CONNID dwConnID)								{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(IUdpClient* pSender, CONNID dwConnID, int iLength)						{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(IUdpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：UDP 传播 Socket 监听器接口
+描述：定义 UDP 传播 Socket 监听器的所有事件
+************************************************************************/
+class IUdpCastListener : public IClientListenerT<IUdpCast>
+{
+public:
+
+};
+
+/************************************************************************
+名称：UDP 传播 Socket 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CUdpCastListener : public IUdpCastListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(IUdpCast* pSender, CONNID dwConnID, SOCKET socket)				{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(IUdpCast* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(IUdpCast* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(IUdpCast* pSender, CONNID dwConnID, int iLength)						{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(IUdpCast* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+};
+
+/*****************************************************************************************************************************************************/
+/****************************************************************** HTTP Interfaces ******************************************************************/
+/*****************************************************************************************************************************************************/
+
+/************************************************************************
+名称：复合 Http 组件接口
+描述：定义复合 Http 组件的所有操作方法和属性访问方法，复合 Http 组件同时管理多个 Http 连接
+************************************************************************/
+class IComplexHttp
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送 WebSocket 消息
+	* 描述：向对端端发送 WebSocket 消息
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			bFinal			-- 是否结束帧
+	*			iReserved		-- RSV1/RSV2/RSV3 各 1 位
+	*			iOperationCode	-- 操作码：0x0 - 0xF
+	*			lpszMask		-- 掩码（nullptr 或 4 字节掩码，如果为 nullptr 则没有掩码）
+	*			pData			-- 消息体数据缓冲区
+	*			iLength			-- 消息体数据长度
+	*			ullBodyLen		-- 消息总长度
+	* 								ullBodyLen = 0		 -> 消息总长度为 iLength
+	* 								ullBodyLen = iLength -> 消息总长度为 ullBodyLen
+	* 								ullBodyLen > iLength -> 消息总长度为 ullBodyLen，后续消息体长度为 ullBOdyLen - iLength，后续消息体通过底层方法 Send() / SendPackets() 发送
+	* 								ullBodyLen < iLength -> 错误参数，发送失败
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendWSMessage(CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4] = nullptr, BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置本地协议版本 */
+	virtual void SetLocalVersion(EnHttpVersion usVersion)								= 0;
+	/* 获取本地协议版本 */
+	virtual EnHttpVersion GetLocalVersion()												= 0;
+
+	/* 检查是否升级协议 */
+	virtual BOOL IsUpgrade(CONNID dwConnID)												= 0;
+	/* 检查是否有 Keep-Alive 标识 */
+	virtual BOOL IsKeepAlive(CONNID dwConnID)											= 0;
+	/* 获取协议版本 */
+	virtual USHORT GetVersion(CONNID dwConnID)											= 0;
+	/* 获取内容长度 */
+	virtual ULONGLONG GetContentLength(CONNID dwConnID)									= 0;
+	/* 获取内容类型 */
+	virtual LPCSTR GetContentType(CONNID dwConnID)										= 0;
+	/* 获取内容编码 */
+	virtual LPCSTR GetContentEncoding(CONNID dwConnID)									= 0;
+	/* 获取传输编码 */
+	virtual LPCSTR GetTransferEncoding(CONNID dwConnID)									= 0;
+	/* 获取协议升级类型 */
+	virtual EnHttpUpgradeType GetUpgradeType(CONNID dwConnID)							= 0;
+	/* 获取解析错误代码 */
+	virtual USHORT GetParseErrorCode(CONNID dwConnID, LPCSTR* lpszErrorDesc = nullptr)	= 0;
+
+	/* 获取某个请求头（单值） */
+	virtual BOOL GetHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	/* 获取某个请求头（多值） */
+	virtual BOOL GetHeaders(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount)	= 0;
+	/* 获取所有请求头 */
+	virtual BOOL GetAllHeaders(CONNID dwConnID, THeader lpHeaders[], DWORD& dwCount)				= 0;
+	/* 获取所有请求头名称 */
+	virtual BOOL GetAllHeaderNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount)				= 0;
+
+	/* 获取 Cookie */
+	virtual BOOL GetCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	/* 获取所有 Cookie */
+	virtual BOOL GetAllCookies(CONNID dwConnID, TCookie lpCookies[], DWORD& dwCount)				= 0;
+
+	/*
+	// !! maybe implemented in future !! //
+
+	virtual BOOL GetParam(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	virtual BOOL GetParams(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount)	= 0;
+	virtual BOOL GetAllParams(CONNID dwConnID, LPPARAM lpszParam[], DWORD& dwCount)					= 0;
+	virtual BOOL GetAllParamNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount)				= 0;
+	*/
+
+	/* 获取当前 WebSocket 消息状态，传入 nullptr 则不获取相应字段 */
+	virtual BOOL GetWSMessageState(CONNID dwConnID, BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain)	= 0;
+
+public:
+	virtual ~IComplexHttp() {}
+};
+
+/************************************************************************
+名称：复合 Http 请求者组件接口
+描述：定义复合 Http 请求者组件的所有操作方法和属性访问方法
+************************************************************************/
+class IComplexHttpRequester : public IComplexHttp
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送请求
+	* 描述：向服务端发送 HTTP 请求
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszMethod		-- 请求方法
+	*			lpszPath		-- 请求路径
+	*			lpHeaders		-- 请求头
+	*			iHeaderCount	-- 请求头数量
+	*			pBody			-- 请求体
+	*			iLength			-- 请求体长度
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendRequest(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0)	= 0;
+
+	/*
+	* 名称：发送本地文件
+	* 描述：向指定连接发送 4096 KB 以下的小文件
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszFileName	-- 文件路径
+	*			lpszMethod		-- 请求方法
+	*			lpszPath		-- 请求路径
+	*			lpHeaders		-- 请求头
+	*			iHeaderCount	-- 请求头数量
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)							= 0;
+
+	/* 发送 POST 请求 */
+	virtual BOOL SendPost(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)													= 0;
+	/* 发送 PUT 请求 */
+	virtual BOOL SendPut(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)														= 0;
+	/* 发送 PATCH 请求 */
+	virtual BOOL SendPatch(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)													= 0;
+	/* 发送 GET 请求 */
+	virtual BOOL SendGet(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 DELETE 请求 */
+	virtual BOOL SendDelete(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																	= 0;
+	/* 发送 HEAD 请求 */
+	virtual BOOL SendHead(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 TRACE 请求 */
+	virtual BOOL SendTrace(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 OPTIONS 请求 */
+	virtual BOOL SendOptions(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																	= 0;
+	/* 发送 CONNECT 请求 */
+	virtual BOOL SendConnect(CONNID dwConnID, LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 获取 HTTP 状态码 */
+	virtual USHORT GetStatusCode(CONNID dwConnID)						= 0;
+
+	/* 设置是否使用 Cookie（默认：TRUE） */
+	virtual void SetUseCookie(BOOL bUseCookie)							= 0;
+	/* 检查是否使用 Cookie */
+	virtual BOOL IsUseCookie()											= 0;
+};
+
+/************************************************************************
+名称：复合 Http 响应者组件接口
+描述：定义复合 Http 响应者组件的所有操作方法和属性访问方法
+************************************************************************/
+class IComplexHttpResponder : public IComplexHttp
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：回复请求
+	* 描述：向客户端回复 HTTP 请求
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			usStatusCode	-- HTTP 状态码
+	*			lpszDesc		-- HTTP 状态描述
+	*			lpHeaders		-- 回复请求头
+	*			iHeaderCount	-- 回复请求头数量
+	*			pData			-- 回复请求体
+	*			iLength			-- 回复请求体长度
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendResponse(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pData = nullptr, int iLength = 0)	= 0;
+
+	/*
+	* 名称：发送本地文件
+	* 描述：向指定连接发送 4096 KB 以下的小文件
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszFileName	-- 文件路径
+	*			usStatusCode	-- HTTP 状态码
+	*			lpszDesc		-- HTTP 状态描述
+	*			lpHeaders		-- 回复请求头
+	*			iHeaderCount	-- 回复请求头数量
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendLocalFile(CONNID dwConnID, LPCSTR lpszFileName, USHORT usStatusCode = HSC_OK, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)				= 0;
+
+	/*
+	* 名称：释放连接
+	* 描述：把连接放入释放队列，等待某个时间（通过 SetReleaseDelay() 设置）关闭连接
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL Release(CONNID dwConnID)								= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 获取主机 */
+	virtual LPCSTR GetHost(CONNID dwConnID)								= 0;
+
+	/* 设置连接释放延时（默认：3000 毫秒） */
+	virtual void SetReleaseDelay(DWORD dwReleaseDelay)					= 0;
+	/* 获取连接释放延时 */
+	virtual DWORD GetReleaseDelay()										= 0;
+
+	/* 获取请求行 URL 域掩码（URL 域参考：EnHttpUrlField） */
+	virtual USHORT GetUrlFieldSet(CONNID dwConnID)						= 0;
+	/* 获取某个 URL 域值 */
+	virtual LPCSTR GetUrlField(CONNID dwConnID, EnHttpUrlField enField)	= 0;
+	/* 获取请求方法 */
+	virtual LPCSTR GetMethod(CONNID dwConnID)							= 0;
+};
+
+/************************************************************************
+名称：简单 HTTP 组件接口
+描述：定义 简单 HTTP 组件的所有操作方法和属性访问方法
+************************************************************************/
+class IHttp
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送 WebSocket 消息
+	* 描述：向对端端发送 WebSocket 消息
+	*		
+	* 参数：		bFinal			-- 是否结束帧
+	*			iReserved		-- RSV1/RSV2/RSV3 各 1 位
+	*			iOperationCode	-- 操作码：0x0 - 0xF
+	*			lpszMask		-- 掩码（nullptr 或 4 字节掩码，如果为 nullptr 则没有掩码）
+	*			pData			-- 消息体数据缓冲区
+	*			iLength			-- 消息体数据长度
+	*			ullBodyLen		-- 消息总长度
+	* 								ullBodyLen = 0		 -> 消息总长度为 iLength
+	* 								ullBodyLen = iLength -> 消息总长度为 ullBodyLen
+	* 								ullBodyLen > iLength -> 消息总长度为 ullBodyLen，后续消息体长度为 ullBOdyLen - iLength，后续消息体通过底层方法 Send() / SendPackets() 发送
+	* 								ullBodyLen < iLength -> 错误参数，发送失败
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendWSMessage(BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4] = nullptr, BYTE* pData = nullptr, int iLength = 0, ULONGLONG ullBodyLen = 0)	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置本地协议版本 */
+	virtual void SetLocalVersion(EnHttpVersion usVersion)				= 0;
+	/* 获取本地协议版本 */
+	virtual EnHttpVersion GetLocalVersion()								= 0;
+
+	/* 检查是否升级协议 */
+	virtual BOOL IsUpgrade()											= 0;
+	/* 检查是否有 Keep-Alive 标识 */
+	virtual BOOL IsKeepAlive()											= 0;
+	/* 获取协议版本 */
+	virtual USHORT GetVersion()											= 0;
+	/* 获取内容长度 */
+	virtual ULONGLONG GetContentLength()								= 0;
+	/* 获取内容类型 */
+	virtual LPCSTR GetContentType()										= 0;
+	/* 获取内容编码 */
+	virtual LPCSTR GetContentEncoding()									= 0;
+	/* 获取传输编码 */
+	virtual LPCSTR GetTransferEncoding()								= 0;
+	/* 获取协议升级类型 */
+	virtual EnHttpUpgradeType GetUpgradeType()							= 0;
+	/* 获取解析错误代码 */
+	virtual USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr)	= 0;
+
+	/* 获取 HTTP 状态码 */
+	virtual USHORT GetStatusCode()										= 0;
+
+	/* 获取某个请求头（单值） */
+	virtual BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	/* 获取某个请求头（多值） */
+	virtual BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount)	= 0;
+	/* 获取所有请求头 */
+	virtual BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount)					= 0;
+	/* 获取所有请求头名称 */
+	virtual BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount)				= 0;
+
+	/* 获取 Cookie */
+	virtual BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	/* 获取所有 Cookie */
+	virtual BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount)					= 0;
+
+	/*
+	// !! maybe implemented in future !! //
+
+	virtual BOOL GetParam(LPCSTR lpszName, LPCSTR* lpszValue)						= 0;
+	virtual BOOL GetParams(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount)		= 0;
+	virtual BOOL GetAllParams(LPPARAM lpszParam[], DWORD& dwCount)					= 0;
+	virtual BOOL GetAllParamNames(LPCSTR lpszName[], DWORD& dwCount)				= 0;
+	*/
+
+	/* 获取当前 WebSocket 消息状态，传入 nullptr 则不获取相应字段 */
+	virtual BOOL GetWSMessageState(BOOL* lpbFinal, BYTE* lpiReserved, BYTE* lpiOperationCode, LPCBYTE* lpszMask, ULONGLONG* lpullBodyLen, ULONGLONG* lpullBodyRemain)	= 0;
+
+public:
+	virtual ~IHttp() {}
+};
+
+/************************************************************************
+名称：简单 Http 请求者组件接口
+描述：定义简单 Http 请求者组件的所有操作方法和属性访问方法
+************************************************************************/
+class IHttpRequester : public IHttp
+{
+public:
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：发送请求
+	* 描述：向服务端发送 HTTP 请求
+	*		
+	* 参数：		lpszMethod		-- 请求方法
+	*			lpszPath		-- 请求路径
+	*			lpHeaders		-- 请求头
+	*			iHeaderCount	-- 请求头数量
+	*			pBody			-- 请求体
+	*			iLength			-- 请求体长度
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendRequest(LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0)	= 0;
+
+	/*
+	* 名称：发送本地文件
+	* 描述：向指定连接发送 4096 KB 以下的小文件
+	*		
+	* 参数：		dwConnID		-- 连接 ID
+	*			lpszFileName	-- 文件路径
+	*			lpszMethod		-- 请求方法
+	*			lpszPath		-- 请求路径
+	*			lpHeaders		-- 请求头
+	*			iHeaderCount	-- 请求头数量
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL SendLocalFile(LPCSTR lpszFileName, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)							= 0;
+
+	/* 发送 POST 请求 */
+	virtual BOOL SendPost(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)														= 0;
+	/* 发送 PUT 请求 */
+	virtual BOOL SendPut(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)														= 0;
+	/* 发送 PATCH 请求 */
+	virtual BOOL SendPatch(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength)													= 0;
+	/* 发送 GET 请求 */
+	virtual BOOL SendGet(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 DELETE 请求 */
+	virtual BOOL SendDelete(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 HEAD 请求 */
+	virtual BOOL SendHead(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 TRACE 请求 */
+	virtual BOOL SendTrace(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																		= 0;
+	/* 发送 OPTIONS 请求 */
+	virtual BOOL SendOptions(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																	= 0;
+	/* 发送 CONNECT 请求 */
+	virtual BOOL SendConnect(LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0)																	= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置是否使用 Cookie（默认：TRUE） */
+	virtual void SetUseCookie(BOOL bUseCookie)								= 0;
+	/* 检查是否使用 Cookie */
+	virtual BOOL IsUseCookie()												= 0;
+};
+
+/************************************************************************
+名称：简单 Http 同步请求者组件接口
+描述：定义简单 Http 同步请求者组件的所有操作方法和属性访问方法
+************************************************************************/
+class IHttpSyncRequester : public IHttpRequester
+{
+public:
+
+	/*
+	* 名称：发送 URL 请求
+	* 描述：向服务端发送 HTTP URL 请求
+	*		
+	* 参数：		lpszMethod		-- 请求方法
+	*			lpszUrl			-- 请求 URL
+	*			lpHeaders		-- 请求头
+	*			iHeaderCount	-- 请求头数量
+	*			pBody			-- 请求体
+	*			iLength			-- 请求体长度
+	*			bForceReconnect	-- 强制重新连接（默认：FALSE，当请求 URL 的主机和端口与现有连接一致时，重用现有连接）
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL OpenUrl(LPCSTR lpszMethod, LPCSTR lpszUrl, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0, BOOL bForceReconnect = FALSE)	= 0;
+
+	/***********************************************************************/
+	/***************************** 组件操作方法 *****************************/
+
+	/*
+	* 名称：清除请求结果
+	* 描述：清除上一次请求的响应头和响应体等结果信息（该方法会在每次发送请求前自动调用）
+	*
+	* 参数：		
+	* 返回值：	TRUE			-- 成功
+	*			FALSE			-- 失败
+	*/
+	virtual BOOL CleanupRequestResult	()									= 0;
+
+public:
+
+	/***********************************************************************/
+	/***************************** 属性访问方法 *****************************/
+
+	/* 设置连接超时（毫秒，0：系统默认超时，默认：5000） */
+	virtual void SetConnectTimeout		(DWORD dwConnectTimeout)			= 0;
+	/* 设置请求超时（毫秒，0：无限等待，默认：10000） */
+	virtual void SetRequestTimeout		(DWORD dwRequestTimeout)			= 0;
+
+	/* 获取连接超时 */
+	virtual DWORD GetConnectTimeout		()									= 0;
+	/* 获取请求超时 */
+	virtual DWORD GetRequestTimeout		()									= 0;
+
+	/* 获取响应体 */
+	virtual BOOL GetResponseBody		(LPCBYTE* lpszBody, int* iLength)	= 0;
+};
+
+
+/************************************************************************
+名称：HTTP 组件接口
+描述：继承了 HTTP 和 Socket 接口
+************************************************************************/
+typedef DualInterface<IComplexHttpResponder, ITcpServer>	IHttpServer;
+typedef DualInterface<IComplexHttpRequester, ITcpAgent>		IHttpAgent;
+typedef DualInterface<IHttpRequester, ITcpClient>			IHttpClient;
+typedef DualInterface<IHttpSyncRequester, ITcpClient>		IHttpSyncClient;
+
+/************************************************************************
+名称：IComplexHttp 组件监听器基接口
+描述：定义 IComplexHttp 组件监听器的所有事件
+************************************************************************/
+template<class T> class IHttpListenerT
+{
+public:
+
+	/*
+	* 名称：开始解析通知
+	* 描述：开始解析 HTTP 报文时，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnMessageBegin(T* pSender, CONNID dwConnID)										= 0;
+
+	/*
+	* 名称：请求行解析完成通知（仅用于 HTTP 服务端）
+	* 描述：请求行解析完成后，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			lpszMethod	-- 请求方法名
+	*			lpszUrl		-- 请求行中的 URL 域
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnRequestLine(T* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl)		= 0;
+
+	/*
+	* 名称：状态行解析完成通知（仅用于 HTTP 客户端）
+	* 描述：状态行解析完成后，向监听器发送该通知
+	*		
+	* 参数：		pSender			-- 事件源对象
+	*			dwConnID		-- 连接 ID
+	*			usStatusCode	-- HTTP 状态码
+	*			lpszDesc		-- 状态描述
+	* 返回值：	HPR_OK			-- 继续执行
+	*			HPR_ERROR		-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnStatusLine(T* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc)	= 0;
+
+	/*
+	* 名称：请求头通知
+	* 描述：每当解析完成一个请求头后，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			lpszName	-- 请求头名称
+	*			lpszValue	-- 请求头值
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnHeader(T* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue)			= 0;
+
+	/*
+	* 名称：请求头完成通知
+	* 描述：解析完成所有请求头后，向监听器发送该通知
+	*		
+	* 参数：		pSender			-- 事件源对象
+	*			dwConnID		-- 连接 ID
+	* 返回值：	HPR_OK			-- 继续执行
+	*			HPR_SKIP_BODY	-- 跳过当前请求的 HTTP BODY
+	*			HPR_UPGRADE		-- 升级协议
+	*			HPR_ERROR		-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnHeadersComplete(T* pSender, CONNID dwConnID)									= 0;
+
+	/*
+	* 名称：BODY 报文通知
+	* 描述：每当接收到 HTTP BODY 报文，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			pData		-- 数据缓冲区
+	*			iLength		-- 数据长度
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				= 0;
+
+	/*
+	* 名称：Chunked 报文头通知
+	* 描述：每当解析出一个 Chunked 报文头，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			iLength		-- Chunked 报文体数据长度
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnChunkHeader(T* pSender, CONNID dwConnID, int iLength)							= 0;
+
+	/*
+	* 名称：Chunked 报文结束通知
+	* 描述：每当解析完一个 Chunked 报文，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnChunkComplete(T* pSender, CONNID dwConnID)										= 0;
+
+	/*
+	* 名称：完成解析通知
+	* 描述：每当解析完成一个完整 HTTP 报文，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HPR_OK		-- 继续执行
+	*			HPR_ERROR	-- 引发 OnParserError() 和 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnMessageComplete(T* pSender, CONNID dwConnID)									= 0;
+
+	/*
+	* 名称：升级协议通知
+	* 描述：当需要升级协议时，向监听器发送该通知
+	*		
+	* 参数：		pSender			-- 事件源对象
+	*			dwConnID		-- 连接 ID
+	*			enUpgradeType	-- 协议类型
+	* 返回值：	HPR_OK			-- 继续执行
+	*			HPR_ERROR		-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnUpgrade(T* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType)			= 0;
+
+	/*
+	* 名称：解析错误通知
+	* 描述：当解析 HTTP 报文错误时，向监听器发送该通知
+	*		
+	* 参数：		pSender			-- 事件源对象
+	*			dwConnID		-- 连接 ID
+	*			iErrorCode		-- 错误代码
+	*			lpszErrorDesc	-- 错误描述
+	* 返回值：	HPR_OK			-- 继续执行
+	*			HPR_ERROR		-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHttpParseResult OnParseError(T* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc)	= 0;
+
+	/*
+	* 名称：WebSocket 数据包头通知
+	* 描述：当解析 WebSocket 数据包头时，向监听器发送该通知
+	*		
+	* 参数：		pSender			-- 事件源对象
+	*			dwConnID		-- 连接 ID
+	*			bFinal			-- 是否结束帧
+	*			iReserved		-- RSV1/RSV2/RSV3 各 1 位
+	*			iOperationCode	-- 操作码：0x0 - 0xF
+	*			lpszMask		-- 掩码（nullptr 或 4 字节掩码，如果为 nullptr 则没有掩码）
+	*			ullBodyLen		-- 消息体长度
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnWSMessageHeader(T* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen)	= 0;
+
+	/*
+	* 名称：WebSocket 数据包体通知
+	* 描述：当接收到 WebSocket 数据包体时，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	*			pData		-- 消息体数据缓冲区
+	*			iLength		-- 消息体数据长度
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnWSMessageBody(T* pSender, CONNID dwConnID, const BYTE* pData, int iLength)			= 0;
+
+	/*
+	* 名称：WebSocket 数据包完成通知
+	* 描述：当完整接收一个 WebSocket 数据包时，向监听器发送该通知
+	*		
+	* 参数：		pSender		-- 事件源对象
+	*			dwConnID	-- 连接 ID
+	* 返回值：	HR_OK / HR_IGNORE	-- 继续执行
+	*			HR_ERROR			-- 引发 OnClose() 事件并关闭连接
+	*/
+	virtual EnHandleResult OnWSMessageComplete(T* pSender, CONNID dwConnID)										= 0;
+
+public:
+	virtual ~IHttpListenerT() {}
+};
+
+/************************************************************************
+名称：IHttpServer 组件端监听器接口
+描述：定义 IHttpServer 监听器的所有事件
+************************************************************************/
+class IHttpServerListener : public IHttpListenerT<IHttpServer>, public ITcpServerListener
+{
+public:
+
+};
+
+/************************************************************************
+名称：IHttpAgent 组件端监听器接口
+描述：定义 IHttpAgent 监听器的所有事件
+************************************************************************/
+class IHttpAgentListener : public IHttpListenerT<IHttpAgent>, public ITcpAgentListener
+{
+public:
+
+};
+
+/************************************************************************
+名称：IHttpClient 组件端监听器接口
+描述：定义 IHttpClient 监听器的所有事件
+************************************************************************/
+class IHttpClientListener : public IHttpListenerT<IHttpClient>, public ITcpClientListener
+{
+public:
+
+};
+
+/************************************************************************
+名称：IHttpServerListener 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CHttpServerListener : public IHttpServerListener
+{
+public:
+	virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen)										{return HR_IGNORE;}
+	virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient)							{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID)											{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength)									{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)					{return HR_IGNORE;}
+	virtual EnHandleResult OnShutdown(ITcpServer* pSender)																{return HR_IGNORE;}
+
+	virtual EnHttpParseResult OnMessageBegin(IHttpServer* pSender, CONNID dwConnID)										{return HPR_OK;}
+	virtual EnHttpParseResult OnRequestLine(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl)	{return HPR_OK;}
+	virtual EnHttpParseResult OnStatusLine(IHttpServer* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc)	{return HPR_OK;}
+	virtual EnHttpParseResult OnHeader(IHttpServer* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue)		{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkHeader(IHttpServer* pSender, CONNID dwConnID, int iLength)							{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkComplete(IHttpServer* pSender, CONNID dwConnID)									{return HPR_OK;}
+	virtual EnHttpParseResult OnUpgrade(IHttpServer* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType)			{return HPR_OK;}
+
+	virtual EnHandleResult OnWSMessageHeader(IHttpServer* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen)	{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageBody(IHttpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageComplete(IHttpServer* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：IHttpAgentListener 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+class CHttpAgentListener : public IHttpAgentListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(ITcpAgent* pSender, CONNID dwConnID, SOCKET socket)							{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(ITcpAgent* pSender, CONNID dwConnID)												{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpAgent* pSender, CONNID dwConnID)												{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, int iLength)									{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength)					{return HR_IGNORE;}
+	virtual EnHandleResult OnShutdown(ITcpAgent* pSender)																{return HR_IGNORE;}
+
+	virtual EnHttpParseResult OnMessageBegin(IHttpAgent* pSender, CONNID dwConnID)										{return HPR_OK;}
+	virtual EnHttpParseResult OnRequestLine(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl)	{return HPR_OK;}
+	virtual EnHttpParseResult OnStatusLine(IHttpAgent* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc)	{return HPR_OK;}
+	virtual EnHttpParseResult OnHeader(IHttpAgent* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue)			{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkHeader(IHttpAgent* pSender, CONNID dwConnID, int iLength)							{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkComplete(IHttpAgent* pSender, CONNID dwConnID)										{return HPR_OK;}
+	virtual EnHttpParseResult OnUpgrade(IHttpAgent* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType)			{return HPR_OK;}
+
+	virtual EnHandleResult OnWSMessageHeader(IHttpAgent* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen)	{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageBody(IHttpAgent* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageComplete(IHttpAgent* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：IHttpClientListener 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+
+class CHttpClientListener : public IHttpClientListener
+{
+public:
+	virtual EnHandleResult OnPrepareConnect(ITcpClient* pSender, CONNID dwConnID, SOCKET socket)						{return HR_IGNORE;}
+	virtual EnHandleResult OnConnect(ITcpClient* pSender, CONNID dwConnID)												{return HR_IGNORE;}
+	virtual EnHandleResult OnHandShake(ITcpClient* pSender, CONNID dwConnID)											{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, int iLength)									{return HR_IGNORE;}
+	virtual EnHandleResult OnReceive(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				{return HR_IGNORE;}
+	virtual EnHandleResult OnSend(ITcpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)					{return HR_IGNORE;}
+
+	virtual EnHttpParseResult OnMessageBegin(IHttpClient* pSender, CONNID dwConnID)										{return HPR_OK;}
+	virtual EnHttpParseResult OnRequestLine(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl)	{return HPR_OK;}
+	virtual EnHttpParseResult OnStatusLine(IHttpClient* pSender, CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc)	{return HPR_OK;}
+	virtual EnHttpParseResult OnHeader(IHttpClient* pSender, CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue)		{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkHeader(IHttpClient* pSender, CONNID dwConnID, int iLength)							{return HPR_OK;}
+	virtual EnHttpParseResult OnChunkComplete(IHttpClient* pSender, CONNID dwConnID)									{return HPR_OK;}
+	virtual EnHttpParseResult OnUpgrade(IHttpClient* pSender, CONNID dwConnID, EnHttpUpgradeType enUpgradeType)			{return HPR_OK;}
+
+	virtual EnHandleResult OnWSMessageHeader(IHttpClient* pSender, CONNID dwConnID, BOOL bFinal, BYTE iReserved, BYTE iOperationCode, const BYTE lpszMask[4], ULONGLONG ullBodyLen)	{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)		{return HR_IGNORE;}
+	virtual EnHandleResult OnWSMessageComplete(IHttpClient* pSender, CONNID dwConnID)									{return HR_IGNORE;}
+};
+
+/************************************************************************
+名称：IHttpClientListener 监听器抽象基类
+描述：定义某些事件的默认处理方法（忽略事件）
+************************************************************************/
+
+class CHttpSyncClientListener : public CHttpClientListener
+{
+public:
+	virtual EnHandleResult OnClose(ITcpClient* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode)	{return HR_IGNORE;}
+
+	virtual EnHttpParseResult OnHeadersComplete(IHttpClient* pSender, CONNID dwConnID)									{return HPR_OK;}
+	virtual EnHttpParseResult OnBody(IHttpClient* pSender, CONNID dwConnID, const BYTE* pData, int iLength)				{return HPR_OK;}
+	virtual EnHttpParseResult OnMessageComplete(IHttpClient* pSender, CONNID dwConnID)									{return HPR_OK;}
+	virtual EnHttpParseResult OnParseError(IHttpClient* pSender, CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc)	{return HPR_OK;}
+
+};

socket/HP-Socket/Src/TcpClient.cpp

@@ -0,0 +1,734 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "TcpClient.h"
+#include "../../Common/Src/WaitFor.h"
+
+#include <process.h>
+
+BOOL CTcpClient::Start(LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect, LPCTSTR lpszBindAddress)
+{
+	if(!CheckParams() || !CheckStarting())
+		return FALSE;
+
+	PrepareStart();
+	m_ccContext.Reset();
+
+	BOOL isOK		= FALSE;
+	m_bAsyncConnect	= bAsyncConnect;
+
+	if(CreateClientSocket())
+	{
+		if(BindClientSocket(lpszBindAddress))
+		{
+			if(FirePrepareConnect(m_soClient) != HR_ERROR)
+			{
+				if(ConnectToServer(lpszRemoteAddress, usPort))
+				{
+					if(CreateWorkerThread())
+						isOK = TRUE;
+					else
+						SetLastError(SE_WORKER_THREAD_CREATE, __FUNCTION__, ERROR_CREATE_FAILED);
+				}
+				else
+					SetLastError(SE_CONNECT_SERVER, __FUNCTION__, ::WSAGetLastError());
+			}
+			else
+				SetLastError(SE_SOCKET_PREPARE, __FUNCTION__, ERROR_CANCELLED);
+		}
+		else
+			SetLastError(SE_SOCKET_BIND, __FUNCTION__, ::WSAGetLastError());
+	}
+	else
+		SetLastError(SE_SOCKET_CREATE, __FUNCTION__, ::WSAGetLastError());
+
+	if(!isOK)
+	{
+		m_ccContext.Reset(FALSE);
+		Stop();
+	}
+
+	return isOK;
+}
+
+BOOL CTcpClient::CheckParams()
+{
+	if	(((int)m_dwSocketBufferSize > 0)									&&
+		((int)m_dwFreeBufferPoolSize >= 0)									&&
+		((int)m_dwFreeBufferPoolHold >= 0)									&&
+		((int)m_dwKeepAliveTime >= 1000 || m_dwKeepAliveTime == 0)			&&
+		((int)m_dwKeepAliveInterval >= 1000 || m_dwKeepAliveInterval == 0)	)
+		return TRUE;
+
+	SetLastError(SE_INVALID_PARAM, __FUNCTION__, ERROR_INVALID_PARAMETER);
+	return FALSE;
+}
+
+void CTcpClient::PrepareStart()
+{
+	m_itPool.SetItemCapacity((int)m_dwSocketBufferSize);
+	m_itPool.SetPoolSize((int)m_dwFreeBufferPoolSize);
+	m_itPool.SetPoolHold((int)m_dwFreeBufferPoolHold);
+
+	m_itPool.Prepare();
+}
+
+BOOL CTcpClient::CheckStarting()
+{
+	CSpinLock locallock(m_csState);
+
+	if(m_enState == SS_STOPPED)
+		m_enState = SS_STARTING;
+	else
+	{
+		SetLastError(SE_ILLEGAL_STATE, __FUNCTION__, ERROR_INVALID_OPERATION);
+		return FALSE;
+	}
+
+	return TRUE;
+}
+
+BOOL CTcpClient::CheckStoping(DWORD dwCurrentThreadID)
+{
+	if(m_enState == SS_STOPPED)
+		return FALSE;
+
+	CSpinLock locallock(m_csState);
+
+	if(HasStarted())
+	{
+		m_enState = SS_STOPPING;
+		return TRUE;
+	}
+	else if(m_enState == SS_STOPPING)
+	{
+		if(dwCurrentThreadID != m_dwWorkerID)
+		{
+			while(m_enState != SS_STOPPED)
+				::Sleep(30);
+		}
+
+		SetLastError(SE_ILLEGAL_STATE, __FUNCTION__, ERROR_INVALID_OPERATION);
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpClient::CreateClientSocket()
+{
+	m_soClient = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
+
+	if(m_soClient != INVALID_SOCKET)
+	{
+		BOOL bOnOff	= (m_dwKeepAliveTime > 0 && m_dwKeepAliveInterval > 0);
+		VERIFY(::SSO_KeepAliveVals(m_soClient, bOnOff, m_dwKeepAliveTime, m_dwKeepAliveInterval) == NO_ERROR);
+
+		m_evSocket = ::WSACreateEvent();
+		ASSERT(m_evSocket != WSA_INVALID_EVENT);
+
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpClient::BindClientSocket(LPCTSTR lpszBindAddress)
+{
+	if(lpszBindAddress)
+	{
+		SOCKADDR_IN bindAddr;
+		if(!::sockaddr_A_2_IN(AF_INET, lpszBindAddress, 0, bindAddr))
+		{
+			::WSASetLastError(WSAEADDRNOTAVAIL);
+			return FALSE;
+		}
+
+		if(::bind(m_soClient, (struct sockaddr*)&bindAddr, sizeof(SOCKADDR_IN)) == SOCKET_ERROR)
+			return FALSE;
+	}
+
+	m_dwConnID = ::GenerateConnectionID();
+
+	return TRUE;
+}
+
+BOOL CTcpClient::ConnectToServer(LPCTSTR lpszRemoteAddress, USHORT usPort)
+{
+	TCHAR szAddress[40];
+	int iAddressLen = sizeof(szAddress) / sizeof(TCHAR);
+
+	if(!::GetIPAddress(lpszRemoteAddress, szAddress, iAddressLen))
+	{
+		::WSASetLastError(WSAEADDRNOTAVAIL);
+		return FALSE;
+	}
+
+	SOCKADDR_IN addr;
+	if(!::sockaddr_A_2_IN(AF_INET, szAddress, usPort, addr))
+	{
+		::WSASetLastError(WSAEADDRNOTAVAIL);
+		return FALSE;
+	}
+
+	SetRemoteHost(lpszRemoteAddress, usPort);
+
+	BOOL isOK = FALSE;
+
+	if(m_bAsyncConnect)
+	{
+		if(::WSAEventSelect(m_soClient, m_evSocket, FD_CONNECT | FD_CLOSE) != SOCKET_ERROR)
+		{
+			int rc = ::connect(m_soClient, (SOCKADDR*)&addr, sizeof(SOCKADDR_IN));
+			isOK = (rc == NO_ERROR ||(rc == SOCKET_ERROR && ::WSAGetLastError() == WSAEWOULDBLOCK));
+		}
+	}
+	else
+	{
+		if(::connect(m_soClient, (SOCKADDR*)&addr, sizeof(SOCKADDR_IN)) != SOCKET_ERROR)
+		{
+			if(::WSAEventSelect(m_soClient, m_evSocket, FD_READ | FD_WRITE | FD_CLOSE) != SOCKET_ERROR)
+			{
+				if(FireConnect() != HR_ERROR)
+				{
+					m_enState	= SS_STARTED;
+					isOK		= TRUE;
+				}
+			}
+		}
+	}
+
+	return isOK;
+}
+
+BOOL CTcpClient::CreateWorkerThread()
+{
+	m_hWorker = (HANDLE)_beginthreadex(nullptr, 0, WorkerThreadProc, (LPVOID)this, 0, &m_dwWorkerID);
+
+	return m_hWorker != nullptr;
+}
+
+UINT WINAPI CTcpClient::WorkerThreadProc(LPVOID pv)
+{
+	TRACE("---------------> Client Worker Thread 0x%08X started <---------------\n", ::GetCurrentThreadId());
+
+	BOOL bCallStop		= TRUE;
+	CTcpClient* pClient	= (CTcpClient*)pv;
+	HANDLE hEvents[]	= {pClient->m_evSocket, pClient->m_evBuffer, pClient->m_evWorker};
+
+	pClient->m_rcBuffer.Malloc(pClient->m_dwSocketBufferSize);
+
+	while(pClient->HasStarted())
+	{
+		DWORD retval = ::WSAWaitForMultipleEvents(3, hEvents, FALSE, WSA_INFINITE, FALSE);
+
+		if(retval == WSA_WAIT_EVENT_0)
+		{
+			if(!pClient->ProcessNetworkEvent())
+				break;
+		}
+		else if(retval == WSA_WAIT_EVENT_0 + 1)
+		{
+			if(!pClient->SendData())
+				break;
+		}
+		else if(retval == WSA_WAIT_EVENT_0 + 2)
+		{
+			bCallStop = FALSE;
+			break;
+		}
+		else if(retval == WSA_WAIT_FAILED)
+		{
+			pClient->m_ccContext.Reset(TRUE, SO_UNKNOWN, ::WSAGetLastError());
+			break;
+		}
+		else
+			VERIFY(FALSE);
+	}
+
+	pClient->OnWorkerThreadEnd(::GetCurrentThreadId());
+
+	if(bCallStop && pClient->HasStarted())
+		pClient->Stop();
+
+	TRACE("---------------> Client Worker Thread 0x%08X stoped <---------------\n", ::GetCurrentThreadId());
+
+	return 0;
+}
+
+BOOL CTcpClient::ProcessNetworkEvent()
+{
+	BOOL bContinue = TRUE;
+	WSANETWORKEVENTS events;
+	
+	int rc = ::WSAEnumNetworkEvents(m_soClient, m_evSocket, &events);
+
+	if(rc == SOCKET_ERROR)
+		bContinue = HandleError(events);
+
+	if(m_bAsyncConnect && bContinue && events.lNetworkEvents & FD_CONNECT)
+		bContinue = HandleConnect(events);
+
+	if(bContinue && events.lNetworkEvents & FD_READ)
+		bContinue = HandleRead(events);
+
+	if(bContinue && events.lNetworkEvents & FD_WRITE)
+		bContinue = HandleWrite(events);
+
+	if(bContinue && events.lNetworkEvents & FD_CLOSE)
+		bContinue = HandleClose(events);
+
+	return bContinue;
+}
+
+BOOL CTcpClient::HandleError(WSANETWORKEVENTS& events)
+{
+	int iCode						= ::WSAGetLastError();
+	EnSocketOperation enOperation	= SO_UNKNOWN;
+
+	if(events.lNetworkEvents & FD_CONNECT)
+		enOperation = SO_CONNECT;
+	else if(events.lNetworkEvents & FD_CLOSE)
+		enOperation = SO_CLOSE;
+	else if(events.lNetworkEvents & FD_READ)
+		enOperation = SO_RECEIVE;
+	else if(events.lNetworkEvents & FD_WRITE)
+		enOperation = SO_SEND;
+
+	VERIFY(::WSAResetEvent(m_evSocket));
+	m_ccContext.Reset(TRUE, enOperation, iCode);
+
+	return FALSE;
+}
+
+BOOL CTcpClient::HandleRead(WSANETWORKEVENTS& events)
+{
+	BOOL bContinue	= TRUE;
+	int iCode		= events.iErrorCode[FD_READ_BIT];
+
+	if(iCode == 0)
+		bContinue = ReadData();
+	else
+	{
+		m_ccContext.Reset(TRUE, SO_RECEIVE, iCode);
+		bContinue = FALSE;
+	}
+
+	return bContinue;
+}
+
+BOOL CTcpClient::HandleWrite(WSANETWORKEVENTS& events)
+{
+	BOOL bContinue	= TRUE;
+	int iCode		= events.iErrorCode[FD_WRITE_BIT];
+
+	if(iCode == 0)
+		bContinue = SendData();
+	else
+	{
+		m_ccContext.Reset(TRUE, SO_SEND, iCode);
+		bContinue = FALSE;
+	}
+
+	return bContinue;
+}
+
+BOOL CTcpClient::HandleConnect(WSANETWORKEVENTS& events)
+{
+	BOOL bContinue	= TRUE;
+	int iCode		= events.iErrorCode[FD_CONNECT_BIT];
+
+	if(iCode == 0)
+	{
+		if(::WSAEventSelect(m_soClient, m_evSocket, FD_READ | FD_WRITE | FD_CLOSE) != SOCKET_ERROR)
+		{
+			if(FireConnect() != HR_ERROR)
+				m_enState = SS_STARTED;
+			else
+				iCode = ERROR_CANCELLED;
+		}
+		else
+			iCode = ::WSAGetLastError();
+	}
+
+	if(iCode != 0)
+	{
+		if(iCode != ERROR_CANCELLED)
+			m_ccContext.Reset(TRUE, SO_CONNECT, iCode);
+		else
+			m_ccContext.Reset(FALSE);
+
+		bContinue = FALSE;
+	}
+
+	return bContinue;
+}
+
+BOOL CTcpClient::HandleClose(WSANETWORKEVENTS& events)
+{
+	int iCode = events.iErrorCode[FD_CLOSE_BIT];
+
+	if(iCode == 0)
+		m_ccContext.Reset(TRUE, SO_CLOSE, SE_OK);
+	else
+		m_ccContext.Reset(TRUE, SO_CLOSE, iCode);
+
+	return FALSE;
+}
+
+BOOL CTcpClient::ReadData()
+{
+	while(TRUE)
+	{
+		int rc = recv(m_soClient, (char*)(BYTE*)m_rcBuffer, m_dwSocketBufferSize, 0);
+
+		if(rc > 0)
+		{
+			if(FireReceive(m_rcBuffer, rc) == HR_ERROR)
+			{
+				TRACE("<C-CNNID: %Iu> OnReceive() event return 'HR_ERROR', connection will be closed !\n", m_dwConnID);
+
+				m_ccContext.Reset(TRUE, SO_RECEIVE, ERROR_CANCELLED);
+				return FALSE;
+			}
+		}
+		else if(rc == SOCKET_ERROR)
+		{
+			int code = ::WSAGetLastError();
+
+			if(code == WSAEWOULDBLOCK)
+				break;
+			else
+			{
+				m_ccContext.Reset(TRUE, SO_RECEIVE, code);
+				return FALSE;
+			}
+		}
+		else if(rc == 0)
+		{
+			m_ccContext.Reset(TRUE, SO_CLOSE, SE_OK);
+			return FALSE;
+		}
+		else
+			ASSERT(FALSE);
+	}
+
+	return TRUE;
+}
+
+BOOL CTcpClient::SendData()
+{
+	BOOL isOK = TRUE;
+
+	while(TRUE)
+	{
+		TItemPtr itPtr(m_itPool, GetSendBuffer());
+
+		if(itPtr.IsValid())
+		{
+			ASSERT(!itPtr->IsEmpty());
+
+			isOK = DoSendData(itPtr);
+
+			if(isOK)
+			{
+				if(!itPtr->IsEmpty())
+				{
+					CCriSecLock locallock(m_csSend);
+					m_lsSend.PushFront(itPtr.Detach());
+					
+					break;
+				}
+			}
+			else
+				break;
+		}
+		else
+			break;
+	}
+
+	return isOK;
+}
+
+TItem* CTcpClient::GetSendBuffer()
+{
+	TItem* pItem = nullptr;
+
+	if(m_lsSend.Size() > 0)
+	{
+		CCriSecLock locallock(m_csSend);
+
+		if(m_lsSend.Size() > 0)
+			pItem = m_lsSend.PopFront();
+	}
+
+	return pItem;
+}
+
+BOOL CTcpClient::DoSendData(TItem* pItem)
+{
+	while(!pItem->IsEmpty())
+	{
+		int rc = 0;
+
+		{
+			CCriSecLock locallock(m_csSend);
+
+			rc = send(m_soClient, (char*)pItem->Ptr(), min(pItem->Size(), (int)m_dwSocketBufferSize), 0);
+			if(rc > 0) m_iPending -= rc;
+		}
+
+		if(rc > 0)
+		{
+			if(FireSend(pItem->Ptr(), rc) == HR_ERROR)
+			{
+				TRACE("<C-CNNID: %Iu> OnSend() event should not return 'HR_ERROR' !!\n", m_dwConnID);
+				ASSERT(FALSE);
+			}
+
+			pItem->Reduce(rc);
+		}
+		else if(rc == SOCKET_ERROR)
+		{
+			int code = ::WSAGetLastError();
+
+			if(code == WSAEWOULDBLOCK)
+				break;
+			else
+			{
+				m_ccContext.Reset(TRUE, SO_SEND, code);
+				return FALSE;
+			}
+		}
+		else
+			ASSERT(FALSE);
+	}
+
+	return TRUE;
+}
+
+BOOL CTcpClient::Stop()
+{
+	DWORD dwCurrentThreadID = ::GetCurrentThreadId();
+
+	if(!CheckStoping(dwCurrentThreadID))
+		return FALSE;
+
+	WaitForWorkerThreadEnd(dwCurrentThreadID);
+
+	if(m_ccContext.bFireOnClose)
+		FireClose(m_ccContext.enOperation, m_ccContext.iErrorCode);
+
+	if(m_evSocket != nullptr)
+	{
+		::WSACloseEvent(m_evSocket);
+		m_evSocket	= nullptr;
+	}
+
+	if(m_soClient != INVALID_SOCKET)
+	{
+		shutdown(m_soClient, SD_SEND);
+		closesocket(m_soClient);
+		m_soClient	= INVALID_SOCKET;
+	}
+
+	Reset();
+
+	return TRUE;
+}
+
+void CTcpClient::Reset()
+{
+	CCriSecLock locallock(m_csSend);
+
+	m_rcBuffer.Free();
+	m_evBuffer.Reset();
+	m_evWorker.Reset();
+	m_lsSend.Clear();
+	m_itPool.Clear();
+
+	m_strHost.Empty();
+
+	m_usPort	= 0;
+	m_iPending	= 0;
+	m_enState	= SS_STOPPED;
+}
+
+void CTcpClient::WaitForWorkerThreadEnd(DWORD dwCurrentThreadID)
+{
+	if(m_hWorker != nullptr)
+	{
+		if(dwCurrentThreadID != m_dwWorkerID)
+		{
+			m_evWorker.Set();
+			VERIFY(::WaitForSingleObject(m_hWorker, INFINITE) == WAIT_OBJECT_0);
+		}
+
+		::CloseHandle(m_hWorker);
+
+		m_hWorker		= nullptr;
+		m_dwWorkerID	= 0;
+	}
+}
+
+BOOL CTcpClient::Send(const BYTE* pBuffer, int iLength, int iOffset)
+{
+	ASSERT(pBuffer && iLength > 0);
+
+	if(iOffset != 0) pBuffer += iOffset;
+
+	WSABUF buffer;
+	buffer.len = iLength;
+	buffer.buf = (char*)pBuffer;
+
+	return SendPackets(&buffer, 1);
+}
+
+BOOL CTcpClient::DoSendPackets(const WSABUF pBuffers[], int iCount)
+{
+	ASSERT(pBuffers && iCount > 0);
+
+	int result = NO_ERROR;
+
+	if(pBuffers && iCount > 0)
+	{
+		if(HasStarted())
+		{
+			CCriSecLock locallock(m_csSend);
+
+			if(HasStarted())
+				result = SendInternal(pBuffers, iCount);
+			else
+				result = ERROR_INVALID_STATE;
+		}
+		else
+			result = ERROR_INVALID_STATE;
+	}
+	else
+		result = ERROR_INVALID_PARAMETER;
+
+	if(result != NO_ERROR)
+		::SetLastError(result);
+
+	return (result == NO_ERROR);
+}
+
+BOOL CTcpClient::SendInternal(const WSABUF pBuffers[], int iCount)
+{
+	int result = NO_ERROR;
+
+	ASSERT(m_iPending >= 0);
+
+	int iPending	= m_iPending;
+	BOOL isPending	= m_iPending > 0;
+
+	for(int i = 0; i < iCount; i++)
+	{
+		int iBufLen = pBuffers[i].len;
+
+		if(iBufLen > 0)
+		{
+			BYTE* pBuffer = (BYTE*)pBuffers[i].buf;
+			ASSERT(pBuffer);
+
+			m_lsSend.Cat(pBuffer, iBufLen);
+			m_iPending += iBufLen;
+		}
+	}
+
+	if(!isPending && m_iPending > iPending) m_evBuffer.Set();
+
+	return result;
+}
+
+BOOL CTcpClient::SendSmallFile(LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail)
+{
+	CAtlFile file;
+	CAtlFileMapping<> fmap;
+	WSABUF szBuf[3];
+
+	HRESULT hr = ::MakeSmallFilePackage(lpszFileName, file, fmap, szBuf, pHead, pTail);
+
+	if(FAILED(hr))
+	{
+		::SetLastError(HRESULT_CODE(hr));
+		return FALSE;
+	}
+
+	return SendPackets(szBuf, 3);
+}
+
+void CTcpClient::SetLastError(EnSocketError code, LPCSTR func, int ec)
+{
+	TRACE("%s --> Error: %d, EC: %d\n", func, code, ec);
+
+	m_enLastError = code;
+	::SetLastError(ec);
+}
+
+BOOL CTcpClient::GetLocalAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)
+{
+	ASSERT(lpszAddress != nullptr && iAddressLen > 0);
+
+	return ::GetSocketLocalAddress(m_soClient, lpszAddress, iAddressLen, usPort);
+}
+
+void CTcpClient::SetRemoteHost(LPCTSTR lpszHost, USHORT usPort)
+{
+	m_strHost = lpszHost;
+	m_usPort  = usPort;
+}
+
+BOOL CTcpClient::GetRemoteHost(TCHAR lpszHost[], int& iHostLen, USHORT& usPort)
+{
+	BOOL isOK = FALSE;
+
+	if(m_strHost.IsEmpty())
+		return isOK;
+
+	int iLen = m_strHost.GetLength() + 1;
+
+	if(iHostLen >= iLen)
+	{
+		memcpy(lpszHost, CA2CT(m_strHost), iLen * sizeof(TCHAR));
+		usPort = m_usPort;
+
+		isOK = TRUE;
+	}
+
+	iHostLen = iLen;
+
+	return isOK;
+}
+
+
+BOOL CTcpClient::GetRemoteHost(LPCSTR* lpszHost, USHORT* pusPort)
+{
+	*lpszHost = m_strHost;
+
+	if(pusPort != nullptr)
+		*pusPort = m_usPort;
+
+	return !m_strHost.IsEmpty();
+}

socket/HP-Socket/Src/TcpClient.h

@@ -0,0 +1,222 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "SocketHelper.h"
+#include "../../Common/Src/Event.h"
+#include "../../Common/Src/bufferptr.h"
+#include "../../Common/Src/bufferpool.h"
+#include "../../Common/Src/CriticalSection.h"
+
+class CTcpClient : public ITcpClient
+{
+public:
+	virtual BOOL Start	(LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr);
+	virtual BOOL Stop	();
+	virtual BOOL Send	(const BYTE* pBuffer, int iLength, int iOffset = 0);
+	virtual BOOL SendSmallFile	(LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr);
+	virtual BOOL SendPackets	(const WSABUF pBuffers[], int iCount)	{return DoSendPackets(pBuffers, iCount);}
+	virtual BOOL			HasStarted			()	{return m_enState == SS_STARTED || m_enState == SS_STARTING;}
+	virtual EnServiceState	GetState			()	{return m_enState;}
+	virtual CONNID			GetConnectionID		()	{return m_dwConnID;};
+	virtual EnSocketError	GetLastError		()	{return m_enLastError;}
+	virtual LPCTSTR			GetLastErrorDesc	()	{return ::GetSocketErrorDesc(m_enLastError);}
+
+	virtual BOOL GetLocalAddress		(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort);
+	virtual BOOL GetRemoteHost			(TCHAR lpszHost[], int& iHostLen, USHORT& usPort);
+	virtual BOOL GetPendingDataLength	(int& iPending) {iPending = m_iPending; return HasStarted();}
+
+public:
+	virtual BOOL IsSecure				() {return FALSE;}
+
+	virtual void SetSocketBufferSize	(DWORD dwSocketBufferSize)		{m_dwSocketBufferSize	= dwSocketBufferSize;}
+	virtual void SetKeepAliveTime		(DWORD dwKeepAliveTime)			{m_dwKeepAliveTime		= dwKeepAliveTime;}
+	virtual void SetKeepAliveInterval	(DWORD dwKeepAliveInterval)		{m_dwKeepAliveInterval	= dwKeepAliveInterval;}
+	virtual void SetFreeBufferPoolSize	(DWORD dwFreeBufferPoolSize)	{m_dwFreeBufferPoolSize = dwFreeBufferPoolSize;}
+	virtual void SetFreeBufferPoolHold	(DWORD dwFreeBufferPoolHold)	{m_dwFreeBufferPoolHold = dwFreeBufferPoolHold;}
+	virtual void SetExtra				(PVOID pExtra)					{m_pExtra				= pExtra;}						
+
+	virtual DWORD GetSocketBufferSize	()	{return m_dwSocketBufferSize;}
+	virtual DWORD GetKeepAliveTime		()	{return m_dwKeepAliveTime;}
+	virtual DWORD GetKeepAliveInterval	()	{return m_dwKeepAliveInterval;}
+	virtual DWORD GetFreeBufferPoolSize	()	{return m_dwFreeBufferPoolSize;}
+	virtual DWORD GetFreeBufferPoolHold	()	{return m_dwFreeBufferPoolHold;}
+	virtual PVOID GetExtra				()	{return m_pExtra;}
+
+protected:
+	virtual EnHandleResult FirePrepareConnect(SOCKET socket)
+		{return DoFirePrepareConnect(this, socket);}
+	virtual EnHandleResult FireConnect()
+		{
+			EnHandleResult rs		= DoFireConnect(this);
+			if(rs != HR_ERROR) rs	= FireHandShake();
+			return rs;
+		}
+	virtual EnHandleResult FireHandShake()
+		{return DoFireHandShake(this);}
+	virtual EnHandleResult FireSend(const BYTE* pData, int iLength)
+		{return DoFireSend(this, pData, iLength);}
+	virtual EnHandleResult FireReceive(const BYTE* pData, int iLength)
+		{return DoFireReceive(this, pData, iLength);}
+	virtual EnHandleResult FireReceive(int iLength)
+		{return DoFireReceive(this, iLength);}
+	virtual EnHandleResult FireClose(EnSocketOperation enOperation, int iErrorCode)
+		{return DoFireClose(this, enOperation, iErrorCode);}
+
+	virtual EnHandleResult DoFirePrepareConnect(ITcpClient* pSender, SOCKET socket)
+		{return m_pListener->OnPrepareConnect(pSender, pSender->GetConnectionID(), socket);}
+	virtual EnHandleResult DoFireConnect(ITcpClient* pSender)
+		{return m_pListener->OnConnect(pSender, pSender->GetConnectionID());}
+	virtual EnHandleResult DoFireHandShake(ITcpClient* pSender)
+		{return m_pListener->OnHandShake(pSender, pSender->GetConnectionID());}
+	virtual EnHandleResult DoFireSend(ITcpClient* pSender, const BYTE* pData, int iLength)
+		{return m_pListener->OnSend(pSender, pSender->GetConnectionID(), pData, iLength);}
+	virtual EnHandleResult DoFireReceive(ITcpClient* pSender, const BYTE* pData, int iLength)
+		{return m_pListener->OnReceive(pSender, pSender->GetConnectionID(), pData, iLength);}
+	virtual EnHandleResult DoFireReceive(ITcpClient* pSender, int iLength)
+		{return m_pListener->OnReceive(pSender, pSender->GetConnectionID(), iLength);}
+	virtual EnHandleResult DoFireClose(ITcpClient* pSender, EnSocketOperation enOperation, int iErrorCode)
+		{return m_pListener->OnClose(pSender, pSender->GetConnectionID(), enOperation, iErrorCode);}
+
+	void SetLastError(EnSocketError code, LPCSTR func, int ec);
+	virtual BOOL CheckParams();
+	virtual void PrepareStart();
+	virtual void Reset();
+
+	virtual void OnWorkerThreadEnd(DWORD dwThreadID) {}
+
+	BOOL DoSendPackets(const WSABUF pBuffers[], int iCount);
+
+	static BOOL DoSendPackets(CTcpClient* pClient, const WSABUF pBuffers[], int iCount)
+		{return pClient->DoSendPackets(pBuffers, iCount);}
+
+protected:
+	void SetReserved	(PVOID pReserved)	{m_pReserved = pReserved;}						
+	PVOID GetReserved	()					{return m_pReserved;}
+	BOOL GetRemoteHost	(LPCSTR* lpszHost, USHORT* pusPort = nullptr);
+
+private:
+	void SetRemoteHost	(LPCTSTR lpszHost, USHORT usPort);
+
+	BOOL CheckStarting();
+	BOOL CheckStoping(DWORD dwCurrentThreadID);
+	BOOL CreateClientSocket();
+	BOOL BindClientSocket(LPCTSTR lpszBindAddress);
+	BOOL ConnectToServer(LPCTSTR lpszRemoteAddress, USHORT usPort);
+	BOOL CreateWorkerThread();
+	BOOL ProcessNetworkEvent();
+	BOOL ReadData();
+	BOOL SendData();
+	BOOL DoSendData(TItem* pItem);
+	TItem* GetSendBuffer();
+	BOOL SendInternal(const WSABUF pBuffers[], int iCount);
+	void WaitForWorkerThreadEnd(DWORD dwCurrentThreadID);
+
+	BOOL HandleError	(WSANETWORKEVENTS& events);
+	BOOL HandleRead		(WSANETWORKEVENTS& events);
+	BOOL HandleWrite	(WSANETWORKEVENTS& events);
+	BOOL HandleConnect	(WSANETWORKEVENTS& events);
+	BOOL HandleClose	(WSANETWORKEVENTS& events);
+
+	static UINT WINAPI WorkerThreadProc(LPVOID pv);
+
+public:
+	CTcpClient(ITcpClientListener* pListener)
+	: m_pListener			(pListener)
+	, m_lsSend				(m_itPool)
+	, m_soClient			(INVALID_SOCKET)
+	, m_evSocket			(nullptr)
+	, m_dwConnID			(0)
+	, m_usPort				(0)
+	, m_hWorker				(nullptr)
+	, m_dwWorkerID			(0)
+	, m_bAsyncConnect		(FALSE)
+	, m_iPending			(0)
+	, m_enState				(SS_STOPPED)
+	, m_enLastError			(SE_OK)
+	, m_pExtra				(nullptr)
+	, m_pReserved			(nullptr)
+	, m_dwSocketBufferSize	(DEFAULT_TCP_SOCKET_BUFFER_SIZE)
+	, m_dwFreeBufferPoolSize(DEFAULT_CLIENT_FREE_BUFFER_POOL_SIZE)
+	, m_dwFreeBufferPoolHold(DEFAULT_CLIENT_FREE_BUFFER_POOL_HOLD)
+	, m_dwKeepAliveTime		(DEFALUT_TCP_KEEPALIVE_TIME)
+	, m_dwKeepAliveInterval	(DEFALUT_TCP_KEEPALIVE_INTERVAL)
+	{
+		ASSERT(m_wsSocket.IsValid());
+		ASSERT(m_pListener);
+	}
+
+	virtual ~CTcpClient()
+	{
+		Stop();
+	}
+
+private:
+	CInitSocket			m_wsSocket;
+
+private:
+	ITcpClientListener*	m_pListener;
+	TClientCloseContext m_ccContext;
+
+	BOOL				m_bAsyncConnect;
+	SOCKET				m_soClient;
+	HANDLE				m_evSocket;
+	CONNID				m_dwConnID;
+
+
+	DWORD				m_dwSocketBufferSize;
+	DWORD				m_dwFreeBufferPoolSize;
+	DWORD				m_dwFreeBufferPoolHold;
+	DWORD				m_dwKeepAliveTime;
+	DWORD				m_dwKeepAliveInterval;
+
+	HANDLE				m_hWorker;
+	UINT				m_dwWorkerID;
+
+	volatile EnServiceState	m_enState;
+	EnSocketError		m_enLastError;
+
+	PVOID				m_pExtra;
+	PVOID				m_pReserved;
+
+	CBufferPtr			m_rcBuffer;
+
+protected:
+	CStringA			m_strHost;
+	USHORT				m_usPort;
+
+	CItemPool			m_itPool;
+
+private:
+	CSpinGuard			m_csState;
+
+	CCriSec				m_csSend;
+	TItemList			m_lsSend;
+
+	CEvt				m_evBuffer;
+	CEvt				m_evWorker;
+
+	volatile int		m_iPending;
+};

socket/HP-Socket/Src/TcpServer.cpp

@@ -0,0 +1,1340 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "TcpServer.h"
+#include "../../Common/Src/WaitFor.h"
+
+#include <malloc.h>
+#include <process.h>
+
+EnHandleResult CTcpServer::TriggerFireAccept(TSocketObj* pSocketObj)
+{
+	CReentrantSpinLock locallock(pSocketObj->csRecv);
+	return FireAccept(pSocketObj);
+}
+
+EnHandleResult CTcpServer::TriggerFireReceive(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	EnHandleResult rs = (EnHandleResult)HR_CLOSED;
+
+	if(TSocketObj::IsValid(pSocketObj))
+	{
+		CReentrantSpinLock locallock(pSocketObj->csRecv);
+
+		if(TSocketObj::IsValid(pSocketObj))
+		{
+			rs = FireReceive(pSocketObj, (BYTE*)pBufferObj->buff.buf, pBufferObj->buff.len);
+		}
+	}
+
+	return rs;
+}
+
+EnHandleResult CTcpServer::TriggerFireSend(TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	EnHandleResult rs = FireSend(pSocketObj, (BYTE*)pBufferObj->buff.buf, pBufferObj->buff.len);
+
+	if(rs == HR_ERROR)
+	{
+		TRACE("<S-CNNID: %Iu> OnSend() event should not return 'HR_ERROR' !!\n", pSocketObj->connID);
+		ASSERT(FALSE);
+	}
+
+	AddFreeBufferObj(pBufferObj);
+
+	return rs;
+}
+
+EnHandleResult CTcpServer::TriggerFireClose(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode)
+{
+	CReentrantSpinLock locallock(pSocketObj->csRecv);
+	return FireClose(pSocketObj, enOperation, iErrorCode);
+}
+
+void CTcpServer::SetLastError(EnSocketError code, LPCSTR func, int ec)
+{
+	m_enLastError = code;
+
+	TRACE("%s --> Error: %d, EC: %d\n", func, code, ec);
+}
+
+BOOL CTcpServer::Start(LPCTSTR lpszBindAddress, USHORT usPort)
+{
+	if(!CheckParams() || !CheckStarting())
+		return FALSE;
+
+	PrepareStart();
+
+	if(CreateListenSocket(lpszBindAddress, usPort))
+		if(CreateCompletePort())
+			if(CreateWorkerThreads())
+				if(StartAccept())
+				{
+					m_enState = SS_STARTED;
+					return TRUE;
+				}
+
+	Stop();
+
+	return FALSE;
+}
+
+BOOL CTcpServer::CheckParams()
+{
+	if	((m_enSendPolicy >= SP_PACK && m_enSendPolicy <= SP_DIRECT)								&&
+		((int)m_dwMaxConnectionCount > 0)														&&
+		((int)m_dwWorkerThreadCount > 0 && m_dwWorkerThreadCount <= MAX_WORKER_THREAD_COUNT)	&&
+		((int)m_dwAcceptSocketCount > 0)														&&
+		((int)m_dwSocketBufferSize >= MIN_SOCKET_BUFFER_SIZE)									&&
+		((int)m_dwSocketListenQueue > 0)														&&
+		((int)m_dwFreeSocketObjLockTime >= 0)													&&
+		((int)m_dwFreeSocketObjPool >= 0)														&&
+		((int)m_dwFreeBufferObjPool >= 0)														&&
+		((int)m_dwFreeSocketObjHold >= m_dwFreeSocketObjPool)									&&
+		((int)m_dwFreeBufferObjHold >= m_dwFreeBufferObjPool)									&&
+		((int)m_dwKeepAliveTime >= 1000 || m_dwKeepAliveTime == 0)								&&
+		((int)m_dwKeepAliveInterval >= 1000 || m_dwKeepAliveInterval == 0)						)
+		return TRUE;
+
+	SetLastError(SE_INVALID_PARAM, __FUNCTION__, ERROR_INVALID_PARAMETER);
+	return FALSE;
+}
+
+void CTcpServer::PrepareStart()
+{
+	m_bfActiveSockets.Reset(m_dwMaxConnectionCount);
+	m_lsFreeSocket.Reset(m_dwFreeSocketObjHold);
+
+	m_bfObjPool.SetItemCapacity((int)m_dwSocketBufferSize);
+	m_bfObjPool.SetPoolSize((int)m_dwFreeBufferObjPool);
+	m_bfObjPool.SetPoolHold((int)m_dwFreeBufferObjHold);
+
+	m_bfObjPool.Prepare();
+}
+
+BOOL CTcpServer::CheckStarting()
+{
+	CSpinLock locallock(m_csState);
+
+	if(m_enState == SS_STOPPED)
+		m_enState = SS_STARTING;
+	else
+	{
+		SetLastError(SE_ILLEGAL_STATE, __FUNCTION__, ERROR_INVALID_OPERATION);
+		return FALSE;
+	}
+
+	return TRUE;
+}
+
+BOOL CTcpServer::CheckStoping()
+{
+	if(m_enState == SS_STOPPED)
+		return FALSE;
+
+	CSpinLock locallock(m_csState);
+
+	if(HasStarted())
+	{
+		m_enState = SS_STOPPING;
+		return TRUE;
+	}
+	else if(m_enState == SS_STOPPING)
+	{
+		while(m_enState != SS_STOPPED)
+			::Sleep(30);
+
+		SetLastError(SE_ILLEGAL_STATE, __FUNCTION__, ERROR_INVALID_OPERATION);
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::CreateListenSocket(LPCTSTR lpszBindAddress, USHORT usPort)
+{
+	BOOL isOK = FALSE;
+
+	m_soListen	= socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
+	if(m_soListen != INVALID_SOCKET)
+	{
+		SOCKADDR_IN addr;
+		::sockaddr_A_2_IN(AF_INET, lpszBindAddress, usPort, addr);
+
+		BOOL bOnOff	= (m_dwKeepAliveTime > 0 && m_dwKeepAliveInterval > 0);
+		::SSO_KeepAliveVals(m_soListen, bOnOff, m_dwKeepAliveTime, m_dwKeepAliveInterval);
+
+		if(::bind(m_soListen, (SOCKADDR*)&addr, sizeof(SOCKADDR_IN)) != SOCKET_ERROR)
+		{
+			if(FirePrepareListen(m_soListen) != HR_ERROR)
+			{
+				if(::listen(m_soListen, m_dwSocketListenQueue) != SOCKET_ERROR)
+				{
+					m_pfnAcceptEx				= ::Get_AcceptEx_FuncPtr(m_soListen);
+					m_pfnGetAcceptExSockaddrs	= ::Get_GetAcceptExSockaddrs_FuncPtr(m_soListen);
+					m_pfnDisconnectEx			= ::Get_DisconnectEx_FuncPtr(m_soListen);
+
+					ASSERT(m_pfnAcceptEx);
+					ASSERT(m_pfnGetAcceptExSockaddrs);
+					ASSERT(m_pfnDisconnectEx);
+
+					isOK = TRUE;
+				}
+				else
+					SetLastError(SE_SOCKET_LISTEN, __FUNCTION__, ::WSAGetLastError());
+			}
+			else
+				SetLastError(SE_SOCKET_PREPARE, __FUNCTION__, ERROR_CANCELLED);
+		}
+		else
+			SetLastError(SE_SOCKET_BIND, __FUNCTION__, ::WSAGetLastError());
+	}
+	else
+		SetLastError(SE_SOCKET_CREATE, __FUNCTION__, ::WSAGetLastError());
+
+	return isOK;
+}
+
+BOOL CTcpServer::CreateCompletePort()
+{
+	m_hCompletePort	= ::CreateIoCompletionPort(INVALID_HANDLE_VALUE, nullptr, 0, 0);
+	if(m_hCompletePort == nullptr)
+		SetLastError(SE_CP_CREATE, __FUNCTION__, ::GetLastError());
+
+	return (m_hCompletePort != nullptr);
+}
+
+BOOL CTcpServer::CreateWorkerThreads()
+{
+	BOOL isOK = TRUE;
+
+	for(DWORD i = 0; i < m_dwWorkerThreadCount; i++)
+	{
+		HANDLE hThread = (HANDLE)_beginthreadex(nullptr, 0, WorkerThreadProc, (LPVOID)this, 0, nullptr);
+		if(hThread)
+			m_vtWorkerThreads.push_back(hThread);
+		else
+		{
+			SetLastError(SE_WORKER_THREAD_CREATE, __FUNCTION__, ::GetLastError());
+			isOK = FALSE;
+			break;
+		}
+	}
+
+	return isOK;
+}
+
+BOOL CTcpServer::StartAccept()
+{
+	BOOL isOK = TRUE;
+
+	if(::CreateIoCompletionPort((HANDLE)m_soListen, m_hCompletePort, m_soListen, 0))
+	{
+		m_iRemainAcceptSockets = m_dwAcceptSocketCount;
+
+		for(DWORD i = 0; i < m_dwAcceptSocketCount; i++)
+			VERIFY(::PostIocpAccept(m_hCompletePort));
+	}
+	else
+	{
+		SetLastError(SE_SOCKE_ATTACH_TO_CP, __FUNCTION__, ::GetLastError());
+		isOK = FALSE;
+	}
+
+	return isOK;
+}
+
+BOOL CTcpServer::Stop()
+{
+	if(!CheckStoping())
+		return FALSE;
+
+	CloseListenSocket();
+
+	WaitForAcceptSocketClose();
+
+	DisconnectClientSocket();
+	WaitForClientSocketClose();
+	WaitForWorkerThreadEnd();
+	
+	ReleaseClientSocket();
+
+	FireShutdown();
+
+	ReleaseFreeSocket();
+	ReleaseFreeBuffer();
+
+	CloseCompletePort();
+
+	Reset();
+
+	return TRUE;
+}
+
+void CTcpServer::Reset()
+{
+	m_phSocket.Reset();
+
+	m_iRemainAcceptSockets		= 0;
+	m_pfnAcceptEx				= nullptr;
+	m_pfnGetAcceptExSockaddrs	= nullptr;
+	m_pfnDisconnectEx			= nullptr;
+	m_enState					= SS_STOPPED;
+}
+
+void CTcpServer::CloseListenSocket()
+{
+	if(m_soListen != INVALID_SOCKET)
+	{
+		::ManualCloseSocket(m_soListen);
+		m_soListen = INVALID_SOCKET;
+	}
+}
+
+void CTcpServer::DisconnectClientSocket()
+{
+	DWORD size					= 0;
+	unique_ptr<CONNID[]> ids	= m_bfActiveSockets.GetAllElementIndexes(size);
+
+	for(DWORD i = 0; i < size; i++)
+		Disconnect(ids[i]);
+}
+
+void CTcpServer::ReleaseClientSocket()
+{
+	VERIFY(m_bfActiveSockets.IsEmpty());
+	m_bfActiveSockets.Reset();
+}
+
+TSocketObj*	CTcpServer::GetFreeSocketObj(CONNID dwConnID, SOCKET soClient)
+{
+	DWORD dwIndex;
+	TSocketObj* pSocketObj = nullptr;
+
+	if(m_lsFreeSocket.TryLock(&pSocketObj, dwIndex))
+	{
+		if(::GetTimeGap32(pSocketObj->freeTime) >= m_dwFreeSocketObjLockTime)
+			VERIFY(m_lsFreeSocket.ReleaseLock(nullptr, dwIndex));
+		else
+		{
+			VERIFY(m_lsFreeSocket.ReleaseLock(pSocketObj, dwIndex));
+			pSocketObj = nullptr;
+		}
+	}
+
+	if(!pSocketObj) pSocketObj = CreateSocketObj();
+	pSocketObj->Reset(dwConnID, soClient);
+
+	return pSocketObj;
+}
+
+void CTcpServer::AddFreeSocketObj(TSocketObj* pSocketObj, EnSocketCloseFlag enFlag, EnSocketOperation enOperation, int iErrorCode)
+{
+	if(!InvalidSocketObj(pSocketObj))
+		return;
+
+	CloseClientSocketObj(pSocketObj, enFlag, enOperation, iErrorCode);
+
+	m_bfActiveSockets.Remove(pSocketObj->connID);
+	TSocketObj::Release(pSocketObj);
+
+	if(!m_lsFreeSocket.TryPut(pSocketObj))
+	{
+		m_lsGCSocket.PushBack(pSocketObj);
+
+		if(m_lsGCSocket.Size() > m_dwFreeSocketObjPool)
+			ReleaseGCSocketObj();
+	}
+}
+
+void CTcpServer::ReleaseGCSocketObj(BOOL bForce)
+{
+	TSocketObj* pSocketObj	= nullptr;
+	DWORD now				= ::TimeGetTime();
+
+	while(m_lsGCSocket.PopFront(&pSocketObj))
+	{
+		if(bForce || (int)(now - pSocketObj->freeTime) >= (int)m_dwFreeSocketObjLockTime)
+			DeleteSocketObj(pSocketObj);
+		else
+		{
+			m_lsGCSocket.PushBack(pSocketObj);
+			break;
+		}
+	}
+}
+
+BOOL CTcpServer::InvalidSocketObj(TSocketObj* pSocketObj)
+{
+	BOOL bDone = FALSE;
+
+	if(TSocketObj::IsValid(pSocketObj))
+	{
+		CReentrantSpinLock	locallock(pSocketObj->csRecv);
+		CCriSecLock			locallock2(pSocketObj->csSend);
+
+		if(TSocketObj::IsValid(pSocketObj))
+		{
+			TSocketObj::Invalid(pSocketObj);
+			bDone = TRUE;
+		}
+	}
+
+	return bDone;
+}
+
+void CTcpServer::AddClientSocketObj(CONNID dwConnID, TSocketObj* pSocketObj)
+{
+	ASSERT(FindSocketObj(dwConnID) == nullptr);
+
+	pSocketObj->connTime	= ::TimeGetTime();
+	pSocketObj->activeTime	= pSocketObj->connTime;
+
+	VERIFY(m_bfActiveSockets.ReleaseLock(dwConnID, pSocketObj));
+}
+
+void CTcpServer::ReleaseFreeSocket()
+{
+	TSocketObj* pSocketObj = nullptr;
+
+	while(m_lsFreeSocket.TryGet(&pSocketObj))
+		DeleteSocketObj(pSocketObj);
+
+	VERIFY(m_lsFreeSocket.IsEmpty());
+	m_lsFreeSocket.Reset();
+
+	ReleaseGCSocketObj(TRUE);
+	VERIFY(m_lsGCSocket.IsEmpty());
+}
+
+TSocketObj* CTcpServer::CreateSocketObj()
+{
+	TSocketObj* pSocketObj = (TSocketObj*)m_phSocket.Alloc(sizeof(TSocketObj));
+	ASSERT(pSocketObj);
+
+	pSocketObj->TSocketObj::TSocketObj(m_bfObjPool);
+	
+	return pSocketObj;
+}
+
+void CTcpServer::DeleteSocketObj(TSocketObj* pSocketObj)
+{
+	ASSERT(pSocketObj);
+
+	pSocketObj->TSocketObj::~TSocketObj();
+	m_phSocket.Free(pSocketObj);
+}
+
+TBufferObj* CTcpServer::GetFreeBufferObj(int iLen)
+{
+	ASSERT(iLen >= -1 && iLen <= (int)m_dwSocketBufferSize);
+
+	TBufferObj* pBufferObj	= m_bfObjPool.PickFreeItem();
+	if(iLen < 0) iLen		= m_dwSocketBufferSize;
+	pBufferObj->buff.len	= iLen;
+
+	return pBufferObj;
+}
+
+void CTcpServer::AddFreeBufferObj(TBufferObj* pBufferObj)
+{
+	m_bfObjPool.PutFreeItem(pBufferObj);
+}
+
+void CTcpServer::ReleaseFreeBuffer()
+{
+	m_bfObjPool.Clear();
+}
+
+TSocketObj* CTcpServer::FindSocketObj(CONNID dwConnID)
+{
+	TSocketObj* pSocketObj = nullptr;
+
+	if(m_bfActiveSockets.Get(dwConnID, &pSocketObj) != TSocketObjPtrPool::GR_VALID)
+		pSocketObj = nullptr;
+
+	return pSocketObj;
+}
+
+void CTcpServer::CloseClientSocketObj(TSocketObj* pSocketObj, EnSocketCloseFlag enFlag, EnSocketOperation enOperation, int iErrorCode, int iShutdownFlag)
+{
+	ASSERT(TSocketObj::IsExist(pSocketObj));
+
+	if(enFlag == SCF_CLOSE)
+		TriggerFireClose(pSocketObj, SO_CLOSE, SE_OK);
+	else if(enFlag == SCF_ERROR)
+		TriggerFireClose(pSocketObj, enOperation, iErrorCode);
+
+	SOCKET socket = pSocketObj->socket;
+	pSocketObj->socket = INVALID_SOCKET;
+
+	::ManualCloseSocket(socket, iShutdownFlag);
+}
+
+BOOL CTcpServer::GetListenAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)
+{
+	ASSERT(lpszAddress != nullptr && iAddressLen > 0);
+
+	return ::GetSocketLocalAddress(m_soListen, lpszAddress, iAddressLen, usPort);
+}
+
+BOOL CTcpServer::GetLocalAddress(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)
+{
+	ASSERT(lpszAddress != nullptr && iAddressLen > 0);
+
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+		return ::GetSocketLocalAddress(pSocketObj->socket, lpszAddress, iAddressLen, usPort);
+
+	return FALSE;
+}
+
+BOOL CTcpServer::GetRemoteAddress(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort)
+{
+	ASSERT(lpszAddress != nullptr && iAddressLen > 0);
+
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		ADDRESS_FAMILY usFamily;
+		return ::sockaddr_IN_2_A(pSocketObj->remoteAddr, usFamily, lpszAddress, iAddressLen, usPort);
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::SetConnectionExtra(CONNID dwConnID, PVOID pExtra)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return SetConnectionExtra(pSocketObj, pExtra);
+}
+
+BOOL CTcpServer::SetConnectionExtra(TSocketObj* pSocketObj, PVOID pExtra)
+{
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		pSocketObj->extra = pExtra;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::GetConnectionExtra(CONNID dwConnID, PVOID* ppExtra)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return GetConnectionExtra(pSocketObj, ppExtra);
+}
+
+BOOL CTcpServer::GetConnectionExtra(TSocketObj* pSocketObj, PVOID* ppExtra)
+{
+	ASSERT(ppExtra != nullptr);
+
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		*ppExtra = pSocketObj->extra;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::SetConnectionReserved(CONNID dwConnID, PVOID pReserved)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return SetConnectionReserved(pSocketObj, pReserved);
+}
+
+BOOL CTcpServer::SetConnectionReserved(TSocketObj* pSocketObj, PVOID pReserved)
+{
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		pSocketObj->reserved = pReserved;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::GetConnectionReserved(CONNID dwConnID, PVOID* ppReserved)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return GetConnectionReserved(pSocketObj, ppReserved);
+}
+
+BOOL CTcpServer::GetConnectionReserved(TSocketObj* pSocketObj, PVOID* ppReserved)
+{
+	ASSERT(ppReserved != nullptr);
+
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		*ppReserved = pSocketObj->reserved;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::SetConnectionReserved2(CONNID dwConnID, PVOID pReserved2)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return SetConnectionReserved2(pSocketObj, pReserved2);
+}
+
+BOOL CTcpServer::SetConnectionReserved2(TSocketObj* pSocketObj, PVOID pReserved2)
+{
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		pSocketObj->reserved2 = pReserved2;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::GetConnectionReserved2(CONNID dwConnID, PVOID* ppReserved2)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+	return GetConnectionReserved2(pSocketObj, ppReserved2);
+}
+
+BOOL CTcpServer::GetConnectionReserved2(TSocketObj* pSocketObj, PVOID* ppReserved2)
+{
+	ASSERT(ppReserved2 != nullptr);
+
+	if(TSocketObj::IsExist(pSocketObj))
+	{
+		*ppReserved2 = pSocketObj->reserved2;
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+BOOL CTcpServer::GetPendingDataLength(CONNID dwConnID, int& iPending)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+	{
+		iPending = pSocketObj->Pending();
+		return TRUE;
+	}
+
+	return FALSE;
+}
+
+DWORD CTcpServer::GetConnectionCount()
+{
+	return m_bfActiveSockets.Elements();
+}
+
+BOOL CTcpServer::GetAllConnectionIDs(CONNID pIDs[], DWORD& dwCount)
+{
+	return m_bfActiveSockets.GetAllElementIndexes(pIDs, dwCount);
+}
+
+BOOL CTcpServer::GetConnectPeriod(CONNID dwConnID, DWORD& dwPeriod)
+{
+	BOOL isOK				= TRUE;
+	TSocketObj* pSocketObj	= FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+		dwPeriod = ::GetTimeGap32(pSocketObj->connTime);
+	else
+		isOK = FALSE;
+
+	return isOK;
+}
+
+BOOL CTcpServer::GetSilencePeriod(CONNID dwConnID, DWORD& dwPeriod)
+{
+	if(!m_bMarkSilence)
+		return FALSE;
+
+	BOOL isOK				= TRUE;
+	TSocketObj* pSocketObj	= FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+		dwPeriod = ::GetTimeGap32(pSocketObj->activeTime);
+	else
+		isOK = FALSE;
+
+	return isOK;
+}
+
+BOOL CTcpServer::Disconnect(CONNID dwConnID, BOOL bForce)
+{
+	BOOL isOK				= FALSE;
+	TSocketObj* pSocketObj	= FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+	{
+		if(bForce)
+			isOK = ::PostIocpDisconnect(m_hCompletePort, dwConnID);
+		else
+			isOK = m_pfnDisconnectEx(pSocketObj->socket, nullptr, 0, 0);
+	}
+
+	return isOK;
+}
+
+BOOL CTcpServer::DisconnectLongConnections(DWORD dwPeriod, BOOL bForce)
+{
+	if(dwPeriod > MAX_CONNECTION_PERIOD)
+		return FALSE;
+
+	DWORD size					= 0;
+	unique_ptr<CONNID[]> ids	= m_bfActiveSockets.GetAllElementIndexes(size);
+	DWORD now					= ::TimeGetTime();
+
+	for(DWORD i = 0; i < size; i++)
+	{
+		CONNID connID			= ids[i];
+		TSocketObj* pSocketObj	= FindSocketObj(connID);
+
+		if(TSocketObj::IsValid(pSocketObj) && (int)(now - pSocketObj->connTime) >= (int)dwPeriod)
+			Disconnect(connID, bForce);
+	}
+
+	return TRUE;
+}
+
+BOOL CTcpServer::DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce)
+{
+	if(!m_bMarkSilence)
+		return FALSE;
+	if(dwPeriod > MAX_CONNECTION_PERIOD)
+		return FALSE;
+
+	DWORD size					= 0;
+	unique_ptr<CONNID[]> ids	= m_bfActiveSockets.GetAllElementIndexes(size);
+	DWORD now					= ::TimeGetTime();
+
+	for(DWORD i = 0; i < size; i++)
+	{
+		CONNID connID			= ids[i];
+		TSocketObj* pSocketObj	= FindSocketObj(connID);
+
+		if(TSocketObj::IsValid(pSocketObj) && (int)(now - pSocketObj->activeTime) >= (int)dwPeriod)
+			Disconnect(connID, bForce);
+	}
+
+	return TRUE;
+}
+
+void CTcpServer::WaitForAcceptSocketClose()
+{
+	while(m_iRemainAcceptSockets > 0)
+		::WaitWithMessageLoop(100);
+}
+
+void CTcpServer::WaitForClientSocketClose()
+{
+	while(m_bfActiveSockets.Elements() > 0)
+		::WaitWithMessageLoop(100);
+}
+
+void CTcpServer::WaitForWorkerThreadEnd()
+{
+	int count = (int)m_vtWorkerThreads.size();
+
+	for(int i = 0; i < count; i++)
+		::PostIocpExit(m_hCompletePort);
+
+	int remain	= count;
+	int index	= 0;
+
+	while(remain > 0)
+	{
+		int wait = min(remain, MAXIMUM_WAIT_OBJECTS);
+		HANDLE* pHandles = (HANDLE*)_alloca(sizeof(HANDLE) * wait);
+
+		for(int i = 0; i < wait; i++)
+			pHandles[i]	= m_vtWorkerThreads[i + index];
+
+		VERIFY(::WaitForMultipleObjects((DWORD)wait, pHandles, TRUE, INFINITE) == WAIT_OBJECT_0);
+
+		for(int i = 0; i < wait; i++)
+			::CloseHandle(pHandles[i]);
+
+		remain	-= wait;
+		index	+= wait;
+	}
+
+	m_vtWorkerThreads.clear();
+}
+
+void CTcpServer::CloseCompletePort()
+{
+	if(m_hCompletePort != nullptr)
+	{
+		::CloseHandle(m_hCompletePort);
+		m_hCompletePort = nullptr;
+	}
+}
+
+BOOL CTcpServer::DoAccept()
+{
+	BOOL isOK = FALSE;
+
+	if(HasStarted())
+	{
+		SOCKET		soClient	= socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
+		TBufferObj*	pBufferObj	= GetFreeBufferObj();
+
+		ASSERT(soClient != INVALID_SOCKET);
+
+		isOK = (::PostAccept(m_pfnAcceptEx, m_soListen, soClient, pBufferObj) == NO_ERROR);
+
+		if(!isOK)
+		{
+			VERIFY(!HasStarted());
+
+			::ManualCloseSocket(soClient);
+			AddFreeBufferObj(pBufferObj);
+		}
+	}
+
+	if(!isOK)
+	{
+		::InterlockedDecrement(&m_iRemainAcceptSockets);
+		ASSERT(m_iRemainAcceptSockets >= 0);
+	}
+
+	return isOK;
+}
+
+UINT WINAPI CTcpServer::WorkerThreadProc(LPVOID pv)
+{
+	CTcpServer* pServer = (CTcpServer*)pv;
+
+	while(TRUE)
+	{
+		DWORD dwErrorCode = NO_ERROR;
+
+		DWORD dwBytes;
+		OVERLAPPED* pOverlapped;
+		TSocketObj* pSocketObj;
+		
+		BOOL result = ::GetQueuedCompletionStatus
+												(
+													pServer->m_hCompletePort,
+													&dwBytes,
+													(PULONG_PTR)&pSocketObj,
+													&pOverlapped,
+													INFINITE
+												);
+
+		if(pOverlapped == nullptr)
+		{
+			EnIocpAction action = pServer->CheckIocpCommand(pOverlapped, dwBytes, (ULONG_PTR)pSocketObj);
+
+			if(action == IOCP_ACT_CONTINUE)
+				continue;
+			else if(action == IOCP_ACT_BREAK)
+				break;
+		}
+
+		TBufferObj* pBufferObj	= CONTAINING_RECORD(pOverlapped, TBufferObj, ov);
+		CONNID dwConnID			= pBufferObj->operation != SO_ACCEPT ? pSocketObj->connID : 0;
+
+		if (!result)
+		{
+			DWORD dwFlag	= 0;
+			DWORD dwSysCode = ::GetLastError();
+
+			if(pServer->HasStarted())
+			{
+				SOCKET sock	= pBufferObj->operation != SO_ACCEPT ? pBufferObj->client : (SOCKET)pSocketObj;
+				result		= ::WSAGetOverlappedResult(sock, &pBufferObj->ov, &dwBytes, FALSE, &dwFlag);
+
+				if (!result)
+				{
+					dwErrorCode = ::WSAGetLastError();
+					TRACE("GetQueuedCompletionStatus error (<S-CNNID: %Iu> SYS: %d, SOCK: %d, FLAG: %d)\n", dwConnID, dwSysCode, dwErrorCode, dwFlag);
+				}
+			}
+			else
+				dwErrorCode = dwSysCode;
+
+			ASSERT(dwSysCode != 0 && dwErrorCode != 0);
+		}
+
+		pServer->HandleIo(dwConnID, pSocketObj, pBufferObj, dwBytes, dwErrorCode);
+	}
+
+	pServer->OnWorkerThreadEnd(::GetCurrentThreadId());
+
+	return 0;
+}
+
+EnIocpAction CTcpServer::CheckIocpCommand(OVERLAPPED* pOverlapped, DWORD dwBytes, ULONG_PTR ulCompKey)
+{
+	ASSERT(pOverlapped == nullptr);
+
+	EnIocpAction action = IOCP_ACT_CONTINUE;
+	CONNID dwConnID		= (CONNID)ulCompKey;
+
+	switch(dwBytes)
+	{
+	case IOCP_CMD_SEND		: DoSend(dwConnID)			; break;
+	case IOCP_CMD_ACCEPT	: DoAccept()				; break;
+	case IOCP_CMD_DISCONNECT: ForceDisconnect(dwConnID)	; break;
+	case IOCP_CMD_EXIT		: action = IOCP_ACT_BREAK	; break;
+	default					: CheckError(FindSocketObj(dwConnID), SO_CLOSE, (int)dwBytes);
+	}
+
+	return action;
+}
+
+void CTcpServer::ForceDisconnect(CONNID dwConnID)
+{
+	AddFreeSocketObj(FindSocketObj(dwConnID), SCF_CLOSE);
+}
+
+void CTcpServer::HandleIo(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj, DWORD dwBytes, DWORD dwErrorCode)
+{
+	ASSERT(pBufferObj != nullptr);
+	ASSERT(pSocketObj != nullptr);
+
+	if(dwErrorCode != NO_ERROR)
+	{
+		HandleError(dwConnID, pSocketObj, pBufferObj, dwErrorCode);
+		return;
+	}
+
+	if(dwBytes == 0 && pBufferObj->operation != SO_ACCEPT)
+	{
+		AddFreeSocketObj(pSocketObj, SCF_CLOSE);
+		AddFreeBufferObj(pBufferObj);
+		return;
+	}
+
+	pBufferObj->buff.len = dwBytes;
+
+	switch(pBufferObj->operation)
+	{
+	case SO_ACCEPT:
+		HandleAccept((SOCKET)pSocketObj, pBufferObj);
+		break;
+	case SO_SEND:
+		HandleSend(dwConnID, pSocketObj, pBufferObj);
+		break;
+	case SO_RECEIVE:
+		HandleReceive(dwConnID, pSocketObj, pBufferObj);
+		break;
+	default:
+		ASSERT(FALSE);
+	}
+}
+
+void CTcpServer::HandleError(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj, DWORD dwErrorCode)
+{
+	if(pBufferObj->operation != SO_ACCEPT)
+		CheckError(pSocketObj, pBufferObj->operation, dwErrorCode);
+	else
+	{
+		::ManualCloseSocket(pBufferObj->client);
+		VERIFY(::PostIocpAccept(m_hCompletePort));
+	}
+
+	AddFreeBufferObj(pBufferObj);
+}
+
+void CTcpServer::HandleAccept(SOCKET soListen, TBufferObj* pBufferObj)
+{
+	VERIFY(::PostIocpAccept(m_hCompletePort));
+
+	int iLocalSockaddrLen;
+	int iRemoteSockaddrLen;
+	SOCKADDR* pLocalSockAddr;
+	SOCKADDR* pRemoteSockAddr;
+
+	m_pfnGetAcceptExSockaddrs
+							(
+								pBufferObj->buff.buf,
+								0,
+								sizeof(SOCKADDR_IN) + 16,
+								sizeof(SOCKADDR_IN) + 16,
+								(SOCKADDR **)&pLocalSockAddr,
+								&iLocalSockaddrLen,
+								(SOCKADDR **)&pRemoteSockAddr,
+								&iRemoteSockaddrLen
+							);
+
+	CONNID dwConnID = 0;
+	SOCKET socket	= pBufferObj->client;
+
+	if(!HasStarted() || !m_bfActiveSockets.AcquireLock(dwConnID))
+	{
+		::ManualCloseSocket(socket, SD_BOTH);
+		AddFreeBufferObj(pBufferObj);
+
+		return;
+	}
+
+	TSocketObj* pSocketObj = GetFreeSocketObj(dwConnID, socket);
+
+	memcpy(&pSocketObj->remoteAddr, pRemoteSockAddr, sizeof(SOCKADDR_IN));
+	AddClientSocketObj(dwConnID, pSocketObj);
+
+	::SSO_UpdateAcceptContext(socket, soListen);
+	::CreateIoCompletionPort((HANDLE)socket, m_hCompletePort, (ULONG_PTR)pSocketObj, 0);
+
+	if(TriggerFireAccept(pSocketObj) != HR_ERROR)
+		DoReceive(dwConnID, pSocketObj, pBufferObj);
+	else
+	{
+		AddFreeSocketObj(pSocketObj, SCF_NONE);
+		AddFreeBufferObj(pBufferObj);
+	}
+}
+
+void CTcpServer::HandleSend(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	switch(m_enSendPolicy)
+	{
+	case SP_PACK:
+		{
+			long sndCount = ::InterlockedDecrement(&pSocketObj->sndCount);
+
+			TriggerFireSend(pSocketObj, pBufferObj);
+			if(sndCount == 0) DoSendPack(pSocketObj);
+		}
+
+		break;
+	case SP_SAFE:
+		{
+			long sndCount = ::InterlockedDecrement(&pSocketObj->sndCount);
+
+			if(sndCount == 0 && !pSocketObj->smooth)
+			{
+				CCriSecLock locallock(pSocketObj->csSend);
+
+				if((sndCount = pSocketObj->sndCount) == 0)
+					pSocketObj->smooth = TRUE;
+			}
+
+			TriggerFireSend(pSocketObj, pBufferObj);
+			if(sndCount == 0) DoSendSafe(pSocketObj);
+		}
+
+		break;
+	case SP_DIRECT:
+		{
+			TriggerFireSend(pSocketObj, pBufferObj);
+		}
+
+		break;
+	default:
+		ASSERT(FALSE);
+	}
+}
+
+void CTcpServer::HandleReceive(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	if(m_bMarkSilence) pSocketObj->activeTime = ::TimeGetTime();
+	EnHandleResult hr = TriggerFireReceive(pSocketObj, pBufferObj);
+
+	if(hr == HR_OK || hr == HR_IGNORE)
+		DoReceive(dwConnID, pSocketObj, pBufferObj);
+	else if(hr == HR_CLOSED)
+	{
+		AddFreeBufferObj(pBufferObj);
+	}
+	else
+	{
+		AddFreeSocketObj(pSocketObj, SCF_ERROR, SO_RECEIVE, ERROR_CANCELLED);
+		AddFreeBufferObj(pBufferObj);
+	}
+}
+
+int CTcpServer::DoReceive(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj)
+{
+	pBufferObj->buff.len = m_dwSocketBufferSize;
+	int result =::PostReceive(pSocketObj, pBufferObj);
+
+	if(result != NO_ERROR)
+	{
+		CheckError(pSocketObj, SO_RECEIVE, result);
+		AddFreeBufferObj(pBufferObj);
+	}
+
+	return result;
+}
+
+BOOL CTcpServer::Send(CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset)
+{
+	ASSERT(pBuffer && iLength > 0);
+
+	if(iOffset != 0) pBuffer += iOffset;
+
+	WSABUF buffer;
+	buffer.len = iLength;
+	buffer.buf = (char*)pBuffer;
+
+	return SendPackets(dwConnID, &buffer, 1);
+}
+
+BOOL CTcpServer::DoSendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount)
+{
+	ASSERT(pBuffers && iCount > 0);
+
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+
+	if(!TSocketObj::IsValid(pSocketObj))
+	{
+		::SetLastError(ERROR_OBJECT_NOT_FOUND);
+		return FALSE;
+	}
+
+	return DoSendPackets(pSocketObj, pBuffers, iCount);
+}
+
+BOOL CTcpServer::DoSendPackets(TSocketObj* pSocketObj, const WSABUF pBuffers[], int iCount)
+{
+	ASSERT(pSocketObj && pBuffers && iCount > 0);
+
+	int result = NO_ERROR;
+
+	if(pBuffers && iCount > 0)
+	{
+		CCriSecLock locallock(pSocketObj->csSend);
+
+		if(TSocketObj::IsValid(pSocketObj))
+			result = SendInternal(pSocketObj, pBuffers, iCount);
+		else
+			result = ERROR_OBJECT_NOT_FOUND;
+	}
+	else
+		result = ERROR_INVALID_PARAMETER;
+
+	if(result != NO_ERROR)
+	{
+		if(m_enSendPolicy == SP_DIRECT && TSocketObj::IsValid(pSocketObj))
+			::PostIocpClose(m_hCompletePort, pSocketObj->connID, result);
+
+		::SetLastError(result);
+	}
+
+	return (result == NO_ERROR);
+}
+
+int CTcpServer::SendInternal(TSocketObj* pSocketObj, const WSABUF pBuffers[], int iCount)
+{
+	int result = NO_ERROR;
+
+	for(int i = 0; i < iCount; i++)
+	{
+		int iBufLen = pBuffers[i].len;
+
+		if(iBufLen > 0)
+		{
+			BYTE* pBuffer = (BYTE*)pBuffers[i].buf;
+			ASSERT(pBuffer);
+
+			switch(m_enSendPolicy)
+			{
+			case SP_PACK:	result = SendPack(pSocketObj, pBuffer, iBufLen);	break;
+			case SP_SAFE:	result = SendSafe(pSocketObj, pBuffer, iBufLen);	break;
+			case SP_DIRECT:	result = SendDirect(pSocketObj, pBuffer, iBufLen);	break;
+			default: ASSERT(FALSE);	result = ERROR_INVALID_INDEX;				break;
+			}
+
+			if(result != NO_ERROR)
+				break;
+		}
+	}
+
+	return result;
+}
+
+int CTcpServer::SendPack(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength)
+{
+	BOOL isPostSend = !TSocketObj::IsPending(pSocketObj);
+	return CatAndPost(pSocketObj, pBuffer, iLength, isPostSend);
+}
+
+int CTcpServer::SendSafe(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength)
+{
+	BOOL isPostSend = !TSocketObj::IsPending(pSocketObj) && TSocketObj::IsSmooth(pSocketObj);
+	return CatAndPost(pSocketObj, pBuffer, iLength, isPostSend);
+}
+
+int CTcpServer::SendDirect(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength)
+{
+	int result	= NO_ERROR;
+	int iRemain	= iLength;
+
+	while(iRemain > 0)
+	{
+		int iBufferSize = min(iRemain, (int)m_dwSocketBufferSize);
+		TBufferObj* pBufferObj = GetFreeBufferObj(iBufferSize);
+		memcpy(pBufferObj->buff.buf, pBuffer, iBufferSize);
+
+		result = ::PostSend(pSocketObj, pBufferObj);
+
+		if(result != NO_ERROR)
+		{
+			AddFreeBufferObj(pBufferObj);
+			break;
+		}
+
+		iRemain -= iBufferSize;
+		pBuffer += iBufferSize;
+	}
+
+	return result;
+}
+
+int CTcpServer::CatAndPost(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength, BOOL isPostSend)
+{
+	int result = NO_ERROR;
+
+	pSocketObj->sndBuff.Cat(pBuffer, iLength);
+	pSocketObj->pending += iLength;
+
+	if(isPostSend && !::PostIocpSend(m_hCompletePort, pSocketObj->connID))
+		result = ::GetLastError();
+
+	return result;
+}
+
+int CTcpServer::DoSend(CONNID dwConnID)
+{
+	TSocketObj* pSocketObj = FindSocketObj(dwConnID);
+
+	if(TSocketObj::IsValid(pSocketObj))
+		return DoSend(pSocketObj);
+
+	return ERROR_OBJECT_NOT_FOUND;
+}
+
+int CTcpServer::DoSend(TSocketObj* pSocketObj)
+{
+	switch(m_enSendPolicy)
+	{
+	case SP_PACK:			return DoSendPack(pSocketObj);
+	case SP_SAFE:			return DoSendSafe(pSocketObj);
+	default: ASSERT(FALSE);	return ERROR_INVALID_INDEX;
+	}
+}
+
+int CTcpServer::DoSendPack(TSocketObj* pSocketObj)
+{
+	int result = NO_ERROR;
+
+	if(TSocketObj::IsPending(pSocketObj))
+	{
+		CCriSecLock locallock(pSocketObj->csSend);
+
+		if(TSocketObj::IsValid(pSocketObj))
+			result = SendItem(pSocketObj);
+	}
+
+	if(!IOCP_SUCCESS(result))
+		CheckError(pSocketObj, SO_SEND, result);
+
+	return result;
+}
+
+int CTcpServer::DoSendSafe(TSocketObj* pSocketObj)
+{
+	int result = NO_ERROR;
+
+	if(TSocketObj::IsPending(pSocketObj) && TSocketObj::IsSmooth(pSocketObj))
+	{
+		CCriSecLock locallock(pSocketObj->csSend);
+
+		if(TSocketObj::IsPending(pSocketObj) && TSocketObj::IsSmooth(pSocketObj))
+		{
+			pSocketObj->smooth = FALSE;
+
+			result = SendItem(pSocketObj);
+
+			if(result == NO_ERROR)
+				pSocketObj->smooth = TRUE;
+		}
+	}
+
+	if(!IOCP_SUCCESS(result))
+		CheckError(pSocketObj, SO_SEND, result);
+
+	return result;
+}
+
+int CTcpServer::SendItem(TSocketObj* pSocketObj)
+{
+	int result = NO_ERROR;
+
+	while(pSocketObj->sndBuff.Size() > 0)
+	{
+		::InterlockedIncrement(&pSocketObj->sndCount);
+
+		TBufferObj* pBufferObj	= pSocketObj->sndBuff.PopFront();
+		int iBufferSize			= pBufferObj->buff.len;
+
+		ASSERT(iBufferSize > 0 && iBufferSize <= (int)m_dwSocketBufferSize);
+
+		pSocketObj->pending	   -= iBufferSize;
+
+		result = ::PostSendNotCheck(pSocketObj, pBufferObj);
+
+		if(result != NO_ERROR)
+		{
+			if(result != WSA_IO_PENDING)
+				AddFreeBufferObj(pBufferObj);
+
+			break;
+		}
+	}
+
+	return result;
+}
+
+BOOL CTcpServer::SendSmallFile(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead, const LPWSABUF pTail)
+{
+	CAtlFile file;
+	CAtlFileMapping<> fmap;
+	WSABUF szBuf[3];
+
+	HRESULT hr = ::MakeSmallFilePackage(lpszFileName, file, fmap, szBuf, pHead, pTail);
+
+	if(FAILED(hr))
+	{
+		::SetLastError(HRESULT_CODE(hr));
+		return FALSE;
+	}
+
+	return SendPackets(dwConnID, szBuf, 3);
+}
+
+void CTcpServer::CheckError(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode)
+{
+	if(iErrorCode != WSAENOTSOCK && iErrorCode != ERROR_OPERATION_ABORTED)
+		AddFreeSocketObj(pSocketObj, SCF_ERROR, enOperation, iErrorCode);
+}

socket/HP-Socket/Src/TcpServer.h

@@ -0,0 +1,301 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 4.2.1
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "SocketHelper.h"
+#include "../../Common/Src/Event.h"
+#include "../../Common/Src/STLHelper.h"
+#include "../../Common/Src/RingBuffer.h"
+#include "../../Common/Src/PrivateHeap.h"
+
+class CTcpServer : public ITcpServer
+{
+public:
+	virtual BOOL Start	(LPCTSTR lpszBindAddress, USHORT usPort);
+	virtual BOOL Stop	();
+	virtual BOOL Send	(CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset = 0);
+	virtual BOOL SendSmallFile	(CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr);
+	virtual BOOL SendPackets	(CONNID dwConnID, const WSABUF pBuffers[], int iCount)	{return DoSendPackets(dwConnID, pBuffers, iCount);}
+	virtual BOOL			HasStarted					()	{return m_enState == SS_STARTED || m_enState == SS_STARTING;}
+	virtual EnServiceState	GetState					()	{return m_enState;}
+	virtual BOOL			Disconnect					(CONNID dwConnID, BOOL bForce = TRUE);
+	virtual BOOL			DisconnectLongConnections	(DWORD dwPeriod, BOOL bForce = TRUE);
+	virtual BOOL			DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce = TRUE);
+	virtual BOOL			GetListenAddress			(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort);
+	virtual BOOL			GetLocalAddress				(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort);
+	virtual BOOL			GetRemoteAddress			(CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort);
+	
+	virtual BOOL GetPendingDataLength	(CONNID dwConnID, int& iPending);
+	virtual DWORD GetConnectionCount	();
+	virtual BOOL GetAllConnectionIDs	(CONNID pIDs[], DWORD& dwCount);
+	virtual BOOL GetConnectPeriod		(CONNID dwConnID, DWORD& dwPeriod);
+	virtual BOOL GetSilencePeriod		(CONNID dwConnID, DWORD& dwPeriod);
+	virtual EnSocketError GetLastError	()	{return m_enLastError;}
+	virtual LPCTSTR	GetLastErrorDesc	()	{return ::GetSocketErrorDesc(m_enLastError);}
+
+public:
+	virtual BOOL IsSecure				() {return FALSE;}
+
+	virtual BOOL SetConnectionExtra(CONNID dwConnID, PVOID pExtra);
+	virtual BOOL GetConnectionExtra(CONNID dwConnID, PVOID* ppExtra);
+
+	virtual void SetSendPolicy				(EnSendPolicy enSendPolicy)		{m_enSendPolicy				= enSendPolicy;}
+	virtual void SetMaxConnectionCount		(DWORD dwMaxConnectionCount)	{m_dwMaxConnectionCount		= dwMaxConnectionCount;}
+	virtual void SetWorkerThreadCount		(DWORD dwWorkerThreadCount)		{m_dwWorkerThreadCount		= dwWorkerThreadCount;}
+	virtual void SetSocketListenQueue		(DWORD dwSocketListenQueue)		{m_dwSocketListenQueue		= dwSocketListenQueue;}
+	virtual void SetAcceptSocketCount		(DWORD dwAcceptSocketCount)		{m_dwAcceptSocketCount		= dwAcceptSocketCount;}
+	virtual void SetSocketBufferSize		(DWORD dwSocketBufferSize)		{m_dwSocketBufferSize		= dwSocketBufferSize;}
+	virtual void SetFreeSocketObjLockTime	(DWORD dwFreeSocketObjLockTime)	{m_dwFreeSocketObjLockTime	= dwFreeSocketObjLockTime;}
+	virtual void SetFreeSocketObjPool		(DWORD dwFreeSocketObjPool)		{m_dwFreeSocketObjPool		= dwFreeSocketObjPool;}
+	virtual void SetFreeBufferObjPool		(DWORD dwFreeBufferObjPool)		{m_dwFreeBufferObjPool		= dwFreeBufferObjPool;}
+	virtual void SetFreeSocketObjHold		(DWORD dwFreeSocketObjHold)		{m_dwFreeSocketObjHold		= dwFreeSocketObjHold;}
+	virtual void SetFreeBufferObjHold		(DWORD dwFreeBufferObjHold)		{m_dwFreeBufferObjHold		= dwFreeBufferObjHold;}
+	virtual void SetKeepAliveTime			(DWORD dwKeepAliveTime)			{m_dwKeepAliveTime			= dwKeepAliveTime;}
+	virtual void SetKeepAliveInterval		(DWORD dwKeepAliveInterval)		{m_dwKeepAliveInterval		= dwKeepAliveInterval;}
+	virtual void SetMarkSilence				(BOOL bMarkSilence)				{m_bMarkSilence				= bMarkSilence;}
+
+	virtual EnSendPolicy GetSendPolicy		()	{return m_enSendPolicy;}
+	virtual DWORD GetMaxConnectionCount		()	{return m_dwMaxConnectionCount;}
+	virtual DWORD GetWorkerThreadCount		()	{return m_dwWorkerThreadCount;}
+	virtual DWORD GetSocketListenQueue		()	{return m_dwSocketListenQueue;}
+	virtual DWORD GetAcceptSocketCount		()	{return m_dwAcceptSocketCount;}
+	virtual DWORD GetSocketBufferSize		()	{return m_dwSocketBufferSize;}
+	virtual DWORD GetFreeSocketObjLockTime	()	{return m_dwFreeSocketObjLockTime;}
+	virtual DWORD GetFreeSocketObjPool		()	{return m_dwFreeSocketObjPool;}
+	virtual DWORD GetFreeBufferObjPool		()	{return m_dwFreeBufferObjPool;}
+	virtual DWORD GetFreeSocketObjHold		()	{return m_dwFreeSocketObjHold;}
+	virtual DWORD GetFreeBufferObjHold		()	{return m_dwFreeBufferObjHold;}
+	virtual DWORD GetKeepAliveTime			()	{return m_dwKeepAliveTime;}
+	virtual DWORD GetKeepAliveInterval		()	{return m_dwKeepAliveInterval;}
+	virtual BOOL  IsMarkSilence				()	{return m_bMarkSilence;}
+	virtual void  CloseClient(CONNID dwConnID) {
+		int result = ETIMEDOUT;
+		::PostIocpClose(m_hCompletePort, dwConnID, result);
+	}
+protected:
+	virtual EnHandleResult FirePrepareListen(SOCKET soListen)
+		{return DoFirePrepareListen(soListen);}
+	virtual EnHandleResult FireAccept(TSocketObj* pSocketObj)
+		{
+			EnHandleResult rs		= DoFireAccept(pSocketObj);
+			if(rs != HR_ERROR) rs	= FireHandShake(pSocketObj);
+			return rs;
+		}
+	virtual EnHandleResult FireHandShake(TSocketObj* pSocketObj)
+		{return DoFireHandShake(pSocketObj);}
+	virtual EnHandleResult FireReceive(TSocketObj* pSocketObj, const BYTE* pData, int iLength)
+		{return DoFireReceive(pSocketObj, pData, iLength);}
+	virtual EnHandleResult FireReceive(TSocketObj* pSocketObj, int iLength)
+		{return DoFireReceive(pSocketObj, iLength);}
+	virtual EnHandleResult FireSend(TSocketObj* pSocketObj, const BYTE* pData, int iLength)
+		{return DoFireSend(pSocketObj, pData, iLength);}
+	virtual EnHandleResult FireClose(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode)
+		{return DoFireClose(pSocketObj, enOperation, iErrorCode);}
+	virtual EnHandleResult FireShutdown()
+		{return DoFireShutdown();}
+
+	virtual EnHandleResult DoFirePrepareListen(SOCKET soListen)
+		{return m_pListener->OnPrepareListen(this, soListen);}
+	virtual EnHandleResult DoFireAccept(TSocketObj* pSocketObj)
+		{return m_pListener->OnAccept(this, pSocketObj->connID, pSocketObj->socket);}
+	virtual EnHandleResult DoFireHandShake(TSocketObj* pSocketObj)
+		{return m_pListener->OnHandShake(this, pSocketObj->connID);}
+	virtual EnHandleResult DoFireReceive(TSocketObj* pSocketObj, const BYTE* pData, int iLength)
+		{return m_pListener->OnReceive(this, pSocketObj->connID, pData, iLength);}
+	virtual EnHandleResult DoFireReceive(TSocketObj* pSocketObj, int iLength)
+		{return m_pListener->OnReceive(this, pSocketObj->connID, iLength);}
+	virtual EnHandleResult DoFireSend(TSocketObj* pSocketObj, const BYTE* pData, int iLength)
+		{return m_pListener->OnSend(this, pSocketObj->connID, pData, iLength);}
+	virtual EnHandleResult DoFireClose(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode)
+		{return m_pListener->OnClose(this, pSocketObj->connID, enOperation, iErrorCode);}
+	virtual EnHandleResult DoFireShutdown()
+		{return m_pListener->OnShutdown(this);}
+
+	void SetLastError(EnSocketError code, LPCSTR func, int ec);
+	virtual BOOL CheckParams();
+	virtual void PrepareStart();
+	virtual void Reset();
+
+	virtual void OnWorkerThreadEnd(DWORD dwThreadID) {}
+
+	BOOL DoSendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount);
+	BOOL DoSendPackets(TSocketObj* pSocketObj, const WSABUF pBuffers[], int iCount);
+	TSocketObj* FindSocketObj(CONNID dwConnID);
+
+private:
+	EnHandleResult TriggerFireAccept(TSocketObj* pSocketObj);
+	EnHandleResult TriggerFireReceive(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+	EnHandleResult TriggerFireSend(TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+	EnHandleResult TriggerFireClose(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode);
+
+protected:
+	BOOL SetConnectionExtra(TSocketObj* pSocketObj, PVOID pExtra);
+	BOOL GetConnectionExtra(TSocketObj* pSocketObj, PVOID* ppExtra);
+	BOOL SetConnectionReserved(CONNID dwConnID, PVOID pReserved);
+	BOOL GetConnectionReserved(CONNID dwConnID, PVOID* ppReserved);
+	BOOL SetConnectionReserved(TSocketObj* pSocketObj, PVOID pReserved);
+	BOOL GetConnectionReserved(TSocketObj* pSocketObj, PVOID* ppReserved);
+	BOOL SetConnectionReserved2(CONNID dwConnID, PVOID pReserved2);
+	BOOL GetConnectionReserved2(CONNID dwConnID, PVOID* ppReserved2);
+	BOOL SetConnectionReserved2(TSocketObj* pSocketObj, PVOID pReserved2);
+	BOOL GetConnectionReserved2(TSocketObj* pSocketObj, PVOID* ppReserved2);
+
+private:
+	BOOL CheckStarting();
+	BOOL CheckStoping();
+	BOOL CreateListenSocket(LPCTSTR lpszBindAddress, USHORT usPort);
+	BOOL CreateCompletePort();
+	BOOL CreateWorkerThreads();
+	BOOL StartAccept();
+
+	void CloseListenSocket();
+	void WaitForAcceptSocketClose();
+	void DisconnectClientSocket();
+	void WaitForClientSocketClose();
+	void ReleaseClientSocket();
+	void ReleaseFreeSocket();
+	void ReleaseFreeBuffer();
+	void WaitForWorkerThreadEnd();
+	void CloseCompletePort();
+
+	TBufferObj*	GetFreeBufferObj(int iLen = -1);
+	TSocketObj*	GetFreeSocketObj(CONNID dwConnID, SOCKET soClient);
+	void		AddFreeBufferObj(TBufferObj* pBufferObj);
+	void		AddFreeSocketObj(TSocketObj* pSocketObj, EnSocketCloseFlag enFlag = SCF_NONE, EnSocketOperation enOperation = SO_UNKNOWN, int iErrorCode = 0);
+	TSocketObj*	CreateSocketObj();
+	void		DeleteSocketObj(TSocketObj* pSocketObj);
+	BOOL		InvalidSocketObj(TSocketObj* pSocketObj);
+	void		ReleaseGCSocketObj(BOOL bForce = FALSE);
+
+	void		AddClientSocketObj(CONNID dwConnID, TSocketObj* pSocketObj);
+	void		CloseClientSocketObj(TSocketObj* pSocketObj, EnSocketCloseFlag enFlag = SCF_NONE, EnSocketOperation enOperation = SO_UNKNOWN, int iErrorCode = 0, int iShutdownFlag = SD_SEND);
+
+private:
+	static UINT WINAPI WorkerThreadProc(LPVOID pv);
+
+	EnIocpAction CheckIocpCommand(OVERLAPPED* pOverlapped, DWORD dwBytes, ULONG_PTR ulCompKey);
+
+	void ForceDisconnect(CONNID dwConnID);
+	void HandleIo		(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj, DWORD dwBytes, DWORD dwErrorCode);
+	void HandleError	(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj, DWORD dwErrorCode);
+	void HandleAccept	(SOCKET soListen, TBufferObj* pBufferObj);
+	void HandleSend		(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+	void HandleReceive	(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+
+	int SendInternal(TSocketObj* pSocketObj, const WSABUF pBuffers[], int iCount);
+	int SendPack	(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength);
+	int SendSafe	(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength);
+	int SendDirect	(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength);
+	int CatAndPost	(TSocketObj* pSocketObj, const BYTE* pBuffer, int iLength, BOOL isPostSend);
+
+	BOOL DoAccept	();
+	int DoReceive	(CONNID dwConnID, TSocketObj* pSocketObj, TBufferObj* pBufferObj);
+
+	int DoSend		(CONNID dwConnID);
+	int DoSend		(TSocketObj* pSocketObj);
+	int DoSendPack	(TSocketObj* pSocketObj);
+	int DoSendSafe	(TSocketObj* pSocketObj);
+	int SendItem	(TSocketObj* pSocketObj);
+
+	void CheckError	(TSocketObj* pSocketObj, EnSocketOperation enOperation, int iErrorCode);
+
+public:
+	CTcpServer(ITcpServerListener* pListener)
+	: m_pListener				(pListener)
+	, m_hCompletePort			(nullptr)
+	, m_soListen				(INVALID_SOCKET)
+	, m_iRemainAcceptSockets	(0)
+	, m_pfnAcceptEx				(nullptr)
+	, m_pfnGetAcceptExSockaddrs	(nullptr)
+	, m_pfnDisconnectEx			(nullptr)
+	, m_enLastError				(SE_OK)
+	, m_enState					(SS_STOPPED)
+	, m_enSendPolicy			(SP_PACK)
+	, m_dwMaxConnectionCount	(DEFAULT_MAX_CONNECTION_COUNT)
+	, m_dwWorkerThreadCount		(DEFAULT_WORKER_THREAD_COUNT)
+	, m_dwSocketListenQueue		(DEFAULT_TCP_SERVER_SOCKET_LISTEN_QUEUE)
+	, m_dwAcceptSocketCount		(DEFAULT_TCP_SERVER_ACCEPT_SOCKET_COUNT)
+	, m_dwSocketBufferSize		(DEFAULT_TCP_SOCKET_BUFFER_SIZE)
+	, m_dwFreeSocketObjLockTime	(DEFAULT_FREE_SOCKETOBJ_LOCK_TIME)
+	, m_dwFreeSocketObjPool		(DEFAULT_FREE_SOCKETOBJ_POOL)
+	, m_dwFreeBufferObjPool		(DEFAULT_FREE_BUFFEROBJ_POOL)
+	, m_dwFreeSocketObjHold		(DEFAULT_FREE_SOCKETOBJ_HOLD)
+	, m_dwFreeBufferObjHold		(DEFAULT_FREE_BUFFEROBJ_HOLD)
+	, m_dwKeepAliveTime			(DEFALUT_TCP_KEEPALIVE_TIME)
+	, m_dwKeepAliveInterval		(DEFALUT_TCP_KEEPALIVE_INTERVAL)
+	, m_bMarkSilence			(TRUE)
+	{
+		ASSERT(m_wsSocket.IsValid());
+		ASSERT(m_pListener);
+	}
+
+	virtual ~CTcpServer()
+	{
+		Stop();
+	}
+
+private:
+	EnSendPolicy m_enSendPolicy;
+	DWORD m_dwMaxConnectionCount;
+	DWORD m_dwWorkerThreadCount;
+	DWORD m_dwSocketListenQueue;
+	DWORD m_dwAcceptSocketCount;
+	DWORD m_dwSocketBufferSize;
+	DWORD m_dwFreeSocketObjLockTime;
+	DWORD m_dwFreeSocketObjPool;
+	DWORD m_dwFreeBufferObjPool;
+	DWORD m_dwFreeSocketObjHold;
+	DWORD m_dwFreeBufferObjHold;
+	DWORD m_dwKeepAliveTime;
+	DWORD m_dwKeepAliveInterval;
+	BOOL  m_bMarkSilence;
+
+private:
+	CInitSocket					m_wsSocket;
+	LPFN_ACCEPTEX				m_pfnAcceptEx;
+	LPFN_GETACCEPTEXSOCKADDRS	m_pfnGetAcceptExSockaddrs;
+	LPFN_DISCONNECTEX			m_pfnDisconnectEx;
+
+private:
+	ITcpServerListener*	m_pListener;
+	SOCKET				m_soListen;
+	HANDLE				m_hCompletePort;
+	EnServiceState		m_enState;
+	EnSocketError		m_enLastError;
+
+	vector<HANDLE>		m_vtWorkerThreads;
+
+	CPrivateHeap		m_phSocket;
+	CBufferObjPool		m_bfObjPool;
+
+	CSpinGuard			m_csState;
+
+	TSocketObjPtrPool	m_bfActiveSockets;
+
+	TSocketObjPtrList	m_lsFreeSocket;
+	TSocketObjPtrQueue	m_lsGCSocket;
+
+	volatile long		m_iRemainAcceptSockets;
+};

socket/common/Src/CriticalSection.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "stdafx.h"
+#include "CriticalSection.h"

socket/common/Src/CriticalSection.h

@@ -0,0 +1,311 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <intrin.h>
+
+#pragma intrinsic(_ReadBarrier)
+#pragma intrinsic(_WriteBarrier)
+#pragma intrinsic(_ReadWriteBarrier)
+
+#define DEFAULT_CRISEC_SPIN_COUNT	4096
+
+#if defined (_WIN64)
+	#define DEFAULT_PAUSE_RETRY		16
+	#define DEFAULT_PAUSE_YIELD		128
+	#define DEFAULT_PAUSE_CYCLE		8192
+#else
+	#define DEFAULT_PAUSE_RETRY		4
+	#define DEFAULT_PAUSE_YIELD		32
+	#define DEFAULT_PAUSE_CYCLE		4096
+#endif
+
+#ifndef YieldProcessor
+	#pragma intrinsic(_mm_pause)
+	#define YieldProcessor _mm_pause
+#endif
+
+static inline void YieldThread(UINT i = DEFAULT_PAUSE_RETRY)
+{
+	if		(i < DEFAULT_PAUSE_RETRY)		;
+	else if	(i < DEFAULT_PAUSE_YIELD)		YieldProcessor();
+	else if	(i < DEFAULT_PAUSE_CYCLE - 1)	SwitchToThread();
+	else if	(i < DEFAULT_PAUSE_CYCLE)		Sleep(1);
+	else									YieldThread(i & (DEFAULT_PAUSE_CYCLE - 1));
+}
+
+class CInterCriSec
+{
+public:
+	CInterCriSec(DWORD dwSpinCount = DEFAULT_CRISEC_SPIN_COUNT)
+		{VERIFY(::InitializeCriticalSectionAndSpinCount(&m_crisec, dwSpinCount));}
+	~CInterCriSec()
+		{::DeleteCriticalSection(&m_crisec);}
+
+	void Lock()								{::EnterCriticalSection(&m_crisec);}
+	void Unlock()							{::LeaveCriticalSection(&m_crisec);}
+	BOOL TryLock()							{return ::TryEnterCriticalSection(&m_crisec);}
+	DWORD SetSpinCount(DWORD dwSpinCount)	{return ::SetCriticalSectionSpinCount(&m_crisec, dwSpinCount);}
+
+	CRITICAL_SECTION* GetObject()			{return &m_crisec;}
+
+private:
+	CInterCriSec(const CInterCriSec& cs);
+	CInterCriSec operator = (const CInterCriSec& cs);
+
+private:
+	CRITICAL_SECTION m_crisec;
+};
+
+class CInterCriSec2
+{
+public:
+	CInterCriSec2(DWORD dwSpinCount = DEFAULT_CRISEC_SPIN_COUNT, BOOL bInitialize = TRUE)
+	{
+		if(bInitialize)
+		{
+			m_pcrisec = new CRITICAL_SECTION;
+			VERIFY(::InitializeCriticalSectionAndSpinCount(m_pcrisec, dwSpinCount));
+		}
+		else
+			m_pcrisec = nullptr;
+	}
+
+	~CInterCriSec2() {Reset();}
+
+	void Attach(CRITICAL_SECTION* pcrisec)
+	{
+		Reset();
+		m_pcrisec = pcrisec;
+	}
+
+	CRITICAL_SECTION* Detach()
+	{
+		CRITICAL_SECTION* pcrisec = m_pcrisec;
+		m_pcrisec = nullptr;
+		return pcrisec;
+	}
+
+	void Lock()								{::EnterCriticalSection(m_pcrisec);}
+	void Unlock()							{::LeaveCriticalSection(m_pcrisec);}
+	BOOL TryLock()							{return ::TryEnterCriticalSection(m_pcrisec);}
+	DWORD SetSpinCount(DWORD dwSpinCount)	{return ::SetCriticalSectionSpinCount(m_pcrisec, dwSpinCount);}
+
+	CRITICAL_SECTION* GetObject()			{return m_pcrisec;}
+
+private:
+	CInterCriSec2(const CInterCriSec2& cs);
+	CInterCriSec2 operator = (const CInterCriSec2& cs);
+
+	void Reset()
+	{
+		if(m_pcrisec)
+		{
+			::DeleteCriticalSection(m_pcrisec);
+			delete m_pcrisec;
+			m_pcrisec = nullptr;
+		}
+	}
+
+private:
+	CRITICAL_SECTION* m_pcrisec;
+};
+
+class CMTX
+{
+public:
+	CMTX(BOOL bInitialOwner = FALSE, LPCTSTR pszName = nullptr, LPSECURITY_ATTRIBUTES pSecurity = nullptr)	
+	{
+		m_hMutex = ::CreateMutex(pSecurity, bInitialOwner, pszName);
+		ASSERT(IsValid());
+	}
+
+	~CMTX()
+	{
+		if(IsValid())
+			::CloseHandle(m_hMutex);
+	}
+
+	BOOL Open(DWORD dwAccess, BOOL bInheritHandle, LPCTSTR pszName)
+	{
+		if(IsValid())
+			VERIFY(::CloseHandle(m_hMutex));
+
+		m_hMutex = ::OpenMutex(dwAccess, bInheritHandle, pszName);
+		return(IsValid());
+	}
+
+	void Lock(DWORD dwMilliseconds = INFINITE)	{::WaitForSingleObject(m_hMutex, dwMilliseconds);}
+	void Unlock()								{::ReleaseMutex(m_hMutex);}
+
+	HANDLE& GetHandle	() 	{return m_hMutex;}
+	operator HANDLE		()	{return m_hMutex;}
+	BOOL IsValid		()	{return m_hMutex != nullptr;}
+
+private:
+	CMTX(const CMTX& mtx);
+	CMTX operator = (const CMTX& mtx);
+
+private:
+	HANDLE m_hMutex;
+};
+
+class CSpinGuard
+{
+public:
+	CSpinGuard() : m_lFlag(0)
+	{
+
+	}
+
+	~CSpinGuard()
+	{
+		ASSERT(m_lFlag == 0);
+	}
+
+	void Lock()
+	{
+		for(UINT i = 0; !TryLock(); ++i)
+			YieldThread(i);
+	}
+
+	BOOL TryLock()
+	{
+		if(::InterlockedCompareExchange(&m_lFlag, 1, 0) == 0)
+		{
+			::_ReadWriteBarrier();
+			return TRUE;
+		}
+
+		return FALSE;
+	}
+
+	void Unlock()
+	{
+		ASSERT(m_lFlag == 1);
+		m_lFlag = 0;
+	}
+
+private:
+	CSpinGuard(const CSpinGuard& cs);
+	CSpinGuard operator = (const CSpinGuard& cs);
+
+private:
+	volatile LONG m_lFlag;
+};
+
+class CReentrantSpinGuard
+{
+public:
+	CReentrantSpinGuard()
+	: m_dwThreadID	(0)
+	, m_iCount		(0)
+	{
+
+	}
+
+	~CReentrantSpinGuard()
+	{
+		ASSERT(m_dwThreadID	== 0);
+		ASSERT(m_iCount		== 0);
+	}
+
+	void Lock()
+	{
+		for(UINT i = 0; !_TryLock(i == 0); ++i)
+			YieldThread(i);
+	}
+
+	BOOL TryLock()
+	{
+		return _TryLock(TRUE);
+	}
+
+	void Unlock()
+	{
+		ASSERT(m_dwThreadID == ::GetCurrentThreadId());
+
+		if((--m_iCount) == 0)
+			m_dwThreadID = 0;
+	}
+
+private:
+	CReentrantSpinGuard(const CReentrantSpinGuard& cs);
+	CReentrantSpinGuard operator = (const CReentrantSpinGuard& cs);
+
+	BOOL _TryLock(BOOL bFirst)
+	{
+		DWORD dwCurrentThreadID = ::GetCurrentThreadId();
+
+		if(bFirst && m_dwThreadID == dwCurrentThreadID)
+		{
+			++m_iCount;
+			return TRUE;
+		}
+
+		if(::InterlockedCompareExchange(&m_dwThreadID, dwCurrentThreadID, 0) == 0)
+		{
+			::_ReadWriteBarrier();
+			ASSERT(m_iCount == 0);
+
+			m_iCount = 1;
+
+			return TRUE;
+		}
+
+		return FALSE;
+	}
+
+private:
+	volatile DWORD	m_dwThreadID;
+	int				m_iCount;
+};
+
+class CFakeGuard
+{
+public:
+	void Lock()		{}
+	void Unlock()	{}
+	BOOL TryLock()	{return TRUE;}
+};
+
+template<class CLockObj> class CLocalLock
+{
+public:
+	CLocalLock(CLockObj& obj) : m_lock(obj) {m_lock.Lock();}
+	~CLocalLock() {m_lock.Unlock();}
+private:
+	CLockObj& m_lock;
+};
+
+typedef CInterCriSec					CCriSec;
+
+typedef CLocalLock<CCriSec>				CCriSecLock;
+typedef CLocalLock<CInterCriSec>		CInterCriSecLock;
+typedef CLocalLock<CInterCriSec2>		CInterCriSecLock2;
+typedef CLocalLock<CMTX>				CMutexLock;
+typedef CLocalLock<CSpinGuard>			CSpinLock;
+typedef CLocalLock<CReentrantSpinGuard>	CReentrantSpinLock;
+typedef	CLocalLock<CFakeGuard>			CFakeLock;

socket/common/Src/Event.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "stdafx.h"
+#include "Event.h"

socket/common/Src/Event.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+class CEvt
+{
+public:
+	CEvt(BOOL bManualReset = FALSE, BOOL bInitialState = FALSE, LPCTSTR pszName = nullptr, LPSECURITY_ATTRIBUTES pSecurity = nullptr)
+	{
+		m_hEvent = ::CreateEvent(pSecurity, bManualReset, bInitialState, pszName);
+		ASSERT(IsValid());
+	}
+
+	~CEvt()
+	{
+		if(IsValid())
+			VERIFY(::CloseHandle(m_hEvent));
+	}
+
+	BOOL Open(DWORD dwAccess, BOOL bInheritHandle, LPCTSTR pszName)
+	{
+		if(IsValid())
+			VERIFY(::CloseHandle(m_hEvent));
+
+		m_hEvent = ::OpenEvent(dwAccess, bInheritHandle, pszName);
+		return(IsValid());
+	}
+
+	BOOL Pulse()	{return(::PulseEvent(m_hEvent));}
+	BOOL Reset()	{return(::ResetEvent(m_hEvent));}
+	BOOL Set()		{return(::SetEvent(m_hEvent));}
+
+	BOOL IsValid()	{return m_hEvent != nullptr;}
+
+	HANDLE GetHandle		()			{return m_hEvent;}
+	const HANDLE GetHandle	()	const	{return m_hEvent;}
+
+	operator HANDLE			()			{return m_hEvent;}
+	operator const HANDLE	()	const	{return m_hEvent;}
+
+private:
+	CEvt(const CEvt&);
+	CEvt operator = (const CEvt&);
+
+private:
+	HANDLE m_hEvent;
+};
+

socket/common/Src/GeneralHelper.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "GeneralHelper.h"

socket/common/Src/GeneralHelper.h

@@ -0,0 +1,234 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/*
+
+Optional Macros:
+
+Windows:
+++++++++++++++++++++++
+_WIN32_WINNT		: Windows NT 版本	（默认：_WIN32_WINNT_WINXP / _WIN32_WINNT_WIN7）
+WINVER				: Windows 版本		（默认：_WIN32_WINNT）
+_USE_MFC			: 使用 MFC
+_WINSOCK_SUPPORT	: 支持 Windows Socket
+_NO_RIBBONS_SUPPORT	: 不支持 Ribbons 界面风格
+_DETECT_MEMORY_LEAK	: DEBUG 状态下支持内存泄露检查
+
+Windows CE:
+++++++++++++++++++++++
+WINVER				: Windows 版本
+_USE_MFC			: 使用 MFC
+_WINSOCK_SUPPORT	: 支持 Windows Socket
+_DETECT_MEMORY_LEAK	: DEBUG 状态下支持内存泄露检查
+_ONLY_DETECT_CONFIRMED_MEMORY_LEAK_	: 只报告能够确认的内存泄露（不能确定的不报告）
+---------------------------
+VC 2015
+	_MSC_VER == 1900
+VC 2013
+	_MSC_VER == 1800
+VC 2012
+	_MSC_VER == 1700
+VC 2010
+	_MSC_VER == 1600
+VC 2008
+	_MSC_VER == 1500
+VC 2005
+	_MSC_VER == 1400
+VC 7.1
+	_MSC_VER == 1310
+VC 7.0
+	_MSC_VER == 1300
+VC 6.0
+	_MSC_VER == 1200
+---------------------------
+Windows Versions:
+_WIN32_WINNT_NT4		x0400
+_WIN32_WINNT_WIN2K		0x0500
+_WIN32_WINNT_WINXP		0x0501
+_WIN32_WINNT_WS03		0x0502
+_WIN32_WINNT_WIN6		0x0600
+_WIN32_WINNT_VISTA		0x0600
+_WIN32_WINNT_WS08		0x0600
+_WIN32_WINNT_LONGHORN	0x0600
+_WIN32_WINNT_WIN7		0x0601
+_WIN32_WINNT_WIN8		0x0602
+_WIN32_WINNT_WINBLUE	0x0603
+_WIN32_WINNT_WIN10		0x0A00
+---------------------------
+*/
+
+#pragma once
+
+#ifndef VC_EXTRALEAN
+	#define VC_EXTRALEAN
+#endif
+
+#ifndef WIN32_LEAN_AND_MEAN
+	#define WIN32_LEAN_AND_MEAN
+#endif
+
+#ifndef _ATL_CSTRING_EXPLICIT_CONSTRUCTORS
+	#define _ATL_CSTRING_EXPLICIT_CONSTRUCTORS
+#endif
+
+#if _MSC_VER >= 1400
+
+	#if defined _DEBUG && _MSC_VER < 1600
+		#ifndef _SECURE_SCL
+			#define _SECURE_SCL					0
+		#endif
+		#ifndef _HAS_ITERATOR_DEBUGGING
+			#define _HAS_ITERATOR_DEBUGGING		0
+		#endif
+	#endif
+
+	#ifndef _CRT_SECURE_NO_DEPRECATE
+		#define _CRT_SECURE_NO_DEPRECATE		1
+	#endif
+
+	#ifndef _SCL_SECURE_NO_DEPRECATE
+		#define _SCL_SECURE_NO_DEPRECATE		1
+	#endif
+
+	#ifndef _ATL_SECURE_NO_WARNINGS
+		#define _ATL_SECURE_NO_WARNINGS			1
+	#endif
+
+	#ifndef _CRT_NON_CONFORMING_SWPRINTFS
+		#define _CRT_NON_CONFORMING_SWPRINTFS	1
+	#endif
+
+	#ifndef _SECURE_ATL
+		#define _SECURE_ATL						1
+	#endif
+
+	#ifndef _WINSOCK_DEPRECATED_NO_WARNINGS
+		#define _WINSOCK_DEPRECATED_NO_WARNINGS	1
+	#endif
+
+#endif
+
+#ifndef _WIN32_WINNT
+	#if defined (_WIN64)
+		#define _WIN32_WINNT	_WIN32_WINNT_WIN7
+	#else
+		#define _WIN32_WINNT	_WIN32_WINNT_WINXP
+	#endif
+#endif
+
+#ifndef WINVER
+	#define WINVER	_WIN32_WINNT
+#endif
+
+#if _MSC_VER >= 1600
+	#include <SDKDDKVer.h>
+#else
+	#if !defined(nullptr)
+		#define nullptr	NULL
+	#endif
+#endif
+
+#ifdef _DETECT_MEMORY_LEAK
+	#ifndef _CRTDBG_MAP_ALLOC
+		#define _CRTDBG_MAP_ALLOC
+	#endif
+#endif
+
+#ifdef _USE_MFC
+
+	#ifndef _AFX_ALL_WARNINGS
+		#define _AFX_ALL_WARNINGS
+	#endif
+
+	#include <afxwin.h>
+	#include <afxext.h>
+	#include <afxdisp.h>
+
+	#ifndef _AFX_NO_OLE_SUPPORT
+		#include <afxdtctl.h>
+	#endif
+
+	#ifndef _AFX_NO_AFXCMN_SUPPORT
+		#include <afxcmn.h>
+	#endif
+
+	#ifndef _NO_RIBBONS_SUPPORT
+		#include <afxcontrolbars.h>
+	#endif
+
+#else
+
+	#include <Windows.h>
+	#include <WindowsX.h>
+	#include <commctrl.h>
+	#include <stdio.h>
+	#include <stdlib.h>
+	#include <malloc.h>
+	#include <memory.h>
+	#include <tchar.h>
+	#include <atlstr.h>
+	#include <atltime.h>
+
+	#ifndef ASSERT
+		#define ASSERT(f)	ATLASSERT(f)
+	#endif
+	#ifndef VERIFY
+		#define VERIFY(f)	ATLVERIFY(f)
+	#endif
+
+	#ifndef TRACE
+		#include <atltrace.h>
+
+		#define TRACE							AtlTrace
+		#define TRACE0(f)						TRACE(f)
+		#define TRACE1(f, p1)					TRACE(f, p1)
+		#define TRACE2(f, p1, p2)				TRACE(f, p1, p2)
+		#define TRACE3(f, p1, p2, p3)			TRACE(f, p1, p2, p3)
+		#define TRACE4(f, p1, p2, p3, p4)		TRACE(f, p1, p2, p3, p4)
+		#define TRACE5(f, p1, p2, p3, p4, p5)	TRACE(f, p1, p2, p3, p4, p5)
+	#endif
+
+#endif
+
+#ifdef _WINSOCK_SUPPORT
+	#include <winsock2.h>
+	#include <ws2tcpip.h>
+	#include <mswsock.h>
+#endif
+
+#include <atlbase.h>
+#include <atlconv.h>
+
+#include "Singleton.h"
+#include "Event.h"
+#include "Semaphore.h"
+#include "CriticalSection.h"
+#include "STLHelper.h"
+#include "Win32Helper.h"
+#include "PrivateHeap.h"
+#include "bufferptr.h"
+
+#if defined (_DEBUG) && defined (_DETECT_MEMORY_LEAK)
+	#include "debug/win32_crtdbg.h"
+#endif

socket/common/Src/PrivateHeap.cpp

@@ -0,0 +1,32 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/******************************************************************************
+Module:  PrivateHeap.cpp
+Notices: Copyright (c) 2006 Bruce Liang
+Purpose: ¹ÜÀí½ø³Ì˽ÓжÑ.
+******************************************************************************/
+
+#include "StdAfx.h"
+#include "PrivateHeap.h"

socket/common/Src/PrivateHeap.h

@@ -0,0 +1,238 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/******************************************************************************
+Module:  PrivateHeap.h
+Notices: Copyright (c) 2006 Bruce Liang
+Purpose: 管理进程私有堆.
+Desc:
+		 1. CPrivateHeap:		自动创建和销毁进程私有堆
+								每一个该类的对象都代表一个私有堆, 所以
+								该类对象的特点是: 一般声明周期都比较长
+								通常作为全局对象, 其他类的静态成员对象
+								或者一些长生命周期类对象的成员对象
+		 2. CPrivateHeapBuffer: 在私有堆中自动分配和释放指定大小的内存
+								一般用于在函数体内分配和释放局部作用域的堆内存
+								从而避免对 CPrivateHeap::Alloc() 和 
+								CPrivateHeap::Free() 的调用
+
+Examples:
+			CPrivateHeap g_hpPrivate;
+
+			int _tmain(int argc, _TCHAR* argv[])
+			{
+				CPrivateHeapStrBuffer buff(g_hpPrivate, 32);
+				lstrcpy(buff, _T("失败乃成功之母"));
+				SIZE_T size = buff.Size();
+				buff.ReAlloc(40);
+				size = buff.Size();
+				std::cout << (TCHAR*)buff << '\n';
+				// OR
+				// ASSERT(g_hpPrivate.IsValid());
+				// TCHAR* pch	= (TCHAR*)g_hpPrivate.Alloc(32 * sizeof(TCHAR));
+				// lstrcpy(pch, _T("失败乃成功之母"));
+				// SIZE_T size = g_hpPrivate.Size(pch);
+				// g_hpPrivate.ReAlloc(pch, 40 * sizeof(TCHAR));
+				// size = g_hpPrivate.Size(pch);
+				// std::cout << pch << '\n';
+				// g_hpPrivate.Free(pch);
+				// 
+				return 0;
+			}
+
+******************************************************************************/
+
+#pragma once
+
+class CPrivateHeapImpl
+{
+public:
+	PVOID Alloc(SIZE_T dwSize, DWORD dwFlags = 0)
+		{return ::HeapAlloc(m_hHeap, dwFlags, dwSize);}
+
+	PVOID ReAlloc(PVOID pvMemory, SIZE_T dwSize, DWORD dwFlags = 0)
+		{return ::HeapReAlloc(m_hHeap, dwFlags, pvMemory, dwSize);}
+
+	SIZE_T Size(PVOID pvMemory, DWORD dwFlags = 0)
+		{return ::HeapSize(m_hHeap, dwFlags, pvMemory);}
+
+	BOOL Free(PVOID pvMemory, DWORD dwFlags = 0)
+		{return ::HeapFree(m_hHeap, dwFlags, pvMemory);}
+
+	SIZE_T Compact(DWORD dwFlags = 0)
+		{return ::HeapCompact(m_hHeap, dwFlags);}
+
+	BOOL IsValid() {return m_hHeap != nullptr;}
+
+	BOOL Reset()
+	{
+		if(IsValid()) ::HeapDestroy(m_hHeap);
+		m_hHeap = ::HeapCreate(m_dwOptions, m_dwInitSize, m_dwMaxSize);
+
+		return IsValid();
+	}
+
+public:
+	CPrivateHeapImpl(DWORD dwOptions = 0, SIZE_T dwInitSize = 0, SIZE_T dwMaxSize = 0)
+	: m_dwOptions(dwOptions), m_dwInitSize(dwInitSize), m_dwMaxSize(dwMaxSize)
+		{m_hHeap = ::HeapCreate(m_dwOptions, m_dwInitSize, m_dwMaxSize);}
+
+	~CPrivateHeapImpl	()	{if(IsValid()) ::HeapDestroy(m_hHeap);}
+
+	operator HANDLE	()	{return m_hHeap;}
+
+private:
+	CPrivateHeapImpl(const CPrivateHeapImpl&);
+	CPrivateHeapImpl operator = (const CPrivateHeapImpl&);
+
+private:
+	HANDLE	m_hHeap;
+	DWORD	m_dwOptions;
+	SIZE_T	m_dwInitSize;
+	SIZE_T	m_dwMaxSize;
+};
+
+class CGlobalHeapImpl
+{
+public:
+	PVOID Alloc(SIZE_T dwSize, DWORD dwFlags = 0)
+	{
+		PVOID pv = malloc(dwSize);
+		
+		if(pv && (dwFlags | HEAP_ZERO_MEMORY))
+			ZeroMemory(pv, dwSize);
+		
+		return pv;
+	}
+
+	PVOID ReAlloc(PVOID pvMemory, SIZE_T dwSize, DWORD dwFlags = 0)
+	{
+		PVOID pv = realloc(pvMemory, dwSize);
+
+		if(pv && (dwFlags | HEAP_ZERO_MEMORY))
+			ZeroMemory(pv, dwSize);
+		else if(!pv)
+			free(pvMemory);
+
+		return pv;
+	}
+
+	BOOL Free(PVOID pvMemory, DWORD dwFlags = 0)
+	{
+		if(pvMemory)
+		{
+			free(pvMemory);
+			return TRUE;
+		}
+
+		return FALSE;
+	}
+
+	SIZE_T Compact	(DWORD dwFlags = 0)					{return -1;}
+	SIZE_T Size		(PVOID pvMemory, DWORD dwFlags = 0)	{return _msize(pvMemory);}
+
+	BOOL IsValid()	{return TRUE;}
+	BOOL Reset()	{return TRUE;}
+
+public:
+	CGlobalHeapImpl	(DWORD dwOptions = 0, SIZE_T dwInitSize = 0, SIZE_T dwMaxSize = 0) {}
+	~CGlobalHeapImpl()	{}
+
+	operator HANDLE	()	{return nullptr;}
+
+private:
+	CGlobalHeapImpl(const CGlobalHeapImpl&);
+	CGlobalHeapImpl operator = (const CGlobalHeapImpl&);
+};
+
+#ifndef _NOT_USE_PRIVATE_HEAP
+	typedef CPrivateHeapImpl	CPrivateHeap;
+#else
+	typedef CGlobalHeapImpl		CPrivateHeap;
+#endif
+
+template<class T>
+class CPrivateHeapBuffer
+{
+public:
+	CPrivateHeapBuffer(CPrivateHeap& hpPrivate,
+						SIZE_T dwSize		= 0,
+						DWORD dwAllocFlags	= 0,
+						DWORD dwFreeFlags	= 0)
+	: m_hpPrivate(hpPrivate)
+	, m_dwAllocFlags(dwAllocFlags)
+	, m_dwFreeFlags(dwFreeFlags)
+	, m_pvMemory(nullptr)
+	{
+		ASSERT(m_hpPrivate.IsValid());
+		Alloc(dwSize);
+	}
+
+	~CPrivateHeapBuffer() {Free();}
+
+public:
+
+	T* Alloc(SIZE_T dwSize)
+	{
+		if(IsValid())
+			Free();
+
+		return m_pvMemory = (T*)m_hpPrivate.Alloc(dwSize * sizeof(T), m_dwAllocFlags);
+	}
+
+	T* ReAlloc(SIZE_T dwSize, DWORD dwFlags = 0)
+		{return m_pvMemory = (T*)m_hpPrivate.ReAlloc(m_pvMemory, dwSize * sizeof(T), dwFlags);}
+
+	SIZE_T Size(DWORD dwFlags = 0)
+		{return m_hpPrivate.Size(m_pvMemory, dwFlags);}
+
+	BOOL Free()
+	{
+		BOOL isOK = TRUE;
+
+		if(IsValid())
+		{
+			isOK = m_hpPrivate.Free(m_pvMemory, m_dwFreeFlags);
+			m_pvMemory = nullptr;
+		}
+
+		return isOK;
+	}
+
+	BOOL IsValid()			{return m_pvMemory != nullptr;}
+	operator T* ()	const	{return m_pvMemory;}
+
+private:
+	CPrivateHeapBuffer(const CPrivateHeapBuffer&);
+	CPrivateHeapBuffer operator = (const CPrivateHeapBuffer&);
+
+private:
+	CPrivateHeap&	m_hpPrivate;
+	T*				m_pvMemory;
+	DWORD			m_dwAllocFlags;
+	DWORD			m_dwFreeFlags;
+};
+
+typedef CPrivateHeapBuffer<BYTE>	CPrivateHeapByteBuffer;
+typedef CPrivateHeapBuffer<TCHAR>	CPrivateHeapStrBuffer;

socket/common/Src/RWLock.cpp

@@ -0,0 +1,402 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *		http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "StdAfx.h"
+#include "RWLock.h"
+
+////////////////////////////////// CSWMR Functions ////////////////////////////////////
+
+CSWMR::CSWMR()
+: m_smRead			(MAXLONG)
+, m_smWrite			(1)
+, m_nWaitingReaders	(0)
+, m_nWaitingWriters	(0)
+, m_nActive			(0)
+{
+
+}
+
+CSWMR::~CSWMR()
+{
+	ASSERT(m_nWaitingReaders == 0);
+	ASSERT(m_nWaitingWriters == 0);
+	ASSERT(m_nActive		 == 0);
+}
+
+VOID CSWMR::WaitToRead()
+{
+	BOOL fResourceWritePending;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		fResourceWritePending = (m_nWaitingWriters || (m_nActive < 0));
+
+		if(fResourceWritePending)
+			++m_nWaitingReaders;
+		else
+			++m_nActive;
+	}
+
+	if(fResourceWritePending)
+		m_smRead.Wait();
+}
+
+VOID CSWMR::WaitToWrite()
+{
+	BOOL fResourceOwned;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		fResourceOwned = (m_nActive != 0);
+
+		if(fResourceOwned)
+			++m_nWaitingWriters;
+		else
+			m_nActive = -1;
+	}
+
+	if(fResourceOwned)
+		m_smWrite.Wait();
+}
+
+VOID CSWMR::Done()
+{
+	CSEM* pSem  = nullptr;
+	LONG lCount = 1;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		if(m_nActive > 0)
+			--m_nActive;
+		else
+			++m_nActive;
+
+		if(m_nActive == 0)
+		{
+			if(m_nWaitingWriters > 0)
+			{
+				m_nActive = -1;
+				--m_nWaitingWriters;
+				pSem = &m_smWrite;
+			}
+			else if(m_nWaitingReaders > 0)
+			{
+				m_nActive = m_nWaitingReaders;
+				m_nWaitingReaders = 0;
+				pSem = &m_smRead;
+				lCount = m_nActive;
+			}
+		}
+	}
+
+	if(pSem != nullptr)
+		pSem->Release(lCount);
+}
+
+//////////////////////////////// CRWLock Functions //////////////////////////////////
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+
+CSlimRWLock::CSlimRWLock()
+	: m_nActive			(0)
+	, m_nReadCount		(0)
+	, m_dwWriterTID		(0)
+{
+
+}
+
+CSlimRWLock::~CSlimRWLock()
+{
+	ASSERT(m_nActive	 == 0);
+	ASSERT(m_nReadCount	 == 0);
+	ASSERT(m_dwWriterTID == 0);
+}
+
+VOID CSlimRWLock::WaitToRead()
+{
+	BOOL bWait = FALSE;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		if(m_nActive > 0)
+			++m_nActive;
+		else if(m_nActive == 0)
+		{
+			if(m_smLock.TryWaitToRead())
+			{
+				++m_nReadCount;
+				++m_nActive;
+			}
+			else
+				bWait = TRUE;
+		}
+		else if(!IsOwner())
+			bWait = TRUE;
+	}
+
+	if(bWait)
+	{
+		m_smLock.WaitToRead();
+
+		CSpinLock locallock(m_cs);
+		{
+			++m_nReadCount;
+			++m_nActive;
+		}
+	}
+}
+
+VOID CSlimRWLock::WaitToWrite()
+{
+	BOOL bWait = FALSE;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		if(m_nActive > 0)
+			bWait = TRUE;
+		else if(m_nActive == 0)
+		{
+			if(m_smLock.TryWaitToWrite())
+			{
+				SetOwner();
+				--m_nActive;
+			}
+			else
+				bWait = TRUE;
+		}
+		else
+		{
+			if(IsOwner())
+				--m_nActive;
+			else
+				bWait = TRUE;
+		}
+	}
+
+	if(bWait)
+	{
+		m_smLock.WaitToWrite();
+
+		SetOwner();
+		--m_nActive;
+	}
+}
+
+VOID CSlimRWLock::ReadDone()
+{
+	ASSERT(m_nActive != 0);
+
+	if(m_nActive > 0)
+	{
+		ASSERT(m_nReadCount > 0);
+
+		CSpinLock locallock(m_cs);
+
+		if(--m_nActive == 0)
+		{
+			for(; m_nReadCount > 0; --m_nReadCount)
+				m_smLock.ReadDone();
+		}
+	}
+	else
+		ASSERT(IsOwner());
+}
+
+VOID CSlimRWLock::WriteDone()
+{
+	ASSERT(m_nActive < 0);
+
+	CSpinLock locallock(m_cs);
+
+	if(++m_nActive == 0)
+	{
+		DetachOwner();
+		m_smLock.WriteDone();
+	}
+	else
+		ASSERT(IsOwner());
+}
+
+#endif
+
+CSEMRWLock::CSEMRWLock()
+: m_smRead			(MAXLONG)
+, m_smWrite			(1)
+, m_nWaitingReaders	(0)
+, m_nWaitingWriters	(0)
+, m_nActive			(0)
+, m_dwWriterTID		(0)
+{
+
+}
+
+CSEMRWLock::~CSEMRWLock()
+{
+	ASSERT(m_nActive	 == 0);
+	ASSERT(m_dwWriterTID == 0);
+}
+
+VOID CSEMRWLock::WaitToRead()
+{
+	BOOL bWait = FALSE;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		if(m_nActive > 0)
+			++m_nActive;
+		else if(m_nActive == 0)
+		{
+			if(m_nWaitingWriters == 0)
+				++m_nActive;
+			else
+			{
+				++m_nWaitingReaders;
+				bWait = TRUE;
+			}
+		}
+		else
+		{
+			if(!IsOwner())
+			{
+				++m_nWaitingReaders;
+				bWait = TRUE;
+			}
+		}
+	}
+
+	if(bWait)
+	{
+		m_smRead.Wait();
+	}
+}
+
+VOID CSEMRWLock::WaitToWrite()
+{
+	BOOL bWait = FALSE;
+
+	{
+		CSpinLock locallock(m_cs);
+
+		if(m_nActive > 0)
+		{
+			++m_nWaitingWriters;
+			bWait = TRUE;
+		}
+		else if(m_nActive == 0)
+		{
+			--m_nActive;
+			SetOwner();
+		}
+		else
+		{
+			if(IsOwner())
+				--m_nActive;
+			else
+			{
+				++m_nWaitingWriters;
+				bWait = TRUE;
+			}
+		}
+	}
+
+	if(bWait)
+	{
+		m_smWrite.Wait();
+		SetOwner();
+	}
+}
+
+VOID CSEMRWLock::ReadDone()
+{
+	CSEM* pSem	 = nullptr;
+	LONG  lCount = 0;
+
+	ASSERT(m_nActive != 0);
+
+	if(m_nActive > 0)
+	{
+		CSpinLock locallock(m_cs);
+
+		if(--m_nActive == 0)
+			Done(&pSem, lCount);
+	}
+	else
+		ASSERT(IsOwner());
+
+	if(pSem != nullptr)
+		pSem->Release(lCount);
+}
+
+VOID CSEMRWLock::WriteDone()
+{
+	CSEM* pSem	 = nullptr;
+	LONG  lCount = 0;
+
+	{
+		ASSERT(m_nActive < 0);
+
+		CSpinLock locallock(m_cs);
+
+		if(++m_nActive == 0)
+		{
+			DetachOwner();
+			Done(&pSem, lCount);
+		}
+		else
+			ASSERT(IsOwner());
+	}
+
+	if(pSem != nullptr)
+		pSem->Release(lCount);
+}
+
+VOID CSEMRWLock::Done(CSEM** ppSem, LONG& lCount)
+{
+	ASSERT(m_nActive	 == 0);
+	ASSERT(m_dwWriterTID == 0);
+
+	if(m_nWaitingWriters > 0)
+	{
+		--m_nActive;
+		--m_nWaitingWriters;
+
+		lCount = 1;
+		*ppSem = &m_smWrite;
+	}
+	else if(m_nWaitingReaders > 0)
+	{
+		m_nActive			= m_nWaitingReaders;
+		m_nWaitingReaders	= 0;
+		lCount				= m_nActive;
+		*ppSem				= &m_smRead;
+	}
+}
+
+/////////////////////////////////// End of File /////////////////////////////////////

socket/common/Src/RWLock.h

@@ -0,0 +1,418 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *		http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "CriticalSection.h"
+#include "Semaphore.h"
+
+class CSWMR
+{
+public:
+	VOID WaitToRead();
+	VOID WaitToWrite();
+	VOID ReadDone()  {Done();}
+	VOID WriteDone() {Done();}
+
+private:
+	VOID Done();
+
+public:
+	CSWMR();
+	~CSWMR();
+
+private:
+	CSWMR(const CSWMR&);
+	CSWMR operator = (const CSWMR&);
+
+private:
+	int m_nWaitingReaders;
+	int m_nWaitingWriters;
+	int m_nActive;
+
+	CSpinGuard	m_cs;
+	CSEM		m_smRead;
+	CSEM		m_smWrite;
+};
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+
+class CSlimLock
+{
+public:
+	VOID WaitToRead()		{::AcquireSRWLockShared(&m_lock);}
+	VOID WaitToWrite()		{::AcquireSRWLockExclusive(&m_lock);}
+	VOID ReadDone()			{::ReleaseSRWLockShared(&m_lock);}
+	VOID WriteDone()		{::ReleaseSRWLockExclusive(&m_lock);}
+	BOOL TryWaitToRead()	{return ::TryAcquireSRWLockShared(&m_lock);}
+	BOOL TryWaitToWrite()	{return ::TryAcquireSRWLockExclusive(&m_lock);}
+
+	SRWLOCK* GetObject()	{return &m_lock;}
+
+public:
+	CSlimLock()		{::InitializeSRWLock(&m_lock);}
+	~CSlimLock()	{}
+
+private:
+	CSlimLock(const CSlimLock&);
+	CSlimLock operator = (const CSlimLock&);
+
+private:
+	SRWLOCK m_lock;
+};
+
+class CSlimRWLock
+{
+public:
+	VOID WaitToRead();
+	VOID WaitToWrite();
+	VOID ReadDone();
+	VOID WriteDone();
+
+private:
+	BOOL IsOwner()		{return m_dwWriterTID == ::GetCurrentThreadId();}
+	VOID SetOwner()		{m_dwWriterTID = ::GetCurrentThreadId();}
+	VOID DetachOwner()	{m_dwWriterTID = 0;}
+
+public:
+	CSlimRWLock();
+	~CSlimRWLock();
+
+private:
+	CSlimRWLock(const CSlimRWLock&);
+	CSlimRWLock operator = (const CSlimRWLock&);
+
+private:
+	int m_nActive;
+	int m_nReadCount;
+	DWORD m_dwWriterTID;
+
+	CSpinGuard	m_cs;
+	CSlimLock	m_smLock;
+};
+
+#endif
+
+class CSEMRWLock
+{
+public:
+	VOID WaitToRead();
+	VOID WaitToWrite();
+	VOID ReadDone();
+	VOID WriteDone();
+
+private:
+	VOID Done			(CSEM** ppSem, LONG& lCount);
+	BOOL IsOwner()		{return m_dwWriterTID == ::GetCurrentThreadId();}
+	VOID SetOwner()		{m_dwWriterTID = ::GetCurrentThreadId();}
+	VOID DetachOwner()	{m_dwWriterTID = 0;}
+
+public:
+	CSEMRWLock();
+	~CSEMRWLock();
+
+private:
+	CSEMRWLock(const CSEMRWLock&);
+	CSEMRWLock operator = (const CSEMRWLock&);
+
+private:
+	int m_nWaitingReaders;
+	int m_nWaitingWriters;
+	int m_nActive;
+	DWORD m_dwWriterTID;
+
+	CSpinGuard	m_cs;
+	CSEM		m_smRead;
+	CSEM		m_smWrite;
+};
+
+template<class CLockObj> class CLocalReadLock
+{
+public:
+	CLocalReadLock(CLockObj& obj) : m_wait(obj) {m_wait.WaitToRead();}
+	~CLocalReadLock() {m_wait.ReadDone();}
+private:
+	CLocalReadLock(const CLocalReadLock&);
+	CLocalReadLock operator = (const CLocalReadLock&);
+private:
+	CLockObj& m_wait;
+};
+
+template<class CLockObj> class CLocalWriteLock
+{
+public:
+	CLocalWriteLock(CLockObj& obj) : m_wait(obj) {m_wait.WaitToWrite();}
+	~CLocalWriteLock() {m_wait.WriteDone();}
+private:
+	CLocalWriteLock(const CLocalWriteLock&);
+	CLocalWriteLock operator = (const CLocalWriteLock&);
+private:
+	CLockObj& m_wait;
+};
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+	typedef CSlimLock	CSimpleRWLock;
+#else
+	typedef CSWMR		CSimpleRWLock;
+#endif
+
+typedef CLocalReadLock<CSimpleRWLock>	CReadLock;
+typedef CLocalWriteLock<CSimpleRWLock>	CWriteLock;
+
+typedef CSEMRWLock						CRWLock;
+typedef CLocalReadLock<CRWLock>			CReentrantReadLock;
+typedef CLocalWriteLock<CRWLock>		CReentrantWriteLock;
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+
+class ICVCondition
+{
+public:
+	virtual BOOL Detect() = 0;
+
+public:
+	virtual ~ICVCondition() {}
+};
+
+class CCVCriSec
+{
+public:
+	CCVCriSec(CInterCriSec& cs)
+	: m_cs(cs)
+	{
+		::InitializeConditionVariable(&m_cv);
+	}
+
+	~CCVCriSec() {}
+
+	void WaitToRead(ICVCondition* pCondition)
+	{
+		Wait(pCondition);
+	}
+
+	void WaitToWrite(ICVCondition* pCondition)
+	{
+		Wait(pCondition);
+	}
+
+	void ReadDone()
+	{
+		Done();
+	}
+
+	void WriteDone()
+	{
+		Done();
+	}
+
+	void WakeUp()
+	{
+		::WakeConditionVariable(&m_cv);
+	}
+
+	void WakeUpAll()
+	{
+		::WakeAllConditionVariable(&m_cv);
+	}
+
+private:
+	void Wait(ICVCondition* pCondition)
+	{
+		ASSERT(pCondition);
+
+		m_cs.Lock();
+
+		while(!pCondition->Detect()) 
+			::SleepConditionVariableCS(&m_cv, m_cs.GetObject(), INFINITE);
+	}
+
+	void Done()
+	{
+		m_cs.Unlock();
+	}
+
+private:
+	CCVCriSec(const CCVCriSec& cs);
+	CCVCriSec operator = (const CCVCriSec& cs);
+
+private:
+	CInterCriSec&		m_cs;
+	CONDITION_VARIABLE	m_cv;
+};
+
+class CCVSlim
+{
+public:
+	CCVSlim(CSlimLock& cs)
+	: m_cs(cs)
+	{
+		::InitializeConditionVariable(&m_cv);
+	}
+
+	~CCVSlim() {}
+
+	void WaitToRead(ICVCondition* pCondition)
+	{
+		ASSERT(pCondition);
+
+		m_cs.WaitToRead();
+
+		while(!pCondition->Detect()) 
+			::SleepConditionVariableSRW(&m_cv, m_cs.GetObject(), INFINITE, CONDITION_VARIABLE_LOCKMODE_SHARED);
+	}
+
+	void WaitToWrite(ICVCondition* pCondition)
+	{
+		ASSERT(pCondition);
+
+		m_cs.WaitToWrite();
+
+		while(!pCondition->Detect())  
+			::SleepConditionVariableSRW(&m_cv, m_cs.GetObject(), INFINITE, 0);
+	}
+
+	void ReadDone()
+	{
+		m_cs.ReadDone();
+	}
+
+	void WriteDone()
+	{
+		m_cs.WriteDone();
+	}
+
+	void WakeUp()
+	{
+		::WakeConditionVariable(&m_cv);
+	}
+
+	void WakeUpAll()
+	{
+		::WakeAllConditionVariable(&m_cv);
+	}
+
+private:
+	CCVSlim(const CCVSlim& cs);
+	CCVSlim operator = (const CCVSlim& cs);
+
+private:
+	CSlimLock&			m_cs;
+	CONDITION_VARIABLE	m_cv;
+};
+
+template<class _Lock, class _Var> class CCVGuard
+{
+public:
+	void WaitForProduce()
+	{
+		m_cvP.WaitToWrite(m_pcdtProduce);
+	}
+
+	void WaitForConsume()
+	{
+		m_cvC.WaitToRead(m_pcdtConsume);
+	}
+
+	void ProduceDone()
+	{
+		m_cvP.WriteDone();
+	}
+
+	void WakeUpProduce()
+	{
+		m_cvP.WakeUp();
+	}
+
+	void ConsumeDone()
+	{
+		m_cvC.ReadDone();
+	}
+
+	void WakeUpConsume()
+	{
+		m_cvC.WakeUp();
+	}
+
+	void WakeUpAllConsumes()
+	{
+		m_cvC.WakeUpAll();
+	}
+
+public:
+	CCVGuard(ICVCondition* pcdtProduce, ICVCondition* pcdtConsume)
+	: m_cvP(m_cs)
+	, m_cvC(m_cs)
+	, m_pcdtProduce(pcdtProduce)
+	, m_pcdtConsume(pcdtConsume)
+	{
+		ASSERT(m_pcdtConsume && m_pcdtProduce);
+	}
+
+	~CCVGuard()	{}
+
+private:
+	CCVGuard(const CCVGuard& cs);
+	CCVGuard operator = (const CCVGuard& cs);
+
+private:
+	ICVCondition* m_pcdtProduce;
+	ICVCondition* m_pcdtConsume;
+
+	_Lock	m_cs;
+	_Var	m_cvP;
+	_Var	m_cvC;
+};
+
+template<class _GuardObj> class CConsumeLock
+{
+public:
+	CConsumeLock(_GuardObj& obj) : m_guard(obj) {m_guard.WaitForConsume();}
+	~CConsumeLock() {m_guard.ConsumeDone();}
+private:
+	CConsumeLock(const CConsumeLock&);
+	CConsumeLock operator = (const CConsumeLock&);
+private:
+	_GuardObj& m_guard;
+};
+
+template<class _GuardObj> class CProduceLock
+{
+public:
+	CProduceLock(_GuardObj& obj) : m_guard(obj) {m_guard.WaitForProduce();}
+	~CProduceLock() {m_guard.ProduceDone();}
+private:
+	CProduceLock(const CProduceLock&);
+	CProduceLock operator = (const CProduceLock&);
+private:
+	_GuardObj& m_guard;
+};
+
+typedef CCVGuard<CInterCriSec, CCVCriSec>	CCVGuardCS;
+typedef CCVGuard<CSlimLock, CCVSlim>		CCVGuardSRW;
+typedef CProduceLock<CCVGuardCS>			CProduceLockCS;
+typedef CConsumeLock<CCVGuardCS>			CConsumeLockCS;
+typedef CProduceLock<CCVGuardSRW>			CProduceLockSRW;
+typedef CConsumeLock<CCVGuardSRW>			CConsumeLockSRW;
+
+#endif

socket/common/Src/RingBuffer.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "stdafx.h"
+#include "RingBuffer.h"

socket/common/Src/RingBuffer.h

@@ -0,0 +1,1526 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "STLHelper.h"
+#include "RWLock.h"
+#include "CriticalSection.h"
+
+#define CACHE_LINE		64
+#define PACK_SIZE_OF(T)	(CACHE_LINE - sizeof(T) % CACHE_LINE)
+
+#if !defined (_WIN64)
+	#pragma pack(push, 4)
+#endif
+
+template <class T, class _PutGuard = CCriSec, class _GetGuard = CCriSec> class CRingBuffer
+{
+public:
+	static const UINT DEFAULT_EXPECT = 4096;
+
+public:
+	BOOL Put(T* pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		{
+			CLocalLock<_PutGuard> locallock(m_csPut);
+
+			ULONGLONG seqPut = m_seqPut;
+
+			WaitForPut(seqPut);
+			if(!IsValid()) return FALSE;
+
+			DoPut(pElement, seqPut);
+		}
+
+		return TRUE;
+	}
+
+	BOOL TryPut(T* pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		if(!IsValid() || !HasPutSpace(m_seqPut))
+			return FALSE;
+
+		{
+			CLocalLock<_PutGuard> locallock(m_csPut);
+
+			ULONGLONG seqPut = m_seqPut;
+
+			if(!IsValid() || !HasPutSpace(seqPut))
+				return FALSE;
+
+			DoPut(pElement, seqPut);
+		}
+
+		return TRUE;
+	}
+
+	BOOL PutBatch(T* pElements[], int& iCount)
+	{
+		ASSERT(pElements != nullptr && iCount > 0);
+
+		{
+			CLocalLock<_PutGuard> locallock(m_csPut);
+
+			ULONGLONG seqPut = m_seqPut;
+
+			for(int i = 0; i < iCount; ++i)
+			{
+				WaitForPut(seqPut);
+
+				if(!IsValid())
+				{
+					iCount = i;
+					return FALSE;
+				}
+
+				DoPut(*(pElements + i), seqPut);
+			}
+		}
+
+		return TRUE;
+	}
+
+	BOOL TryPutBatch(T* pElements[], int& iCount)
+	{
+		ASSERT(pElements != nullptr && iCount > 0);
+
+		if(!IsValid() || !HasPutSpace(m_seqPut))
+		{
+			iCount = 0;
+			return FALSE;
+		}
+
+		{
+			CLocalLock<_PutGuard> locallock(m_csPut);
+
+			ULONGLONG seqPut = m_seqPut;
+
+			for(int i = 0; i < iCount; ++i)
+			{
+				if(!IsValid() || !HasPutSpace(seqPut))
+				{
+					iCount = i;
+					return FALSE;
+				}
+
+				DoPut(*(pElements + i), seqPut);
+			}
+		}
+
+		return TRUE;
+	}
+
+	BOOL Get(T** pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		{
+			CLocalLock<_GetGuard> locallock(m_csGet);
+
+			ULONGLONG seqGet = m_seqGet;
+
+			WaitForGet(seqGet);
+			if(!IsValid()) return FALSE;
+
+			DoGet(pElement, seqGet);
+		}
+
+		return TRUE;
+	}
+
+	BOOL TryGet(T** pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		if(!IsValid() || !HasGetSpace(m_seqGet))
+			return FALSE;
+
+		{
+			CLocalLock<_GetGuard> locallock(m_csGet);
+
+			ULONGLONG seqGet = m_seqGet;
+
+			if(!IsValid() || !HasGetSpace(seqGet))
+				return FALSE;
+
+			DoGet(pElement, seqGet);
+		}
+
+		return TRUE;
+	}
+
+	BOOL GetBatch(T* pElements[], int& iCount)
+	{
+		ASSERT(pElements != nullptr && iCount > 0);
+
+		{
+			CLocalLock<_GetGuard> locallock(m_csGet);
+
+			ULONGLONG seqGet = m_seqGet;
+
+			for(int i = 0; i < iCount; ++i)
+			{
+				WaitForGet(seqGet);
+
+				if(!IsValid())
+				{
+					iCount = i;
+					return FALSE;
+				}
+
+				DoGet(pElements + i, seqGet);
+			}
+		}
+
+		return TRUE;
+	}
+
+	BOOL TryGetBatch(T* pElements[], int& iCount)
+	{
+		ASSERT(pElements != nullptr && iCount > 0);
+
+		if(!IsValid() || !HasGetSpace(m_seqGet))
+		{
+			iCount = 0;
+			return FALSE;
+		}
+
+		{
+			CLocalLock<_GetGuard> locallock(m_csGet);
+
+			ULONGLONG seqGet = m_seqGet;
+
+			for(int i = 0; i < iCount; ++i)
+			{
+				if(!IsValid() || !HasGetSpace(seqGet))
+				{
+					iCount = i;
+					return FALSE;
+				}
+
+				DoGet(pElements + i, seqGet);
+			}
+		}
+
+		return TRUE;
+	}
+
+	BOOL Peek(T** pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		ULONGLONG seqGet = m_seqGet;
+
+		if(!IsValid() || !HasGetSpace(seqGet))
+			return FALSE;
+
+		DoPeek(pElement, seqGet);
+
+		return TRUE;
+	}
+
+private:
+	void DoPut(T* pElement, ULONGLONG& seqPut)
+	{
+		DWORD index = seqPut & (m_dwReal - 1);
+		*(m_pv + index)	= pElement;
+
+		++seqPut;
+		m_seqPut = seqPut;
+	}
+
+	void DoGet(T** pElement, ULONGLONG& seqGet)
+	{
+		DWORD index = seqGet & (m_dwReal - 1);
+		*(pElement) = *(m_pv + index);
+
+		++seqGet;
+		m_seqGet = seqGet;
+	}
+
+	void DoPeek(T** pElement, ULONGLONG& seqGet)
+	{
+		DWORD index = seqGet & (m_dwReal - 1);
+		*(pElement) = *(m_pv + index);
+	}
+
+	BOOL HasPutSpace(ULONGLONG seqPut)
+	{
+		return (seqPut - m_seqGet < m_dwReal);
+	}
+
+	void WaitForPut(ULONGLONG seqPut)
+	{
+		for(DWORD w = 0; IsValid(); ++w)
+		{
+			if(HasPutSpace(seqPut))
+				break;
+
+			::YieldThread(w);
+		}
+	}
+
+	BOOL HasGetSpace(ULONGLONG seqGet)
+	{
+		return (m_seqPut - seqGet > 0);
+	}
+
+	void WaitForGet(ULONGLONG seqGet)
+	{
+		for(DWORD w = 0; IsValid(); ++w)
+		{
+			if(HasGetSpace(seqGet))
+				break;
+
+			::YieldThread(w);
+		}
+	}
+
+	DWORD Revise(DWORD dwExpect)
+	{
+		int index = 0;
+		int shift = sizeof(DWORD) * 8 - 1;
+
+		for(int i = shift; i >= 0; i--)
+		{
+			if(index == 0)
+			{
+				if(dwExpect & (1 << i))
+				{
+					index = i;
+
+					if(index == shift)
+						break;
+				}
+			}
+			else
+			{
+				if(dwExpect & (1 << i))
+					++index;
+
+				break;
+			}
+		}
+
+		return 1 << index;
+	}
+
+public:
+	CRingBuffer(DWORD uiExpect = DEFAULT_EXPECT)
+	: m_pv(nullptr)
+	, m_dwReal(0)
+	, m_seqPut(0)
+	, m_seqGet(0)
+	{
+		Reset(uiExpect);
+	}
+
+	~CRingBuffer()
+	{
+		Reset(0);
+	}
+
+	void Reset(DWORD uiExpect = DEFAULT_EXPECT)
+	{
+		if(IsValid())
+			Destroy();
+		if(uiExpect > 0)
+			Create(uiExpect);
+	}
+
+	BOOL IsValid() {return m_pv != nullptr;}
+
+private:
+	void Create(DWORD dwExpect = DEFAULT_EXPECT)
+	{
+		ASSERT(!IsValid() && dwExpect > 0);
+
+		m_seqPut = 0;
+		m_seqGet = 0;
+		m_dwReal = Revise(dwExpect);
+		m_pv	 = (T**)malloc(m_dwReal * sizeof(T*));
+	}
+
+	void Destroy()
+	{
+		ASSERT(IsValid());
+
+		CLocalLock<_PutGuard> locallock1(m_csPut);
+		CLocalLock<_GetGuard> locallock2(m_csGet);
+
+		free((void*)m_pv);
+		m_pv	 = nullptr;
+		m_dwReal = 0;
+		m_seqPut = 0;
+		m_seqGet = 0;
+	}
+
+private:
+	CRingBuffer(const CRingBuffer&);
+	CRingBuffer operator = (const CRingBuffer&);
+
+private:
+	DWORD				m_dwReal;
+	T**					m_pv;
+	char				pack1[PACK_SIZE_OF(T**)];
+	volatile ULONGLONG	m_seqPut;
+	char				pack4[PACK_SIZE_OF(ULONGLONG)];
+	volatile ULONGLONG	m_seqGet;
+	char				pack5[PACK_SIZE_OF(ULONGLONG)];
+	_PutGuard			m_csPut;
+	char				pack2[PACK_SIZE_OF(_PutGuard)];
+	_GetGuard			m_csGet;
+	char				pack3[PACK_SIZE_OF(_GetGuard)];
+};
+
+typedef CRingBuffer<void, CCriSec, CCriSec>				CCSRingBuffer;
+typedef CRingBuffer<void, CInterCriSec, CInterCriSec>	CICSRingBuffer;
+typedef CRingBuffer<void, CSpinGuard, CSpinGuard>		CSGRingBuffer;
+typedef CRingBuffer<void, CFakeGuard, CFakeGuard>		CFKRingBuffer;
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+template <class T, class index_type = DWORD, bool adjust_index = false> class CRingCache
+{
+public:
+
+	enum EnGetResult {GR_FAIL = -1, GR_INVALID = 0, GR_VALID = 1};
+
+	typedef T*									TPTR;
+	typedef volatile T*							VTPTR;
+
+	typedef unordered_set<index_type>			IndexSet;
+	typedef typename IndexSet::const_iterator	IndexSetCI;
+	typedef typename IndexSet::iterator			IndexSetI;
+
+	static TPTR const E_EMPTY;
+	static TPTR const E_LOCKED;
+	static TPTR const E_MAX_STATUS;
+
+public:
+
+	static index_type& INDEX_INC(index_type& dwIndex)	{if(adjust_index) ++dwIndex; return dwIndex;}
+	static index_type& INDEX_DEC(index_type& dwIndex)	{if(adjust_index) --dwIndex; return dwIndex;}
+
+private:
+
+	VTPTR& INDEX_VAL(index_type dwIndex) {return *(m_pv + dwIndex);}
+
+public:
+
+	BOOL Put(TPTR pElement, index_type& dwIndex)
+	{
+		ASSERT(pElement != nullptr);
+
+		if(!IsValid()) return FALSE;
+
+		BOOL isOK = FALSE;
+
+		while(true)
+		{
+			if(!HasSpace())
+				break;
+
+			DWORD dwCurSeq			= m_dwCurSeq;
+			index_type dwCurIndex	= dwCurSeq % m_dwSize;
+			VTPTR& pValue			= INDEX_VAL(dwCurIndex);
+
+			if(pValue == E_EMPTY)
+			{
+				if(::InterlockedCompareExchangePointer((volatile PVOID*)&pValue, pElement, E_EMPTY) == E_EMPTY)
+				{
+					::InterlockedIncrement(&m_dwCount);
+					::InterlockedCompareExchange(&m_dwCurSeq, dwCurSeq + 1, dwCurSeq);
+
+					dwIndex = INDEX_INC(dwCurIndex);
+					isOK	= TRUE;
+
+					if(pElement != E_LOCKED)
+						EmplaceIndex(dwIndex);
+
+					break;
+				}
+			}
+
+			::InterlockedCompareExchange(&m_dwCurSeq, dwCurSeq + 1, dwCurSeq);
+		}
+
+		return isOK;
+	}
+
+	EnGetResult Get(index_type dwIndex, TPTR* ppElement)
+	{
+		ASSERT(dwIndex <= m_dwSize);
+		ASSERT(ppElement != nullptr);
+
+		if(!IsValid() || INDEX_DEC(dwIndex) >= m_dwSize)
+		{
+			*ppElement = nullptr;
+			return GR_FAIL;
+		}
+
+		*ppElement = (TPTR)INDEX_VAL(dwIndex);
+
+		return IsValidElement(*ppElement) ? GR_VALID : GR_INVALID;
+	}
+
+	BOOL Set(index_type dwIndex, TPTR pElement, TPTR* ppOldElement = nullptr)
+	{
+		TPTR pElement2 = nullptr;
+
+		if(Get(dwIndex, &pElement2) == GR_FAIL)
+			return FALSE;
+
+		if(ppOldElement != nullptr)
+			*ppOldElement = pElement2;
+
+		if(pElement == pElement2)
+			return FALSE;
+
+		int f1 = 0;
+		int f2 = 0;
+
+		if(pElement == E_EMPTY)
+		{
+			if(pElement2 == E_LOCKED)
+				f1 = -1;
+			else
+				f1 = f2 = -1;
+		}
+		else if(pElement == E_LOCKED)
+		{
+			if(pElement2 == E_EMPTY)
+				f1 = 1;
+			else
+				f2 = -1;
+		}
+		else
+		{
+			if(pElement2 == E_EMPTY)
+				f1 = f2 = 1;
+			else if(pElement2 == E_LOCKED)
+				f2 = 1;
+		}
+
+		BOOL bSetValueFirst		= (f1 + f2 >= 0);
+		index_type dwOuterIndex	= dwIndex;
+
+		INDEX_DEC(dwIndex);
+
+		if(bSetValueFirst)	INDEX_VAL(dwIndex) = pElement;
+		if(f1 > 0)			::InterlockedIncrement(&m_dwCount);
+		if(f2 != 0)			(f2 > 0) ? EmplaceIndex(dwOuterIndex) : EraseIndex(dwOuterIndex);
+		if(f1 < 0)			::InterlockedDecrement(&m_dwCount);
+		if(!bSetValueFirst) INDEX_VAL(dwIndex) = pElement;
+
+		ASSERT(Spaces() <= Size());
+
+		return TRUE;
+	}
+
+	BOOL Remove(index_type dwIndex, TPTR* ppElement = nullptr)
+	{
+		return Set(dwIndex, E_EMPTY, ppElement);
+	}
+
+	BOOL AcquireLock(index_type& dwIndex)
+	{
+		return Put(E_LOCKED, dwIndex);
+	}
+
+	BOOL ReleaseLock(index_type dwIndex, TPTR pElement)
+	{
+		ASSERT(pElement == nullptr || IsValidElement(pElement));
+
+		TPTR pElement2 = nullptr;
+		Get(dwIndex, &pElement2);
+
+		ASSERT(pElement2 == E_LOCKED);
+
+		if(pElement2 != E_LOCKED)
+			return FALSE;
+
+		return Set(dwIndex, pElement);
+	}
+
+public:
+
+	void Reset(DWORD dwSize = 0)
+	{
+		if(IsValid())
+			Destroy();
+		if(dwSize > 0)
+			Create(dwSize);
+	}
+	
+	BOOL GetAllElementIndexes(index_type ids[], DWORD& dwCount, BOOL bCopy = TRUE)
+	{
+		if(ids == nullptr || dwCount == 0)
+		{
+			dwCount = Elements();
+			return FALSE;
+		}
+
+		IndexSet* pIndexes = nullptr;
+		IndexSet indexes;
+
+		if(bCopy)
+			pIndexes = &CopyIndexes(indexes);
+		else
+			pIndexes = &m_indexes;
+
+		BOOL isOK	 = FALSE;
+		DWORD dwSize = (DWORD)pIndexes->size();
+
+		if(dwSize > 0 && dwSize <= dwCount)
+		{
+			IndexSetCI it  = pIndexes->begin();
+			IndexSetCI end = pIndexes->end();
+
+			for(int i = 0; it != end; ++it, ++i)
+				ids[i] = *it;
+
+			isOK = TRUE;
+		}
+
+		dwCount = dwSize;
+		return isOK;
+	}
+	
+	unique_ptr<index_type[]> GetAllElementIndexes(DWORD& dwCount, BOOL bCopy = TRUE)
+	{
+		IndexSet* pIndexes = nullptr;
+		IndexSet indexes;
+
+		if(bCopy)
+			pIndexes = &CopyIndexes(indexes);
+		else
+			pIndexes = &m_indexes;
+
+		unique_ptr<index_type[]> ids;
+		dwCount = (DWORD)pIndexes->size();
+
+		if(dwCount > 0)
+		{
+			ids.reset(new index_type[dwCount]);
+
+			IndexSetCI it  = pIndexes->begin();
+			IndexSetCI end = pIndexes->end();
+
+			for(int i = 0; it != end; ++it, ++i)
+				ids[i] = *it;
+		}
+
+		return ids;
+	}
+
+	static BOOL IsValidElement(TPTR pElement) {return pElement > E_MAX_STATUS;}
+
+	DWORD Size		()	{return m_dwSize;}
+	DWORD Elements	()	{return (DWORD)m_indexes.size();}
+	DWORD Spaces	()	{return m_dwSize - m_dwCount;}
+	BOOL HasSpace	()	{return m_dwCount < m_dwSize;}
+	BOOL IsEmpty	()	{return m_dwCount == 0;}
+	BOOL IsValid	()	{return m_pv != nullptr;}
+
+private:
+
+	void Create(DWORD dwSize)
+	{
+		ASSERT(!IsValid() && dwSize > 0);
+
+		m_dwCurSeq	= 0;
+		m_dwCount	= 0;
+		m_dwSize	= dwSize;
+		m_pv		= (VTPTR*)malloc(m_dwSize * sizeof(TPTR));
+
+		::ZeroMemory(m_pv, m_dwSize * sizeof(TPTR));
+	}
+
+	void Destroy()
+	{
+		ASSERT(IsValid());
+
+		m_indexes.clear();
+		free((void*)m_pv);
+
+		m_pv		= nullptr;
+		m_dwSize	= 0;
+		m_dwCount	= 0;
+		m_dwCurSeq	= 0;
+	}
+
+	IndexSet& CopyIndexes(IndexSet& indexes)
+	{
+		{
+			CReadLock locallock(m_cs);
+			indexes = m_indexes;
+		}
+
+		return indexes;
+	}
+
+	void EmplaceIndex(index_type dwIndex)
+	{
+		CWriteLock locallock(m_cs);
+		m_indexes.emplace(dwIndex);
+	}
+
+	void EraseIndex(index_type dwIndex)
+	{
+		CWriteLock locallock(m_cs);
+		m_indexes.erase(dwIndex);
+	}
+
+public:
+	CRingCache	(DWORD dwSize = 0)
+	: m_pv		(nullptr)
+	, m_dwSize	(0)
+	, m_dwCount	(0)
+	, m_dwCurSeq(0)
+	{
+		Reset(dwSize);
+	}
+
+	~CRingCache()
+	{
+		Reset(0);
+	}
+
+private:
+	CRingCache(const CRingCache&);
+	CRingCache operator = (const CRingCache&);
+
+private:
+	DWORD				m_dwSize;
+	VTPTR*				m_pv;
+	char				pack1[PACK_SIZE_OF(VTPTR*)];
+	volatile DWORD		m_dwCurSeq;
+	char				pack2[PACK_SIZE_OF(DWORD)];
+	volatile DWORD		m_dwCount;
+	char				pack3[PACK_SIZE_OF(DWORD)];
+
+	CSimpleRWLock		m_cs;
+	IndexSet			m_indexes;
+};
+
+template <class T, class index_type, bool adjust_index> T* const CRingCache<T, index_type, adjust_index>::E_EMPTY		= (T*)0x00;
+template <class T, class index_type, bool adjust_index> T* const CRingCache<T, index_type, adjust_index>::E_LOCKED		= (T*)0x01;
+template <class T, class index_type, bool adjust_index> T* const CRingCache<T, index_type, adjust_index>::E_MAX_STATUS	= (T*)0x0F;
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+template <class T, class index_type = DWORD, bool adjust_index = false> class CRingCache2
+{
+public:
+
+	enum EnGetResult {GR_FAIL = -1, GR_INVALID = 0, GR_VALID = 1};
+
+	typedef T*									TPTR;
+	typedef volatile T*							VTPTR;
+
+	typedef unordered_set<index_type>			IndexSet;
+	typedef typename IndexSet::const_iterator	IndexSetCI;
+	typedef typename IndexSet::iterator			IndexSetI;
+
+	static TPTR const E_EMPTY;
+	static TPTR const E_LOCKED;
+	static TPTR const E_MAX_STATUS;
+	static DWORD const MAX_SIZE;
+
+public:
+
+	static index_type& INDEX_INC(index_type& dwIndex)	{if(adjust_index) ++dwIndex; return dwIndex;}
+	static index_type& INDEX_DEC(index_type& dwIndex)	{if(adjust_index) --dwIndex; return dwIndex;}
+
+	index_type& INDEX_R2V(index_type& dwIndex)			{dwIndex += *(m_px + dwIndex) * m_dwSize; return dwIndex;}
+
+	BOOL INDEX_V2R(index_type& dwIndex)
+	{
+		index_type m = dwIndex % m_dwSize;
+		BYTE x		 = *(m_px + m);
+
+		if(dwIndex / m_dwSize != x)
+			return FALSE;
+
+		dwIndex = m;
+		return TRUE;
+	}
+
+
+private:
+
+	VTPTR& INDEX_VAL(index_type dwIndex) {return *(m_pv + dwIndex);}
+
+public:
+
+	BOOL Put(TPTR pElement, index_type& dwIndex)
+	{
+		ASSERT(pElement != nullptr);
+
+		if(!IsValid()) return FALSE;
+
+		BOOL isOK = FALSE;
+
+		while(true)
+		{
+			if(!HasSpace())
+				break;
+
+			DWORD dwCurSeq			= m_dwCurSeq;
+			index_type dwCurIndex	= dwCurSeq % m_dwSize;
+			VTPTR& pValue			= INDEX_VAL(dwCurIndex);
+
+			if(pValue == E_EMPTY)
+			{
+				if(::InterlockedCompareExchangePointer((volatile PVOID*)&pValue, pElement, E_EMPTY) == E_EMPTY)
+				{
+					::InterlockedIncrement(&m_dwCount);
+					::InterlockedCompareExchange(&m_dwCurSeq, dwCurSeq + 1, dwCurSeq);
+
+					dwIndex = INDEX_INC(INDEX_R2V(dwCurIndex));
+					isOK	= TRUE;
+
+					if(pElement != E_LOCKED)
+						EmplaceIndex(dwIndex);
+
+					break;
+				}
+			}
+
+			::InterlockedCompareExchange(&m_dwCurSeq, dwCurSeq + 1, dwCurSeq);
+		}
+
+		return isOK;
+	}
+
+	EnGetResult Get(index_type dwIndex, TPTR* ppElement, index_type* pdwRealIndex = nullptr)
+	{
+		ASSERT(ppElement != nullptr);
+
+		if(!IsValid() || !INDEX_V2R(INDEX_DEC(dwIndex)))
+		{
+			*ppElement = nullptr;
+			return GR_FAIL;
+		}
+
+		*ppElement = (TPTR)INDEX_VAL(dwIndex);
+		if(pdwRealIndex) *pdwRealIndex = dwIndex;
+
+		return IsValidElement(*ppElement) ? GR_VALID : GR_INVALID;
+	}
+
+	BOOL Set(index_type dwIndex, TPTR pElement, TPTR* ppOldElement = nullptr, index_type* pdwRealIndex = nullptr)
+	{
+		TPTR pElement2 = nullptr;
+
+		if(pdwRealIndex == nullptr)
+			pdwRealIndex = (index_type*)_alloca(sizeof(index_type));
+
+		if(Get(dwIndex, &pElement2, pdwRealIndex) == GR_FAIL)
+			return FALSE;
+
+		if(ppOldElement != nullptr)
+			*ppOldElement = pElement2;
+
+		if(pElement == pElement2)
+			return FALSE;
+
+		int f1 = 0;
+		int f2 = 0;
+
+		if(pElement == E_EMPTY)
+		{
+			if(pElement2 == E_LOCKED)
+				f1 = -1;
+			else
+				f1 = f2 = -1;
+		}
+		else if(pElement == E_LOCKED)
+		{
+			if(pElement2 == E_EMPTY)
+				f1 = 1;
+			else
+				f2 = -1;
+		}
+		else
+		{
+			if(pElement2 == E_EMPTY)
+				f1 = f2 = 1;
+			else if(pElement2 == E_LOCKED)
+				f2 = 1;
+		}
+
+		BOOL bSetValueFirst		= (f1 + f2 >= 0);
+		index_type dwRealIndex	= *pdwRealIndex;
+
+		if(bSetValueFirst)	INDEX_VAL(dwRealIndex) = pElement;
+		if(f1 > 0)			::InterlockedIncrement(&m_dwCount);
+		if(f2 != 0)			(f2 > 0) ? EmplaceIndex(dwIndex) : EraseIndex(dwIndex);
+		if(f1 < 0)			{::InterlockedDecrement(&m_dwCount); ++(*(m_px + dwRealIndex));}
+		if(!bSetValueFirst) INDEX_VAL(dwRealIndex) = pElement;
+
+		ASSERT(Spaces() <= Size());
+
+		return TRUE;
+	}
+
+	BOOL Remove(index_type dwIndex, TPTR* ppElement = nullptr)
+	{
+		return Set(dwIndex, E_EMPTY, ppElement);
+	}
+
+	BOOL AcquireLock(index_type& dwIndex)
+	{
+		return Put(E_LOCKED, dwIndex);
+	}
+
+	BOOL ReleaseLock(index_type dwIndex, TPTR pElement)
+	{
+		ASSERT(pElement == nullptr || IsValidElement(pElement));
+
+		TPTR pElement2 = nullptr;
+		Get(dwIndex, &pElement2);
+
+		ASSERT(pElement2 == E_LOCKED);
+
+		if(pElement2 != E_LOCKED)
+			return FALSE;
+
+		return Set(dwIndex, pElement);
+	}
+
+public:
+
+	void Reset(DWORD dwSize = 0)
+	{
+		if(IsValid())
+			Destroy();
+		if(dwSize > 0)
+			Create(dwSize);
+	}
+	
+	BOOL GetAllElementIndexes(index_type ids[], DWORD& dwCount, BOOL bCopy = TRUE)
+	{
+		if(ids == nullptr || dwCount == 0)
+		{
+			dwCount = Elements();
+			return FALSE;
+		}
+
+		IndexSet* pIndexes = nullptr;
+		IndexSet indexes;
+
+		if(bCopy)
+			pIndexes = &CopyIndexes(indexes);
+		else
+			pIndexes = &m_indexes;
+
+		BOOL isOK	 = FALSE;
+		DWORD dwSize = (DWORD)pIndexes->size();
+
+		if(dwSize > 0 && dwSize <= dwCount)
+		{
+			IndexSetCI it  = pIndexes->begin();
+			IndexSetCI end = pIndexes->end();
+
+			for(int i = 0; it != end; ++it, ++i)
+				ids[i] = *it;
+
+			isOK = TRUE;
+		}
+
+		dwCount = dwSize;
+
+		return isOK;
+	}
+	
+	unique_ptr<index_type[]> GetAllElementIndexes(DWORD& dwCount, BOOL bCopy = TRUE)
+	{
+		IndexSet* pIndexes = nullptr;
+		IndexSet indexes;
+
+		if(bCopy)
+			pIndexes = &CopyIndexes(indexes);
+		else
+			pIndexes = &m_indexes;
+
+		unique_ptr<index_type[]> ids;
+		dwCount = (DWORD)pIndexes->size();
+
+		if(dwCount > 0)
+		{
+			ids.reset(new index_type[dwCount]);
+
+			IndexSetCI it  = pIndexes->begin();
+			IndexSetCI end = pIndexes->end();
+
+			for(int i = 0; it != end; ++it, ++i)
+				ids[i] = *it;
+		}
+
+		return ids;
+	}
+
+	static BOOL IsValidElement(TPTR pElement) {return pElement > E_MAX_STATUS;}
+
+	DWORD Size		()	{return m_dwSize;}
+	DWORD Elements	()	{return (DWORD)m_indexes.size();}
+	DWORD Spaces	()	{return m_dwSize - m_dwCount;}
+	BOOL HasSpace	()	{return m_dwCount < m_dwSize;}
+	BOOL IsEmpty	()	{return m_dwCount == 0;}
+	BOOL IsValid	()	{return m_pv != nullptr;}
+
+private:
+
+	void Create(DWORD dwSize)
+	{
+		ASSERT(!IsValid() && dwSize > 0 && dwSize <= MAX_SIZE);
+
+		m_dwCurSeq	= 0;
+		m_dwCount	= 0;
+		m_dwSize	= dwSize;
+		m_pv		= (VTPTR*)malloc(m_dwSize * sizeof(TPTR));
+		m_px		= (BYTE*)malloc(m_dwSize * sizeof(BYTE));
+
+		::ZeroMemory(m_pv, m_dwSize * sizeof(TPTR));
+		::ZeroMemory(m_px, m_dwSize * sizeof(BYTE));
+	}
+
+	void Destroy()
+	{
+		ASSERT(IsValid());
+
+		m_indexes.clear();
+		free((void*)m_pv);
+		free((void*)m_px);
+
+		m_pv		= nullptr;
+		m_px		= nullptr;
+		m_dwSize	= 0;
+		m_dwCount	= 0;
+		m_dwCurSeq	= 0;
+	}
+
+	IndexSet& CopyIndexes(IndexSet& indexes)
+	{
+		{
+			CReadLock locallock(m_cs);
+			indexes = m_indexes;
+		}
+
+		return indexes;
+	}
+
+	void EmplaceIndex(index_type dwIndex)
+	{
+		CWriteLock locallock(m_cs);
+		m_indexes.emplace(dwIndex);
+	}
+
+	void EraseIndex(index_type dwIndex)
+	{
+		CWriteLock locallock(m_cs);
+		m_indexes.erase(dwIndex);
+	}
+
+public:
+	CRingCache2	(DWORD dwSize = 0)
+	: m_pv		(nullptr)
+	, m_px		(nullptr)
+	, m_dwSize	(0)
+	, m_dwCount	(0)
+	, m_dwCurSeq(0)
+	{
+		Reset(dwSize);
+	}
+
+	~CRingCache2()
+	{
+		Reset(0);
+	}
+
+private:
+	CRingCache2(const CRingCache2&);
+	CRingCache2 operator = (const CRingCache2&);
+
+private:
+	DWORD				m_dwSize;
+	VTPTR*				m_pv;
+	char				pack1[PACK_SIZE_OF(VTPTR*)];
+	BYTE*				m_px;
+	char				pack2[PACK_SIZE_OF(BYTE*)];
+	volatile DWORD		m_dwCurSeq;
+	char				pack3[PACK_SIZE_OF(DWORD)];
+	volatile DWORD		m_dwCount;
+	char				pack4[PACK_SIZE_OF(DWORD)];
+
+	CSimpleRWLock		m_cs;
+	IndexSet			m_indexes;
+};
+
+template <class T, class index_type, bool adjust_index> T* const CRingCache2<T, index_type, adjust_index>::E_EMPTY		= (T*)0x00;
+template <class T, class index_type, bool adjust_index> T* const CRingCache2<T, index_type, adjust_index>::E_LOCKED		= (T*)0x01;
+template <class T, class index_type, bool adjust_index> T* const CRingCache2<T, index_type, adjust_index>::E_MAX_STATUS	= (T*)0x0F;
+
+template <class T, class index_type, bool adjust_index> DWORD const CRingCache2<T, index_type, adjust_index>::MAX_SIZE	= 
+#if !defined(_WIN64)
+																														  0x00FFFFFF
+#else
+																														  0xFFFFFFFF
+#endif
+																																	;
+// ------------------------------------------------------------------------------------------------------------- //
+
+template <class T> class CRingPool
+{
+private:
+
+	typedef T*			TPTR;
+	typedef volatile T*	VTPTR;
+
+	static TPTR const E_EMPTY;
+	static TPTR const E_LOCKED;
+	static TPTR const E_RELEASED;
+	static TPTR const E_OCCUPIED;
+	static TPTR const E_MAX_STATUS;
+
+private:
+
+	VTPTR& INDEX_VAL(DWORD dwIndex) {return *(m_pv + dwIndex);}
+
+public:
+
+	BOOL TryPut(TPTR pElement)
+	{
+		ASSERT(pElement != nullptr);
+
+		if(!IsValid()) return FALSE;
+
+		BOOL isOK = FALSE;
+
+		while(true)
+		{
+			BOOL bOccupy = FALSE;
+			DWORD seqPut = m_seqPut;
+
+			if(!HasPutSpace(seqPut))
+				break;
+
+			DWORD dwIndex = seqPut % m_dwSize;
+			VTPTR& pValue = INDEX_VAL(dwIndex);
+
+			if(pValue == E_RELEASED)
+			{
+				if(::InterlockedCompareExchangePointer((volatile PVOID*)&pValue, E_OCCUPIED, E_RELEASED) == E_RELEASED)
+					bOccupy = TRUE;
+				else
+					continue;
+			}
+
+			if(pValue == E_EMPTY || bOccupy)
+			{
+				if(::InterlockedCompareExchange(&m_seqPut, seqPut + 1, seqPut) == seqPut)
+				{
+					pValue	= pElement;
+					isOK	= TRUE;
+
+					break;
+				}
+			}
+			else if(pValue == E_LOCKED)
+				break;
+		}
+
+		return isOK;
+	}
+
+	BOOL TryGet(TPTR* ppElement)
+	{
+		ASSERT(ppElement != nullptr);
+
+		if(!IsValid()) return FALSE;
+
+		BOOL isOK = FALSE;
+
+		while(true)
+		{
+			DWORD seqGet = m_seqGet;
+
+			if(!HasGetSpace(seqGet))
+				break;
+
+			DWORD dwIndex = seqGet % m_dwSize;
+			VTPTR& pValue = INDEX_VAL(dwIndex);
+
+			if(pValue == E_LOCKED)
+				break;
+			else if(pValue != E_EMPTY && pValue != E_RELEASED && pValue != E_OCCUPIED)
+			{
+				if(::InterlockedCompareExchange(&m_seqGet, seqGet + 1, seqGet) == seqGet)
+				{
+					ASSERT(pValue > E_MAX_STATUS);
+
+					*(ppElement)	= (TPTR)pValue;
+					pValue			= E_EMPTY;
+					isOK			= TRUE;
+
+					break;
+				}
+			}
+		}
+
+		return isOK;
+	}
+
+	BOOL TryLock(TPTR* ppElement, DWORD& dwIndex)
+	{
+		ASSERT(ppElement != nullptr);
+
+		if(!IsValid()) return FALSE;
+
+		BOOL isOK = FALSE;
+
+		while(true)
+		{
+			DWORD seqGet = m_seqGet;
+
+			if(!HasGetSpace(seqGet))
+				break;
+
+			dwIndex			= seqGet % m_dwSize;
+			VTPTR& pValue	= INDEX_VAL(dwIndex);
+
+			if(pValue == E_LOCKED)
+				break;
+			else if(pValue != E_EMPTY && pValue != E_RELEASED && pValue != E_OCCUPIED)
+			{
+				if(::InterlockedCompareExchange(&m_seqGet, seqGet + 1, seqGet) == seqGet)
+				{
+					ASSERT(pValue > E_MAX_STATUS);
+
+					*(ppElement)	= (TPTR)pValue;
+					pValue			= E_LOCKED;
+					isOK			= TRUE;
+
+					break;
+				}
+			}
+		}
+
+		return isOK;
+	}
+
+	BOOL ReleaseLock(TPTR pElement, DWORD dwIndex)
+	{
+		ASSERT(dwIndex < m_dwSize);
+		ASSERT(pElement == nullptr || pElement > E_MAX_STATUS);
+
+		if(!IsValid()) return FALSE;
+
+		VTPTR& pValue = INDEX_VAL(dwIndex);
+		VERIFY(pValue == E_LOCKED);
+
+		if(pElement != nullptr)
+		{
+			for(DWORD i = 0; ; i++)
+			{
+				if(TryPut(pElement))
+					break;
+
+				DWORD dwPutIndex = m_seqPut % m_dwSize;
+
+				if(dwIndex == dwPutIndex)
+				{
+					pValue = pElement;
+					::InterlockedIncrement(&m_seqPut);
+
+					return TRUE;
+				}
+
+				::YieldThread(i);
+			}
+		}
+
+		pValue = E_RELEASED;
+
+		return TRUE;
+	}
+
+public:
+
+	void Reset(DWORD dwSize = 0)
+	{
+		if(IsValid())
+			Destroy();
+		if(dwSize > 0)
+			Create(dwSize);
+	}
+
+	DWORD Size()		{return m_dwSize;}
+	DWORD Elements()	{return m_seqPut - m_seqGet;}
+	BOOL IsFull()		{return Elements() == Size();}
+	BOOL IsEmpty()		{return Elements() == 0;}
+	BOOL IsValid()		{return m_pv != nullptr;}
+
+private:
+
+	BOOL HasPutSpace(DWORD seqPut)
+	{
+		return ((int)(seqPut - m_seqGet) < (int)m_dwSize);
+	}
+
+	BOOL HasGetSpace(DWORD seqGet)
+	{
+		return ((int)(m_seqPut - seqGet) > 0);
+	}
+
+	void Create(DWORD dwSize)
+	{
+		ASSERT(!IsValid() && dwSize > 0);
+
+		m_seqPut = 0;
+		m_seqGet = 0;
+		m_dwSize = dwSize;
+		m_pv	 = (VTPTR*)malloc(m_dwSize * sizeof(TPTR));
+
+		::ZeroMemory(m_pv, m_dwSize * sizeof(TPTR));
+	}
+
+	void Destroy()
+	{
+		ASSERT(IsValid());
+
+		free((void*)m_pv);
+		m_pv = nullptr;
+		m_dwSize = 0;
+		m_seqPut = 0;
+		m_seqGet = 0;
+	}
+
+public:
+	CRingPool(DWORD dwSize = 0)
+	: m_pv(nullptr)
+	, m_dwSize(0)
+	, m_seqPut(0)
+	, m_seqGet(0)
+	{
+		Reset(dwSize);
+	}
+
+	~CRingPool()
+	{
+		Reset(0);
+	}
+
+private:
+	CRingPool(const CRingPool&);
+	CRingPool operator = (const CRingPool&);
+
+private:
+	DWORD				m_dwSize;
+	VTPTR*				m_pv;
+	char				pack1[PACK_SIZE_OF(VTPTR*)];
+	volatile DWORD		m_seqPut;
+	char				pack2[PACK_SIZE_OF(DWORD)];
+	volatile DWORD		m_seqGet;
+	char				pack3[PACK_SIZE_OF(DWORD)];
+};
+
+template <class T> T* const CRingPool<T>::E_EMPTY		= (T*)0x00;
+template <class T> T* const CRingPool<T>::E_LOCKED		= (T*)0x01;
+template <class T> T* const CRingPool<T>::E_RELEASED	= (T*)0x02;
+template <class T> T* const CRingPool<T>::E_OCCUPIED	= (T*)0x03;
+template <class T> T* const CRingPool<T>::E_MAX_STATUS	= (T*)0x0F;
+
+// ------------------------------------------------------------------------------------------------------------- //
+
+template <class T> class CCASQueue
+{
+private:
+	struct Node;
+	typedef Node*			NPTR;
+	typedef volatile Node*	VNPTR;
+	typedef volatile ULONG	VLONG;
+
+	struct Node
+	{
+		T*		pValue;
+		VNPTR	pNext;
+
+		Node(T* val, NPTR next = nullptr)
+			: pValue(val), pNext(next)
+		{
+
+		}
+	};
+
+public:
+
+	void PushBack(T* pVal)
+	{
+		ASSERT(pVal != nullptr);
+
+		VNPTR pTail	= nullptr;
+		NPTR pNode	= new Node(pVal);
+
+		while(true)
+		{
+			pTail = m_pTail;
+
+			if(::InterlockedCompareExchangePointer((volatile PVOID*)&m_pTail, (PVOID)pNode, (PVOID)pTail) == pTail)
+			{
+				pTail->pNext = pNode;
+				break;
+			}
+		}
+
+		::InterlockedIncrement(&m_lSize);
+	}
+
+	void UnsafePushBack(T* pVal)
+	{
+		ASSERT(pVal != nullptr);
+
+		NPTR pNode		= new Node(pVal);
+		m_pTail->pNext	= pNode;
+		m_pTail			= pNode;
+		
+		::InterlockedIncrement(&m_lSize);
+	}
+
+	BOOL PopFront(T** ppVal)
+	{
+		ASSERT(ppVal != nullptr);
+
+		if(IsEmpty())
+			return FALSE;
+
+		BOOL isOK	= FALSE;
+		NPTR pHead	= nullptr;
+		NPTR pNext	= nullptr;
+		T* pVal		= nullptr;
+
+		while(true)
+		{
+			while(::InterlockedCompareExchange(&m_lLock, 1, 0) != 0)
+				::YieldProcessor();
+
+			pHead = (NPTR)m_pHead;
+			pNext = (NPTR)pHead->pNext;
+
+			if(pNext == nullptr)
+			{
+				m_lLock = 0;
+				break;
+			}
+
+			*ppVal	= pNext->pValue;
+			m_pHead	= pNext;
+
+			m_lLock = 0;
+			isOK	= TRUE;
+
+			::InterlockedDecrement(&m_lSize);
+
+			delete pHead;
+			break;
+		}
+
+		return isOK;
+	}
+
+	BOOL UnsafePopFront(T** ppVal)
+	{
+		if(!UnsafePeekFront(ppVal))
+			return FALSE;
+
+		NPTR pHead	= (NPTR)m_pHead;
+		NPTR pNext	= (NPTR)pHead->pNext;
+		m_pHead		= pNext;
+
+		::InterlockedDecrement(&m_lSize);
+
+		delete pHead;
+		return TRUE;
+	}
+
+	BOOL UnsafePeekFront(T** ppVal)
+	{
+		ASSERT(ppVal != nullptr);
+
+		NPTR pNext = (NPTR)m_pHead->pNext;
+
+		if(pNext == nullptr)
+			return FALSE;
+
+		*ppVal = pNext->pValue;
+
+		return TRUE;
+	}
+
+public:
+
+	ULONG Size()	{return m_lSize;}
+	BOOL IsEmpty()	{return m_lSize == 0;}
+
+public:
+
+	CCASQueue() : m_lLock(0), m_lSize(0)
+	{
+		NPTR pHead = new Node(nullptr);
+		m_pHead = m_pTail = pHead;
+	}
+
+	~CCASQueue()
+	{
+		ASSERT(m_lLock == 0);
+		ASSERT(m_lSize == 0);
+		ASSERT(m_pHead != nullptr);
+		ASSERT(m_pHead->pNext == nullptr);
+
+		while(m_pHead != nullptr)
+		{
+			VNPTR pNode = m_pHead->pNext;
+
+			delete m_pHead;
+			m_pHead = pNode;
+		}
+	}
+
+private:
+	VLONG	m_lLock;
+	VLONG	m_lSize;
+	VNPTR	m_pHead;
+	VNPTR	m_pTail;
+};
+
+#if !defined (_WIN64)
+	#pragma pack(pop)
+#endif

socket/common/Src/STLHelper.h

@@ -0,0 +1,1241 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "GeneralHelper.h"
+
+#include <memory>
+#include <string>
+#include <functional>
+#include <algorithm>
+#include <vector>
+#include <deque>
+#include <queue>
+#include <stack>
+#include <list>
+#include <set>
+#include <map>
+#if _MSC_VER >= 1500
+	#include <unordered_set>
+	#include <unordered_map>
+
+	#define hash_set			unordered_set
+	#define hash_map			unordered_map
+	#define hash_multimap		unordered_multimap
+#else
+	#include <hash_set>
+	#include <hash_map>
+
+	#define unordered_set		hash_set
+	#define unordered_map		hash_map
+	#define unordered_multimap	hash_multimap
+#endif
+
+
+using namespace std;
+using namespace stdext;
+using namespace std::tr1;
+
+typedef	wstring		CStdStringW;
+typedef string		CStdStringA;
+
+#ifdef _UNICODE
+	typedef	CStdStringW		CStdString;
+#else
+	typedef CStdStringA		CStdString;
+#endif
+
+typedef list<short>						short_list;
+typedef list<int>						int_list;
+typedef list<long>						long_list;
+typedef list<__int64>					int64_list;
+typedef list<unsigned short>			ushort_list;
+typedef list<unsigned int>				uint_list;
+typedef list<unsigned long>				ulong_list;
+typedef list<unsigned __int64>			uint64_list;
+typedef list<float>						float_list;
+typedef list<double>					double_list;
+typedef stack<short>					short_stack;
+typedef stack<int>						int_stack;
+typedef stack<long>						long_stack;
+typedef stack<__int64>					int64_stack;
+typedef stack<unsigned short>			ushort_stack;
+typedef stack<unsigned int>				uint_stack;
+typedef stack<unsigned long>			ulong_stack;
+typedef stack<unsigned __int64>			uint64_stack;
+typedef stack<float>					float_stack;
+typedef stack<double>					double_stack;
+typedef queue<short>					short_queue;
+typedef queue<int>						int_queue;
+typedef queue<long>						long_queue;
+typedef queue<__int64>					int64_queue;
+typedef queue<unsigned short>			ushort_queue;
+typedef queue<unsigned int>				uint_queue;
+typedef queue<unsigned long>			ulong_queue;
+typedef queue<unsigned __int64>			uint64_queue;
+typedef queue<float>					float_queue;
+typedef queue<double>					double_queue;
+typedef deque<short>					short_deque;
+typedef deque<int>						int_deque;
+typedef deque<long>						long_deque;
+typedef deque<__int64>					int64_deque;
+typedef deque<unsigned short>			ushort_deque;
+typedef deque<unsigned int>				uint_deque;
+typedef deque<unsigned long>			ulong_deque;
+typedef deque<unsigned __int64>			uint64_deque;
+typedef deque<float>					float_deque;
+typedef deque<double>					double_deque;
+typedef vector<short>					short_vector;
+typedef vector<int>						int_vector;
+typedef vector<long>					long_vector;
+typedef vector<__int64>					int64_vector;
+typedef vector<unsigned short>			ushort_vector;
+typedef vector<unsigned int>			uint_vector;
+typedef vector<unsigned long>			ulong_vector;
+typedef vector<unsigned __int64>		uint64_vector;
+typedef vector<float>					float_vector;
+typedef vector<double>					double_vector;
+typedef set<short>						short_set;
+typedef set<int>						int_set;
+typedef set<long>						long_set;
+typedef set<__int64>					int64_set;
+typedef set<unsigned short>				ushort_set;
+typedef set<unsigned int>				uint_set;
+typedef set<unsigned long>				ulong_set;
+typedef set<unsigned __int64>			uint64_set;
+typedef set<float>						float_set;
+typedef set<double>						double_set;
+typedef hash_set<short>					short_hash_set;
+typedef hash_set<int>					int_hash_set;
+typedef hash_set<long>					long_hash_set;
+typedef hash_set<__int64>				int64_hash_set;
+typedef hash_set<unsigned short>		ushort_hash_set;
+typedef hash_set<unsigned int>			uint_hash_set;
+typedef hash_set<unsigned long>			ulong_hash_set;
+typedef hash_set<unsigned __int64>		uint64_hash_set;
+typedef hash_set<float>					float_hash_set;
+typedef hash_set<double>				double_hash_set;
+typedef unordered_set<short>			short_unordered_set;
+typedef unordered_set<int>				int_unordered_set;
+typedef unordered_set<long>				long_unordered_set;
+typedef unordered_set<__int64>			int64_unordered_set;
+typedef unordered_set<unsigned short>	ushort_unordered_set;
+typedef unordered_set<unsigned int>		uint_unordered_set;
+typedef unordered_set<unsigned long>	ulong_unordered_set;
+typedef unordered_set<unsigned __int64>	uint64_unordered_set;
+typedef unordered_set<float>			float_unordered_set;
+typedef unordered_set<double>			double_unordered_set;
+
+typedef list<INT_PTR>					int_ptr_list;
+typedef list<LONG_PTR>					long_ptr_list;
+typedef list<UINT_PTR>					uint_ptr_list;
+typedef list<ULONG_PTR>					ulong_ptr_list;
+typedef stack<INT_PTR>					int_ptr_stack;
+typedef stack<LONG_PTR>					long_ptr_stack;
+typedef stack<UINT_PTR>					uint_ptr_stack;
+typedef stack<ULONG_PTR>				ulong_ptr_stack;
+typedef queue<INT_PTR>					int_ptr_queue;
+typedef queue<LONG_PTR>					long_ptr_queue;
+typedef queue<UINT_PTR>					uint_ptr_queue;
+typedef queue<ULONG_PTR>				ulong_ptr_queue;
+typedef deque<INT_PTR>					int_ptr_deque;
+typedef deque<LONG_PTR>					long_ptr_deque;
+typedef deque<UINT_PTR>					uint_ptr_deque;
+typedef deque<ULONG_PTR>				ulong_ptr_deque;
+typedef vector<INT_PTR>					int_ptr_vector;
+typedef vector<LONG_PTR>				long_ptr_vector;
+typedef vector<UINT_PTR>				uint_ptr_vector;
+typedef vector<ULONG_PTR>				ulong_ptr_vector;
+typedef set<INT_PTR>					int_ptr_set;
+typedef set<LONG_PTR>					long_ptr_set;
+typedef set<UINT_PTR>					uint_ptr_set;
+typedef set<ULONG_PTR>					ulong_ptr_set;
+typedef hash_set<INT_PTR>				int_ptr_hash_set;
+typedef hash_set<LONG_PTR>				long_ptr_hash_set;
+typedef hash_set<UINT_PTR>				uint_ptr_hash_set;
+typedef hash_set<ULONG_PTR>				ulong_ptr_hash_set;
+typedef unordered_set<INT_PTR>			int_ptr_unordered_set;
+typedef unordered_set<LONG_PTR>			long_ptr_unordered_set;
+typedef unordered_set<UINT_PTR>			uint_ptr_unordered_set;
+typedef unordered_set<ULONG_PTR>		ulong_ptr_unordered_set;
+
+/*****************************************************************************/
+/******************************** 容器操作函数 *******************************/
+
+/**********************************
+描述: 清除普通集合 , 适用于 vector<Object> / list<Object>
+参数: 
+	v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class Set> void ClearSet(Set& v)
+{
+	v.clear();
+}
+
+template<class Set> struct Set_Cleaner
+{
+	static void Clear(Set& v) {ClearSet(v);}
+};
+
+/**********************************
+描述: 清除指针集合 (清除前先释放指针), 适用于 vector<Object*> / list<Object*>
+参数: 
+		v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class PtrSet> void ClearPtrSet(PtrSet& v)
+{
+	for(PtrSet::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+		delete (*it);
+
+	v.clear();
+}
+
+template<class PtrSet> struct PtrSet_Cleaner
+{
+	static void Clear(PtrSet& v) {ClearPtrSet(v);}
+};
+
+/**********************************
+描述: 清除指针集合 (指针同时又指向数组), 适用于 vector<Object*[]> / list<Object*[]>
+参数: 
+		v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class PtrArraySet> void ClearPtrArraySet(PtrArraySet& v)
+{
+	for(PtrArraySet::iterator	it	= v.begin(),
+								end	= v.end(); 
+								it != end;
+								++it)
+		delete[] (*it);
+
+	v.clear();
+}
+
+template<class PtrArraySet> struct PtrArraySet_Cleaner
+{
+	static void Clear(PtrArraySet& v) {ClearPtrArraySet(v);}
+};
+
+/**********************************
+描述: 清除普通影射 , 适用于 map<key, value>
+参数: 
+	v		: map
+
+返回值: 		
+**********************************/
+template<class Map> void ClearMap(Map& v)
+{
+	v.clear();
+}
+
+template<class Map> struct Map_Cleaner
+{
+	static void Clear(Map& v) {ClearMap(v);}
+};
+
+/**********************************
+描述: 清除指针影射 (清除前先释放指针), 适用于 map<key, Object*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrMap> void ClearPtrMap(PtrMap& v)
+{
+	for(PtrMap::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+		delete it->second;
+
+	v.clear();
+}
+
+template<class PtrMap> struct PtrMap_Cleaner
+{
+	static void Clear(PtrMap& v) {ClearPtrMap(v);}
+};
+
+/**********************************
+描述: 清除指针影射 (指针同时又指向数组), 适用于 map<key, Object*[]>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrArrayMap> void ClearPtrArrayMap(PtrArrayMap& v)
+{
+	for(PtrArrayMap::iterator	it	= v.begin(),
+								end	= v.end(); 
+								it != end;
+								++it)
+		delete[] it->second;
+
+	v.clear();
+}
+
+template<class PtrArrayMap> struct PtrArrayMap_Cleaner
+{
+	static void Clear(PtrArrayMap& v) {ClearPtrArrayMap(v);}
+};
+
+/**********************************
+描述: 清除集合-集合 (清除前先清除内部集合), 适用于 set<vector<Object>*>
+参数: 
+		v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class SetSet> void ClearSetSet(SetSet& v)
+{
+	for(SetSet::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		(*it)->clear();
+		delete (*it);
+	}
+
+	v.clear();
+}
+
+template<class SetSet> struct SetSet_Cleaner
+{
+	static void Clear(SetSet& v) {ClearSetSet(v);}
+};
+
+/**********************************
+描述: 清除指针集合-集合 (清除前先清除内部指针集合), 适用于 set<vector<Object*>*>
+参数: 
+		v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class PtrSetSet> void ClearPtrSetSet(PtrSetSet& v)
+{
+	for(PtrSetSet::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		ClearPtrSet(**it);
+		delete (*it);
+	}
+
+	v.clear();
+}
+
+template<class PtrSetSet> struct PtrSetSet_Cleaner
+{
+	static void Clear(PtrSetSet& v) {ClearPtrSetSet(v);}
+};
+
+/**********************************
+描述: 清除指针数组集合影射 (清除前先清除指针数组集合), 适用于 map<vector<Object*[]>*>
+参数: 
+		v		: vector / list / set
+
+返回值: 		
+**********************************/
+template<class PtrArraySetSet> void ClearPtrArraySetSet(PtrArraySetSet& v)
+{
+	for(PtrArraySetSet::iterator	it	= v.begin(),
+									end	= v.end(); 
+									it != end;
+									++it)
+	{
+		ClearPtrArraySet(**it);
+		delete (*it);
+	}
+
+	v.clear();
+}
+
+template<class PtrArraySetSet> struct PtrArraySetSet_Cleaner
+{
+	static void Clear(PtrArraySetSet& v) {ClearPtrArraySetSet(v);}
+};
+
+/**********************************
+描述: 清除集合影射 (清除前先清除集合), 适用于 map<key, vector<Object>*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class SetMap> void ClearSetMap(SetMap& v)
+{
+	for(SetMap::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		it->second->clear();
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class SetMap> struct SetMap_Cleaner
+{
+	static void Clear(SetMap& v) {ClearSetMap(v);}
+};
+
+/**********************************
+描述: 清除指针集合影射 (清除前先清除指针集合), 适用于 map<key, vector<Object*>*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrSetMap> void ClearPtrSetMap(PtrSetMap& v)
+{
+	for(PtrSetMap::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		ClearPtrSet(*(it->second));
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class PtrSetMap> struct PtrSetMap_Cleaner
+{
+	static void Clear(PtrSetMap& v) {ClearPtrSetMap(v);}
+};
+
+/**********************************
+描述: 清除指针数组集合影射 (清除前先清除指针数组集合), 适用于 map<key, vector<Object*[]>*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrArraySetMap> void ClearPtrArraySetMap(PtrArraySetMap& v)
+{
+	for(PtrArraySetMap::iterator	it	= v.begin(),
+									end	= v.end(); 
+									it != end;
+									++it)
+	{
+		ClearPtrArraySet(*(it->second));
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class PtrArraySetMap> struct PtrArraySetMap_Cleaner
+{
+	static void Clear(PtrArraySetMap& v) {ClearPtrArraySetMap(v);}
+};
+
+/**********************************
+描述: 清除映射-影射 (清除前先清除内部映射), 适用于 map<key, map<key2, Object>*>
+参数: 
+v		: map
+
+返回值: 		
+**********************************/
+template<class MapMap> void ClearMapMap(MapMap& v)
+{
+	for(MapMap::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		it->second->clear();
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class MapMap> struct MapMap_Cleaner
+{
+	static void Clear(MapMap& v) {ClearMapMap(v);}
+};
+
+/**********************************
+描述: 清除指针映射-影射 (清除前先清除指针内部映射), 适用于 map<key, map<key2, Object*>*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrMapMap> void ClearPtrMapMap(PtrMapMap& v)
+{
+	for(PtrMapMap::iterator	it	= v.begin(),
+							end	= v.end(); 
+							it != end;
+							++it)
+	{
+		ClearPtrMap(*(it->second));
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class PtrMapMap> struct PtrMapMap_Cleaner
+{
+	static void Clear(PtrMapMap& v) {ClearPtrMapMap(v);}
+};
+
+/**********************************
+描述: 清除指针映射-影射 (清除前先清除指针数组内部映射), 适用于 map<key, map<key2, Object*[]>*>
+参数: 
+		v		: map
+
+返回值: 		
+**********************************/
+template<class PtrArrayMapMap> void ClearPtrArrayMapMap(PtrArrayMapMap& v)
+{
+	for(PtrArrayMapMap::iterator	it	= v.begin(),
+									end	= v.end(); 
+									it != end;
+									++it)
+	{
+		ClearPtrArrayMap(*(it->second));
+		delete it->second;
+	}
+
+	v.clear();
+}
+
+template<class PtrArrayMapMap> struct PtrArrayMapMap_Cleaner
+{
+	static void Clear(PtrArrayMapMap& v) {ClearPtrArrayMapMap(v);}
+};
+
+/************************************************************************/
+/*                           指针集合容器                               */
+/************************************************************************/
+template<class Set, class Cleaner> struct SetWrapper
+{
+	typedef typename Set::iterator			iterator;
+	typedef typename Set::const_iterator	const_iterator;
+	typedef typename Set::value_type		value_type;
+	typedef typename Set::reference			reference;
+	typedef typename Set::const_reference	const_reference;
+	typedef typename Set::pointer			pointer;
+	typedef typename Set::const_pointer		const_pointer;
+	typedef typename Set::size_type			size_type;
+	typedef typename Set::difference_type	difference_type;
+
+	SetWrapper()
+	{
+	}
+
+	virtual ~SetWrapper()
+	{
+		Clear();
+	}
+
+	void Clear()
+	{
+		if(!IsEmpty())
+		{
+			Cleaner::Clear(m_set);
+		}
+	}
+
+	Set& operator *			()			{return m_set;}
+	const Set& operator *	()	const	{return m_set;}
+	Set* operator ->		()			{return &m_set;}
+	const Set* operator ->	()	const	{return &m_set;}
+	Set& Get				()			{return m_set;}
+	operator Set&			()			{return m_set;}
+	bool IsEmpty			()	const	{return m_set.empty();}
+	size_t Size				()	const	{return m_set.size();}
+
+protected:
+	Set m_set;
+
+	DECLARE_NO_COPY_CLASS(SetWrapper)
+};
+
+template<class Set, class Cleaner> struct VectorWrapper : public SetWrapper<Set, Cleaner>
+{
+	VectorWrapper()
+	{
+	}
+
+	reference		operator []	(size_type i)			{return m_set[i];}
+	const_reference operator []	(size_type i)	const	{return m_set[i];}
+
+	DECLARE_NO_COPY_CLASS(VectorWrapper)
+};
+
+/************************************************************************/
+/*                         指针数组集合容器                             */
+/************************************************************************/
+
+
+/************************************************************************/
+/*                           指针映射容器                               */
+/************************************************************************/
+template<class Map, class Cleaner> struct MapWrapper
+{
+	typedef typename Map::iterator			iterator;
+	typedef typename Map::const_iterator	const_iterator;
+	typedef typename Map::key_type			key_type;
+	typedef typename Map::mapped_type		mapped_type;
+	typedef typename Map::value_type		value_type;
+	typedef typename Map::reference			reference;
+	typedef typename Map::const_reference	const_reference;
+	typedef typename Map::pointer			pointer;
+	typedef typename Map::size_type			size_type;
+	typedef typename Map::difference_type	difference_type;
+
+	MapWrapper()
+	{
+	}
+
+	~MapWrapper()
+	{
+		Clear();
+	}
+
+	void Clear()
+	{
+		if(!IsEmpty())
+		{
+			Cleaner::Clear(m_map);
+		}
+	}
+
+	Map&				operator *	()								{return m_map;}
+	const Map&			operator *	()						const	{return m_map;}
+	Map*				operator ->	()								{return &m_map;}
+	const Map*			operator ->	()						const	{return &m_map;}
+	mapped_type&		operator []	(const key_type& key)			{return m_map[key];}
+	const mapped_type&	operator []	(const key_type& key)	const	{return m_map[key];}
+	Map& Get			()			{return m_map;}
+	operator Map&		()			{return m_map;}
+	bool IsEmpty		()	const	{return m_map.empty();}
+	size_t Size			()	const	{return m_map.size();}
+
+private:
+	Map m_map;
+
+	DECLARE_NO_COPY_CLASS(MapWrapper)
+};
+
+/************************************************************************/
+/*                            比较仿函数                                */
+/************************************************************************/
+
+template<class T> struct char_comparator
+{
+	typedef T	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return strcmp(v1, v2) == 0;}
+};
+
+template<class T> struct char_nc_comparator
+{
+	typedef T	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return stricmp(v1, v2) == 0;}
+};
+
+template<class T> struct wchar_comparator
+{
+	typedef T	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return wcscmp(v1, v2) == 0;}
+};
+
+template<class T> struct wchar_nc_comparator
+{
+	typedef T	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return wcsicmp(v1, v2) == 0;}
+};
+
+template<class T> struct cstring_comparator
+{
+	typedef typename T::PCXSTR	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return v1.Compare(v2) == 0;}
+};
+
+template<class T> struct cstring_nc_comparator
+{
+	typedef typename T::PCXSTR	row_type;
+	static row_type row_type_value(const T& v)		{return (row_type)v;}
+	static bool equal_to(const T& v1, const T& v2)	{return v1.CompareNoCase(v2) == 0;}
+};
+
+// char/wchar_t/CStringX hash function
+template<class T, class H> struct str_hash_func_t
+{
+	struct hash
+	{
+		size_t operator() (const T& t) const
+		{
+			return hash_value(H::row_type_value(t));
+		}
+	};
+
+	struct equal_to
+	{
+		bool operator() (const T& t1, const T& t2) const
+		{
+			return H::equal_to(t1, t2);
+		}
+	};
+
+};
+
+// char/wchar_t/CStringX hash function (no case)
+template<class T, class H> struct str_nc_hash_func_t
+{
+	struct hash
+	{
+		size_t operator() (const T& t) const
+		{
+			size_t _Val		 = 2166136261U;
+			H::row_type lpsz = H::row_type_value(t);
+			char c;
+
+			while((c = *lpsz++) != 0) 
+			{
+				if(c >= 'A' && c <= 'Z')
+					c += 32;
+
+				_Val = 16777619U * _Val ^ c;
+
+			}
+
+			return _Val;
+		}
+	};
+
+	struct equal_to
+	{
+		bool operator() (const T& t1, const T& t2) const
+		{
+			return H::equal_to(t1, t2);
+		}
+	};
+
+};
+
+typedef str_hash_func_t<LPCSTR, char_comparator<LPCSTR>>			str_hash_func;
+typedef str_hash_func_t<LPCWSTR, wchar_comparator<LPCWSTR>>			wstr_hash_func;
+typedef str_hash_func_t<CStringA, cstring_comparator<CStringA>>		cstringa_hash_func;
+typedef str_hash_func_t<CStringW, cstring_comparator<CStringW>>		cstringw_hash_func;
+typedef str_nc_hash_func_t<LPCSTR, char_comparator<LPCSTR>>			str_nc_hash_func;
+typedef str_nc_hash_func_t<LPCWSTR, wchar_comparator<LPCWSTR>>		wstr_nc_hash_func;
+typedef str_nc_hash_func_t<CStringA, cstring_comparator<CStringA>>	cstringa_nc_hash_func;
+typedef str_nc_hash_func_t<CStringW, cstring_comparator<CStringW>>	cstringw_nc_hash_func;
+
+#ifdef _UNICODE
+	typedef cstringw_hash_func		cstring_hash_func;
+	typedef cstringw_nc_hash_func	cstring_nc_hash_func;
+#else
+	typedef cstringa_hash_func		cstring_hash_func;
+	typedef cstringa_nc_hash_func	cstring_nc_hash_func;
+#endif
+
+struct bool_comp_func
+{
+	bool operator() (bool v1, bool v2) const
+	{
+		if(!v1)
+			return false;
+		if(v1 == v2)
+			return false;
+
+		return true;
+	}
+};
+
+template<class T>
+// T -> (signed / unsigned) short / int / long / __int64
+struct integer_comp_func
+{
+	bool operator() (T v1, T v2) const
+	{
+		return v1 < v2;
+	}
+};
+
+typedef integer_comp_func<short>				short_comp_func;
+typedef integer_comp_func<int>					int_comp_func;
+typedef integer_comp_func<long>					long_comp_func;
+typedef integer_comp_func<__int64>				int64_comp_func;
+typedef integer_comp_func<unsigned short>		ushort_comp_func;
+typedef integer_comp_func<unsigned int>			uint_comp_func;
+typedef integer_comp_func<unsigned long>		ulong_comp_func;
+typedef integer_comp_func<unsigned __int64>		uint64_comp_func;
+
+struct float_comp_func
+{
+	bool operator() (float v1, float v2) const
+	{
+		float disc	= v1 - v2;
+		if(fabsf(disc) < 1E-5)
+			return false;
+
+		return disc < 0;
+	}
+};
+
+struct double_comp_func
+{
+	bool operator() (double v1, double v2) const
+	{
+		double disc	= v1 - v2;
+		if(fabs(disc) < 1E-8)
+			return false;
+
+		return disc < 0;
+	}
+};
+
+template<class T, bool CASE = false>
+// T -> (unsigned) char / wchar_t
+struct character_comp_func
+{
+	bool operator() (T v1, T v2) const
+	{
+		if(!CASE)
+		{
+			if(v1 >= 'A' && v1 <= 'Z')	v1 += 32;
+			if(v2 >= 'A' && v2 <= 'Z')	v2 += 32;
+		}
+
+		return v1 < v2;
+	}
+};
+
+typedef character_comp_func<char, true>				char_case_comp_func;
+typedef character_comp_func<unsigned char, true>	uchar_case_comp_func;
+typedef character_comp_func<wchar_t, true>			wchar_case_comp_func;
+typedef character_comp_func<char, false>			char_ucase_comp_func;
+typedef character_comp_func<unsigned char, false>	uchar_ucase_comp_func;
+typedef character_comp_func<wchar_t, false>			wchar_ucase_comp_func;
+
+template<class T, bool CASE = false>
+// T -> TCHAR* / CString
+struct str_comp_func
+{
+	//比较函数。
+	bool operator() (const T &A, const T &B) const
+	{
+		if(!CASE)
+			return lstrcmpi((LPCTSTR)A, (LPCTSTR)B) < 0;
+		else
+			return lstrcmp((LPCTSTR)A, (LPCTSTR)B) < 0;
+	}
+};
+
+typedef str_comp_func<LPCTSTR, true>		case_tchar_comp_func;
+typedef str_comp_func<LPCTSTR, false>		uncase_tchar_comp_func;
+typedef str_comp_func<CString, true>		case_string_comp_func;
+typedef str_comp_func<CString, false>		uncase_string_comp_func;
+typedef case_tchar_comp_func				tchar_ptr_case_comp_func;
+typedef uncase_tchar_comp_func				tchar_ptr_ucase_comp_func;
+typedef case_string_comp_func				string_case_comp_func;
+typedef uncase_string_comp_func				string_ucase_comp_func;
+/************************************************************************/
+/*                            排序仿函数                                */
+/************************************************************************/
+template<bool ASC = true>
+struct bool_sort_func
+{
+	bool operator() (bool v1, bool v2) const
+	{
+		if(v1 == v2)
+			return false;
+
+		bool result = !v1;
+		return ASC ? result : !result;
+	}
+};
+
+typedef bool_sort_func<true>	bool_asc_sort_func;
+typedef bool_sort_func<false>	bool_desc_sort_func;
+
+template<class T, bool ASC = true>
+// T -> (signed / unsigned) short / int / long / __int64
+struct integer_sort_func
+{
+	bool operator() (T v1, T v2) const
+	{
+		if(v1 == v2)
+			return false;
+
+		bool result = v1 < v2;
+		return ASC ? result : !result;
+	}
+};
+
+typedef integer_sort_func<short,			true>		short_asc_sort_func;
+typedef integer_sort_func<unsigned short,	true>		ushort_asc_sort_func;
+typedef integer_sort_func<int,				true>		int_asc_sort_func;
+typedef integer_sort_func<unsigned int,		true>		uint_asc_sort_func;
+typedef integer_sort_func<long,				true>		long_asc_sort_func;
+typedef integer_sort_func<unsigned long,	true>		ulong_asc_sort_func;
+typedef integer_sort_func<__int64,			true>		int64_asc_sort_func;
+typedef integer_sort_func<unsigned __int64,	true>		uint64_asc_sort_func;
+typedef integer_sort_func<short,			false>		short_desc_sort_func;
+typedef integer_sort_func<unsigned short,	false>		ushort_desc_sort_func;
+typedef integer_sort_func<int,				false>		int_desc_sort_func;
+typedef integer_sort_func<unsigned int,		false>		uint_desc_sort_func;
+typedef integer_sort_func<long,				false>		long_desc_sort_func;
+typedef integer_sort_func<unsigned long,	false>		ulong_desc_sort_func;
+typedef integer_sort_func<__int64,			false>		int64_desc_sort_func;
+typedef integer_sort_func<unsigned __int64,	false>		uint64_desc_sort_func;
+
+template<bool ASC = true>
+struct float_sort_func
+{
+	bool operator() (float v1, float v2) const
+	{
+		float disc	= v1 - v2;
+		if(fabsf(disc) < 1E-5)
+			return false;
+
+		bool result = disc < 0;
+		return ASC ? result : !result;
+	}
+};
+
+typedef float_sort_func<true>		float_asc_sort_func;
+typedef float_sort_func<false>		float_desc_sort_func;
+
+template<bool ASC = true>
+struct double_sort_func
+{
+	bool operator() (double v1, double v2) const
+	{
+		double disc	= v1 - v2;
+		if(fabs(disc) < 1E-8)
+			return false;
+
+		bool result = disc < 0;
+		return ASC ? result : !result;
+	}
+};
+
+typedef double_sort_func<true>		double_asc_sort_func;
+typedef double_sort_func<false>		double_desc_sort_func;
+
+template<class T, bool ASC = true, bool CASE = false>
+// T -> (unsigned) char / wchar_t
+struct character_sort_func
+{
+	bool operator() (T v1, T v2) const
+	{
+		if(!CASE)
+		{
+			if(v1 >= 'A' && v1 <= 'Z')	v1 += 32;
+			if(v2 >= 'A' && v2 <= 'Z')	v2 += 32;
+		}
+
+		if(v1 == v2)
+			return false;
+
+		bool result = v1 < v2;
+		return ASC ? result : !result;
+	}
+};
+
+typedef character_sort_func<char, true, true>				char_asc_case_sort_func;
+typedef character_sort_func<unsigned char, true, true>		uchar_asc_case_sort_func;
+typedef character_sort_func<wchar_t, true, true>			wchar_asc_case_sort_func;
+typedef character_sort_func<char, true, false>				char_asc_ucase_sort_func;
+typedef character_sort_func<unsigned char, true, false>		uchar_asc_ucase_sort_func;
+typedef character_sort_func<wchar_t, true, false>			wchar_asc_ucase_sort_func;
+typedef character_sort_func<char, false, true>				char_desc_case_sort_func;
+typedef character_sort_func<unsigned char, false, true>		uchar_desc_case_sort_func;
+typedef character_sort_func<wchar_t, false, true>			wchar_desc_case_sort_func;
+typedef character_sort_func<char, false, false>				char_desc_ucase_sort_func;
+typedef character_sort_func<unsigned char, false, false>	uchar_desc_ucase_sort_func;
+typedef character_sort_func<wchar_t, false, false>			wchar_desc_ucase_sort_func;
+
+template<class T, bool ASC = true, bool CASE = false>
+// T -> TCHAR* / CString
+struct str_sort_func
+{
+	bool operator() (const T& v1, const T& v2) const
+	{
+		bool result;
+
+		if(CASE)
+		{
+			int v = lstrcmp((LPCTSTR)v1, (LPCTSTR)v2);
+			if(v == 0)
+				result = false;
+			else
+				result = v < 0;
+		}
+		else
+		{
+			int v = lstrcmpi((LPCTSTR)v1, (LPCTSTR)v2);
+			if(v == 0)
+				result = false;
+			else
+				result = v < 0;
+		}
+
+		return ASC ? result : !result;
+	}
+};
+
+typedef str_sort_func<TCHAR*, true, true>		tchar_ptr_asc_case_sort_func;
+typedef str_sort_func<CString, true, true>		string_asc_case_sort_func;
+typedef str_sort_func<TCHAR*, true, false>		tchar_ptr_asc_ucase_sort_func;
+typedef str_sort_func<CString, true, false>		string_asc_ucase_sort_func;
+typedef str_sort_func<TCHAR*, false, true>		tchar_ptr_desc_case_sort_func;
+typedef str_sort_func<CString, false, true>		string_desc_case_sort_func;
+typedef str_sort_func<TCHAR*, false, false>		tchar_ptr_desc_ucase_sort_func;
+typedef str_sort_func<CString, false, false>	string_desc_ucase_sort_func;
+
+/************************************************************************/
+/*					   smart_ptr 单实体或数组智能指针                    */
+/************************************************************************/
+
+template<class _Ty>
+struct simple_deleter
+{
+	static void delete_ptr(_Ty* pv) {delete pv;}
+};
+
+template<class _Ty>
+struct global_simple_deleter
+{
+	static void delete_ptr(_Ty* pv) {::delete pv;}
+};
+
+template<class _Ty>
+struct array_deleter
+{
+	static void delete_ptr(_Ty* pv) {delete[] pv;}
+};
+
+template<class _Ty>
+struct global_array_deleter
+{
+	static void delete_ptr(_Ty* pv) {::delete[] pv;}
+};
+
+template<class _Ty, class _Deleter>
+class smart_ptr
+{
+public:
+	smart_ptr(_Ty* _Ptr = 0)					: _Myptr(_Ptr)				{}
+	smart_ptr(smart_ptr<_Ty, _Deleter>& _Right)	: _Myptr(_Right.release())	{}
+
+	~smart_ptr()
+	{
+		reset();
+	}
+
+	smart_ptr<_Ty, _Deleter>& reset(_Ty* _Ptr = 0)
+	{
+		if (_Ptr != _Myptr)
+		{
+			if(_Myptr)
+				_Deleter::delete_ptr(_Myptr);
+
+			_Myptr = _Ptr;
+		}
+
+		return *this;
+	}
+
+	smart_ptr<_Ty, _Deleter>& reset(smart_ptr<_Ty, _Deleter>& _Right)
+	{
+		if (this != &_Right)
+			reset(_Right.release());
+
+		return *this;
+	}
+
+	_Ty* release()
+	{
+		_Ty* _Ptr	= _Myptr;
+		_Myptr		= 0;
+
+		return _Ptr;
+	}
+
+	smart_ptr<_Ty, _Deleter>& operator = (_Ty* _Ptr)						{return reset(_Ptr);}
+	smart_ptr<_Ty, _Deleter>& operator = (smart_ptr<_Ty, _Deleter>& _Right)	{return reset(_Right);}
+
+	bool is_valid		()	const	{return _Myptr != 0;}
+	_Ty& operator *		()	const	{return *_Myptr;}
+	_Ty* get			()	const	{return _Myptr;}
+	_Ty* operator ->	()	const	{return _Myptr;}
+	operator _Ty*		()	const	{return _Myptr;}
+
+private:
+	template<class _Other> smart_ptr<_Ty, _Deleter>					(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_ptr<_Ty, _Deleter>&	reset		(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_ptr<_Ty, _Deleter>&	operator =	(const smart_ptr<_Ty, _Other>&);
+
+	template<class _Other> smart_ptr<_Ty, _Deleter>					(const smart_ptr<_Other, _Deleter>&);
+	template<class _Other> smart_ptr<_Ty, _Deleter>&	reset		(const smart_ptr<_Other, _Deleter>&);
+	template<class _Other> smart_ptr<_Ty, _Deleter>&	operator =	(const smart_ptr<_Other, _Deleter>&);
+
+protected:
+	_Ty* _Myptr;
+};
+
+
+/************************************************************************/
+/*				    smart_simple_ptr 单实体智能指针                      */
+/************************************************************************/
+
+template<class _Ty>
+class smart_simple_ptr : public smart_ptr<_Ty, simple_deleter<_Ty>>
+{
+public:
+	smart_simple_ptr(_Ty* _Ptr = 0)									: smart_ptr(_Ptr)	{}
+	smart_simple_ptr(smart_simple_ptr<_Ty>& _Right)					: smart_ptr(_Right)	{}
+	smart_simple_ptr(smart_ptr<_Ty, simple_deleter<_Ty>>& _Right)	: smart_ptr(_Right)	{}
+
+	smart_simple_ptr<_Ty>& operator = (smart_ptr<_Ty, simple_deleter<_Ty>>& _Right)
+	{return (smart_simple_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_simple_ptr<_Ty>& operator = (smart_simple_ptr<_Ty>& _Right)
+	{return (smart_simple_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_simple_ptr<_Ty>& operator = (_Ty* _Ptr)
+	{return (smart_simple_ptr<_Ty>&)__super::operator = (_Ptr);}
+
+private:
+	template<class _Other> smart_simple_ptr<_Ty>				(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_simple_ptr<_Ty>&	operator =	(const smart_ptr<_Ty, _Other>&);
+
+	template<class _Other> smart_simple_ptr<_Ty>				(const smart_simple_ptr<_Other>&);
+	template<class _Other> smart_simple_ptr<_Ty>&	operator =	(const smart_simple_ptr<_Other>&);
+};
+
+/************************************************************************/
+/*		   smart_gd_simple_ptr 单实体智能指针 (使用全局 delete)          */
+/************************************************************************/
+
+template<class _Ty>
+class smart_gd_simple_ptr : public smart_ptr<_Ty, global_simple_deleter<_Ty>>
+{
+public:
+	smart_gd_simple_ptr(_Ty* _Ptr = 0)										: smart_ptr(_Ptr)	{}
+	smart_gd_simple_ptr(smart_gd_simple_ptr<_Ty>& _Right)					: smart_ptr(_Right)	{}
+	smart_gd_simple_ptr(smart_ptr<_Ty, global_simple_deleter<_Ty>>& _Right)	: smart_ptr(_Right)	{}
+
+	smart_gd_simple_ptr<_Ty>& operator = (smart_ptr<_Ty, global_simple_deleter<_Ty>>& _Right)
+	{return (smart_gd_simple_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_gd_simple_ptr<_Ty>& operator = (smart_gd_simple_ptr<_Ty>& _Right)
+	{return (smart_gd_simple_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_gd_simple_ptr<_Ty>& operator = (_Ty* _Ptr)
+	{return (smart_gd_simple_ptr<_Ty>&)__super::operator = (_Ptr);}
+
+private:
+	template<class _Other> smart_gd_simple_ptr<_Ty>					(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_gd_simple_ptr<_Ty>&	operator =	(const smart_ptr<_Ty, _Other>&);
+
+	template<class _Other> smart_gd_simple_ptr<_Ty>					(const smart_gd_simple_ptr<_Other>&);
+	template<class _Other> smart_gd_simple_ptr<_Ty>&	operator =	(const smart_gd_simple_ptr<_Other>&);
+};
+
+/************************************************************************/
+/*                   smart_array_ptr 数组智能指针                        */
+/************************************************************************/
+
+template<class _Ty>
+class smart_array_ptr : public smart_ptr<_Ty, array_deleter<_Ty>>
+{
+public:
+	smart_array_ptr(_Ty* _Ptr = 0)								: smart_ptr(_Ptr)	{}
+	smart_array_ptr(smart_simple_ptr<_Ty>& _Right)				: smart_ptr(_Right)	{}
+	smart_array_ptr(smart_ptr<_Ty, array_deleter<_Ty>>& _Right)	: smart_ptr(_Right)	{}
+
+	smart_array_ptr<_Ty>& operator = (smart_ptr<_Ty, array_deleter<_Ty>>& _Right)
+	{return (smart_array_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_array_ptr<_Ty>& operator = (smart_array_ptr<_Ty>& _Right)
+	{return (smart_array_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_array_ptr<_Ty>& operator = (_Ty* _Ptr)
+	{return (smart_array_ptr<_Ty>&)__super::operator = (_Ptr);}
+
+private:
+	template<class _Other> smart_array_ptr<_Ty>					(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_array_ptr<_Ty>&	operator =	(const smart_ptr<_Ty, _Other>&);
+
+	template<class _Other> smart_array_ptr<_Ty>					(const smart_array_ptr<_Other>&);
+	template<class _Other> smart_array_ptr<_Ty>&	operator =	(const smart_array_ptr<_Other>&);
+};
+
+/************************************************************************/
+/*          smart_gd_array_ptr 单实体智能指针 (使用全局 delete)          */
+/************************************************************************/
+
+template<class _Ty>
+class smart_gd_array_ptr : public smart_ptr<_Ty, global_array_deleter<_Ty>>
+{
+public:
+	smart_gd_array_ptr(_Ty* _Ptr = 0)										: smart_ptr(_Ptr)	{}
+	smart_gd_array_ptr(smart_gd_array_ptr<_Ty>& _Right)						: smart_ptr(_Right)	{}
+	smart_gd_array_ptr(smart_ptr<_Ty, global_array_deleter<_Ty>>& _Right)	: smart_ptr(_Right)	{}
+
+	smart_gd_array_ptr<_Ty>& operator = (smart_ptr<_Ty, global_array_deleter<_Ty>>& _Right)
+	{return (smart_gd_array_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_gd_array_ptr<_Ty>& operator = (smart_gd_array_ptr<_Ty>& _Right)
+	{return (smart_gd_array_ptr<_Ty>&)__super::operator = (_Right);}
+
+	smart_gd_array_ptr<_Ty>& operator = (_Ty* _Ptr)
+	{return (smart_gd_array_ptr<_Ty>&)__super::operator = (_Ptr);}
+
+private:
+	template<class _Other> smart_gd_array_ptr<_Ty>				(const smart_ptr<_Ty, _Other>&);
+	template<class _Other> smart_gd_array_ptr<_Ty>&	operator =	(const smart_ptr<_Ty, _Other>&);
+
+	template<class _Other> smart_gd_array_ptr<_Ty>				(const smart_gd_array_ptr<_Other>&);
+	template<class _Other> smart_gd_array_ptr<_Ty>&	operator =	(const smart_gd_array_ptr<_Other>&);
+};

socket/common/Src/Semaphore.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "Semaphore.h"

socket/common/Src/Semaphore.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+class CSEM
+{
+public:
+	CSEM(LONG lMaximumCount, LONG lInitialCount = 0, LPCTSTR lpName = nullptr, LPSECURITY_ATTRIBUTES pSecurity = nullptr)
+	{
+		m_hsem = ::CreateSemaphore(pSecurity, lInitialCount, lMaximumCount, lpName);
+		ASSERT(IsValid());
+	}
+
+	~CSEM()
+	{
+		if(IsValid())
+			VERIFY(::CloseHandle(m_hsem));
+	}
+
+	BOOL Open(DWORD dwAccess, BOOL bInheritHandle, LPCTSTR pszName)
+	{
+		if(IsValid())
+			VERIFY(::CloseHandle(m_hsem));
+
+		m_hsem = ::OpenSemaphore(dwAccess, bInheritHandle, pszName);
+		return(IsValid());
+	}
+
+	void Wait(DWORD dwMilliseconds = INFINITE)
+	{
+		::WaitForSingleObject(m_hsem, dwMilliseconds);
+	}
+
+	BOOL Release(LONG lReleaseCount = 1, LPLONG lpPreviousCount = nullptr)
+	{
+		return ::ReleaseSemaphore(m_hsem, lReleaseCount, lpPreviousCount);
+	}
+
+	HANDLE& GetHandle	() 	{return m_hsem;}
+	operator HANDLE		()	{return m_hsem;}
+	BOOL IsValid		()	{return m_hsem != nullptr;}
+
+private:
+	CSEM(const CSEM& sem);
+	CSEM operator = (const CSEM& sem);
+private:
+	HANDLE m_hsem;
+};

socket/common/Src/Singleton.h

@@ -0,0 +1,111 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#define SINGLETON_THIS(ClassName)		ClassName::GetThis()
+#define SINGLETON_INSTANCE(ClassName)	ClassName::GetInstance()
+#define SINGLETON_OBJECT(ObjName)		SINGLETON_INSTANCE(C##ObjName)
+
+#define DEFINE_SINGLETON(ClassName)											\
+	ClassName* ClassName::m_pThis = nullptr;
+
+#define DEFINE_P_THIS(ClassName)											\
+		DEFINE_SINGLETON(ClassName)
+
+#define DECLARE_SINGLETON_INTERFACE(ClassName)								\
+public:																		\
+	static ClassName* GetThis()		{return m_pThis;}						\
+	static ClassName& GetInstance() {return *m_pThis;}						\
+protected:																	\
+	static ClassName* m_pThis;
+
+#define DECLARE_SINGLETON_CREATE_INSTANCE(ClassName)						\
+public:																		\
+	static BOOL CreateInstance()											\
+	{																		\
+		if(!m_pThis)														\
+			m_pThis = new ClassName;										\
+																			\
+		return m_pThis != nullptr;											\
+	}																		\
+																			\
+	static BOOL DeleteInstance()											\
+	{																		\
+		if(m_pThis)															\
+		{																	\
+			delete m_pThis;													\
+			m_pThis = nullptr;												\
+		}																	\
+																			\
+		return m_pThis == nullptr;											\
+	}
+
+#define DECLARE_PRIVATE_DEFAULT_CONSTRUCTOR(ClassName)						\
+private:																	\
+	ClassName(){}
+
+#define DECLARE_PRIVATE_COPY_CONSTRUCTOR(ClassName)							\
+private:																	\
+	ClassName(const ClassName&);											\
+	ClassName& operator = (const ClassName&);
+
+#define DECLARE_NO_COPY_CLASS(className)									\
+		DECLARE_PRIVATE_COPY_CONSTRUCTOR(className)
+
+
+#define DECLARE_SINGLETON_IMPLEMENT_NO_CREATE_INSTANCE(ClassName)			\
+	DECLARE_SINGLETON_INTERFACE(ClassName)									\
+	DECLARE_PRIVATE_DEFAULT_CONSTRUCTOR(ClassName)							\
+	DECLARE_PRIVATE_COPY_CONSTRUCTOR(ClassName)								
+
+#define DECLARE_SINGLETON_IMPLEMENT_NO_DEFAULT_CONSTRUCTOR(ClassName)		\
+	DECLARE_SINGLETON_CREATE_INSTANCE(ClassName)							\
+	DECLARE_PRIVATE_COPY_CONSTRUCTOR(ClassName)
+
+#define DECLARE_SINGLETON_IMPLEMENT(ClassName)								\
+	DECLARE_SINGLETON_IMPLEMENT_NO_DEFAULT_CONSTRUCTOR(ClassName)			\
+	DECLARE_PRIVATE_DEFAULT_CONSTRUCTOR(ClassName)
+
+#define DECLARE_SINGLETON_NO_DEFAULT_CONSTRUCTOR(ClassName)					\
+	DECLARE_SINGLETON_INTERFACE(ClassName)									\
+	DECLARE_SINGLETON_IMPLEMENT_NO_DEFAULT_CONSTRUCTOR(ClassName)
+
+#define DECLARE_SINGLETON(ClassName)										\
+	DECLARE_SINGLETON_NO_DEFAULT_CONSTRUCTOR(ClassName)						\
+	DECLARE_PRIVATE_DEFAULT_CONSTRUCTOR(ClassName)
+
+
+template<class T>
+class CSingleObject
+{
+public:
+	CSingleObject	()	{T::CreateInstance();}
+	~CSingleObject	()	{T::DeleteInstance();}
+	T* GetPointer	()	{return T::GetThis();}
+	T& GetObject	()	{return T::GetInstance();}
+	BOOL IsValid	()	{return GetPointer() != nullptr;}
+};
+
+#define DECLARE_SINGLE_OBJECT(ClassName) CSingleObject<ClassName> _##ClassName##_Single_Object_;

socket/common/Src/SysHelper.cpp

@@ -0,0 +1,72 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "SysHelper.h"
+#include "GeneralHelper.h"
+
+VOID SysGetSystemInfo(LPSYSTEM_INFO pInfo)
+{
+	ASSERT(pInfo != nullptr);
+	::GetNativeSystemInfo(pInfo);
+}
+
+DWORD SysGetNumberOfProcessors()
+{
+	SYSTEM_INFO si;
+	SysGetSystemInfo(&si);
+	
+	return si.dwNumberOfProcessors;
+}
+
+DWORD SysGetPageSize()
+{
+	SYSTEM_INFO si;
+	SysGetSystemInfo(&si);
+
+	return si.dwPageSize;
+}
+
+#if _MSC_VER < 1800
+
+BOOL SysGetOSVersionInfo(LPOSVERSIONINFO pInfo, BOOL bInfoEx)
+{
+	ASSERT(pInfo != nullptr);
+
+	pInfo->dwOSVersionInfoSize = bInfoEx ? sizeof(LPOSVERSIONINFOEX) : sizeof(LPOSVERSIONINFO);
+	return ::GetVersionEx(pInfo);
+}
+
+DWORD SysGetOSVersion()
+{
+	OSVERSIONINFO vi;
+	DWORD dwOSVersion = 0;
+
+	if(SysGetOSVersionInfo(&vi))
+		dwOSVersion = (vi.dwMajorVersion << 16) + vi.dwMinorVersion;
+
+	return dwOSVersion;
+}
+
+#endif

socket/common/Src/SysHelper.h

@@ -0,0 +1,41 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+// 获取系统信息
+VOID SysGetSystemInfo(LPSYSTEM_INFO pInfo);
+// 获取 CPU 核数
+DWORD SysGetNumberOfProcessors();
+// 获取页面大小
+DWORD SysGetPageSize();
+
+#if _MSC_VER < 1800
+
+// 获取操作系统版本
+BOOL SysGetOSVersionInfo(LPOSVERSIONINFO pInfo, BOOL bInfoEx = FALSE);
+// 获取操作系统版本（高位双字节：主版本号；低位双字节：副版本号）
+DWORD SysGetOSVersion();
+
+#endif

socket/common/Src/WaitFor.cpp

@@ -0,0 +1,150 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "WaitFor.h"
+#include "GeneralHelper.h"
+#include "CriticalSection.h"
+
+#include <MmSystem.h>
+#pragma comment(lib, "Winmm")
+
+DWORD TimeGetTime()
+{
+	return ::timeGetTime();
+}
+
+DWORD GetTimeGap32(DWORD dwOriginal)
+{
+	return ::timeGetTime() - dwOriginal;
+}
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+ULONGLONG GetTimeGap64(ULONGLONG ullOriginal)
+{
+	return ::GetTickCount64() - ullOriginal;
+}
+#endif
+
+BOOL PeekMessageLoop(BOOL bDispatchQuitMsg)
+{
+	BOOL value = TRUE;
+
+	MSG msg;
+	while(::PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE))
+	{
+		if(msg.message == WM_QUIT && !bDispatchQuitMsg)
+		{
+			value = FALSE;
+			break;
+		}
+
+		::TranslateMessage(&msg);
+		::DispatchMessage(&msg);
+	}
+
+	return value;
+}
+
+DWORD WaitForMultipleObjectsWithMessageLoop(DWORD dwHandles, HANDLE szHandles[], DWORD dwMilliseconds, DWORD dwWakeMask, DWORD dwFlags)
+{
+	DWORD dwResult		= WAIT_FAILED;
+	DWORD dwBeginTime	= (dwMilliseconds == INFINITE) ? INFINITE : ::timeGetTime();
+
+	while(TRUE)
+	{
+		int iWaitTime;
+		if(dwBeginTime != INFINITE)
+		{
+			iWaitTime	= dwMilliseconds - (GetTimeGap32(dwBeginTime));
+
+			if(iWaitTime <= 0)
+			{
+				dwResult = WAIT_TIMEOUT;
+				break;
+			}
+		}
+		else
+			iWaitTime	= INFINITE;
+
+		dwResult = ::MsgWaitForMultipleObjectsEx(dwHandles, szHandles, iWaitTime, dwWakeMask, dwFlags);
+		ASSERT(dwResult != WAIT_FAILED);
+
+		if(dwResult == (WAIT_OBJECT_0 + dwHandles))
+			PeekMessageLoop();
+		else
+			break;
+	}
+
+	return dwResult;
+
+}
+
+BOOL MsgWaitForSingleObject(HANDLE hHandle, DWORD dwMilliseconds, DWORD dwWakeMask, DWORD dwFlags)
+{
+	DWORD dwResult = WaitForMultipleObjectsWithMessageLoop(1, &hHandle, dwMilliseconds, dwWakeMask, dwFlags);
+
+	switch(dwResult)
+	{
+	case WAIT_OBJECT_0:
+		return TRUE;
+	case WAIT_FAILED:
+		ASSERT(FALSE);
+	case WAIT_TIMEOUT:
+		return FALSE;
+	default:
+		ASSERT(FALSE);
+	}
+
+	return FALSE;
+}
+
+void WaitWithMessageLoop(DWORD dwMilliseconds, DWORD dwWakeMask, DWORD dwFlags)
+{
+	static CEvt evWait;
+
+	VERIFY(MsgWaitForSingleObject(evWait, dwMilliseconds, dwWakeMask, dwFlags) == FALSE);
+}
+
+void WaitForWorkingQueue(long* plWorkingItemCount, long lMaxWorkingItemCount, DWORD dwCheckInterval)
+{
+	while(*plWorkingItemCount > lMaxWorkingItemCount)
+		::Sleep(dwCheckInterval);
+}
+
+void WaitForComplete(long* plWorkingItemCount, DWORD dwCheckInterval)
+{
+	WaitForWorkingQueue(plWorkingItemCount, 0, dwCheckInterval);
+}
+
+void MsgWaitForWorkingQueue(long* plWorkingItemCount, long lMaxWorkingItemCount, DWORD dwCheckInterval)
+{
+	while(*plWorkingItemCount > lMaxWorkingItemCount)
+		WaitWithMessageLoop(dwCheckInterval);
+}
+
+void MsgWaitForComplete(long* plWorkingItemCount, DWORD dwCheckInterval)
+{
+	MsgWaitForWorkingQueue(plWorkingItemCount, 0, dwCheckInterval);
+}

socket/common/Src/WaitFor.h

@@ -0,0 +1,138 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+/* timeGetTime() 包装方法 */
+DWORD TimeGetTime();
+
+/**********************************
+描述: 获取当前时间与原始时间的时间差
+参数: 
+		dwOriginal	: 原始时间（毫秒），通常用 timeGetTime() 或 GetTickCount() 获取
+
+返回值:	与当前 timeGetTime() 之间的时间差
+**********************************/
+DWORD GetTimeGap32(DWORD dwOriginal);
+
+#if _WIN32_WINNT >= _WIN32_WINNT_WS08
+/**********************************
+描述: 获取当前时间与原始时间的时间差
+参数: 
+		ullOriginal	: 原始时间（毫秒），通常用 GetTickCount64() 获取
+
+返回值:	与当前 GetTickCount64() 之间的时间差
+**********************************/
+ULONGLONG GetTimeGap64(ULONGLONG ullOriginal);
+#endif
+
+/**********************************
+描述: 处理Windows消息
+参数: 
+			bDispatchQuitMsg	: 是否转发 WM_QUIT 消息
+									TRUE : 转发（默认）
+									FALSE: 不转发，并返回 FALSE
+
+返回值:		TRUE  : 收完消息
+			FALSE : bDispatchQuitMsg 参数为 FALSE 并收到 WM_QUIT 消息		
+**********************************/
+BOOL PeekMessageLoop(BOOL bDispatchQuitMsg = TRUE);
+
+/**********************************
+描述: 等待指定时间, 同时处理Windows消息
+参数: (参考: MsgWaitForMultipleObjectsEx() )
+		dwHandles		: 数组元素个数
+		szHandles		: 对象句柄数组
+		dwMilliseconds	: 等待时间 (毫秒)
+		dwWakeMask		: 消息过滤标识
+		dwFlags			: 等待类型
+
+返回值: (0 ~ dwHandles - 1): 等待成功
+		WAIT_TIMEOUT		: 超时
+		WAIT_FAILED			: 执行失败
+**********************************/
+DWORD WaitForMultipleObjectsWithMessageLoop(DWORD dwHandles, HANDLE szHandles[], DWORD dwMilliseconds = INFINITE, DWORD dwWakeMask = QS_ALLINPUT, DWORD dwFlags = MWMO_INPUTAVAILABLE);
+
+/**********************************
+描述: 等待指定时间, 同时处理Windows消息
+参数: (参考: MsgWaitForMultipleObjectsEx() )
+		hHandle			: 对象句柄
+		dwMilliseconds	: 等待时间 (毫秒)
+		dwWakeMask		: 消息过滤标识
+		dwFlags			: 等待类型
+
+返回值: TRUE: 等待成功，FALSE: 超时		
+**********************************/
+BOOL MsgWaitForSingleObject(HANDLE hHandle, DWORD dwMilliseconds = INFINITE, DWORD dwWakeMask = QS_ALLINPUT, DWORD dwFlags = MWMO_INPUTAVAILABLE);
+
+/**********************************
+描述: 等待指定时间, 同时处理Windows消息
+参数: (参考: MsgWaitForMultipleObjectsEx() )
+		dwMilliseconds	: 等待时间 (毫秒)
+		dwWakeMask		: 消息过滤标识
+		dwFlags			: 等待类型
+
+返回值: MsgWaitForMultipleObjectsEx() 函数的操作结果		
+**********************************/
+void WaitWithMessageLoop(DWORD dwMilliseconds, DWORD dwWakeMask = QS_ALLINPUT, DWORD dwFlags = MWMO_INPUTAVAILABLE);
+
+/**********************************
+描述: 等待用Sleep()函数等待某个变量小于指定值
+参数: 
+		plWorkingItemCount		: 监视变量
+		lMaxWorkingItemCount	: 指定值
+		dwCheckInterval			: 检查间隔 (毫秒)
+
+返回值: 		
+**********************************/
+void WaitForWorkingQueue(long* plWorkingItemCount, long lMaxWorkingItemCount, DWORD dwCheckInterval);
+/**********************************
+描述: 等待用Sleep()函数等待某个变量减小到 0
+参数: 
+		plWorkingItemCount		: 监视变量
+		dwCheckInterval			: 检查间隔 (毫秒)
+
+返回值: 		
+**********************************/
+void WaitForComplete	(long* plWorkingItemCount, DWORD dwCheckInterval);
+
+/**********************************
+描述: 等待用WaitWithMessageLoop()函数等待某个变量小于指定值
+参数: 
+		plWorkingItemCount		: 监视变量
+		lMaxWorkingItemCount	: 指定值
+		dwCheckInterval			: 检查间隔 (毫秒)
+
+返回值: 		
+**********************************/
+void MsgWaitForWorkingQueue	(long* plWorkingItemCount, long lMaxWorkingItemCount, DWORD dwCheckInterval = 10);
+/**********************************
+描述: 等待用WaitWithMessageLoop()函数等待某个变量减小到 0
+参数: 
+		plWorkingItemCount		: 监视变量
+		dwCheckInterval			: 检查间隔 (毫秒)
+
+返回值: 		
+**********************************/
+void MsgWaitForComplete		(long* plWorkingItemCount, DWORD dwCheckInterval = 10);

socket/common/Src/Win32Helper.h

@@ -0,0 +1,819 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#include "GeneralHelper.h"
+
+// RECT 帮助宏
+#define RC_WIDTH(rc)		(rc.right - rc.left)
+#define RC_HEIGHT(rc)		(rc.bottom - rc.top)
+#define RC_CENTER_X(rc)		((rc.right + rc.left) / 2)
+#define RC_CENTER_Y(rc)		((rc.bottom + rc.top) / 2)
+
+/************************************************************************/
+/*                 			  消息映射帮助宏			 					*/
+/************************************************************************/
+
+/* see: WindowsX.h */
+#define HANDLE_SYS_MSG(hwnd, message, fn)	HANDLE_MSG(hwnd, message, fn)
+
+/* LRESULT Cls_OnMessage(HWND hwnd, WPARAM wParam, LPARAM lParam) */
+#define HANDLE_USER_MSG(hwnd, message, fn)								\
+	case (message): return (LRESULT)(fn)((hwnd), (wParam), (lParam))
+
+#define FORWARD_USER_MSG(hwnd, message, wParam, lParam, fn)				\
+	(LRESULT)(fn)((hwnd), (message), (wParam), (lParam))
+
+#define GET_WND_PROC_INTERNAL(theClass, flag)	((WNDPROC)theClass##flag##WndProc)
+#define GET_DLG_PROC_INTERNAL(theClass, flag)	((DLGPROC)theClass##flag##DlgProc)
+
+#define DECLARE_MSG_MAP_INTERNAL(theClass, flag)		\
+	static LRESULT CALLBACK theClass##flag##WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
+
+#define DECLARE_DLG_MSG_MAP_INTERNAL(theClass, flag)	\
+	static BOOL CALLBACK theClass##flag##DlgProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
+
+#define BEGIN_MSG_MAP_INTERNAL(theClass, flag)			\
+	LRESULT theClass##flag##WndProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)	\
+	{																					\
+		LRESULT result = 0;																\
+																						\
+		switch(msg)																		\
+		{
+
+#define BEGIN_DLG_MSG_MAP_INTERNAL(theClass, flag)		\
+	BOOL theClass##flag##DlgProc(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)		\
+	{																					\
+		BOOL	retVal = TRUE;															\
+		LRESULT result = 0;																\
+																						\
+		switch(msg)																		\
+		{
+
+// 窗口过程为类中的静态成员函数
+#define GET_WND_PROC(theClass)			GET_WND_PROC_INTERNAL(theClass, ::)
+#define GET_DLG_PROC(theClass)			GET_DLG_PROC_INTERNAL(theClass, ::)
+
+#define DECLARE_MSG_MAP(theClass)					\
+public:												\
+	DECLARE_MSG_MAP_INTERNAL(theClass, ::)
+
+#define DECLARE_DLG_MSG_MAP(theClass)				\
+public:												\
+	DECLARE_DLG_MSG_MAP_INTERNAL(theClass, ::)
+
+#define BEGIN_MSG_MAP(theClass)			BEGIN_MSG_MAP_INTERNAL(theClass, ::)
+#define BEGIN_DLG_MSG_MAP(theClass)		BEGIN_DLG_MSG_MAP_INTERNAL(theClass, ::)
+
+/* 消息处理函数的声明请参考: <WindowsX.h> 的 HANDLE_MSG */
+#define ADD_MSG_MAP(msg, fn)						\
+		case (msg): result = HANDLE_##msg((hWnd), (wParam), (lParam), (fn));	break;
+
+/* LRESULT Cls_OnMessage(HWND hwnd, WPARAM wParam, LPARAM lParam) */
+#define ADD_USER_MSG_MAP(msg, fn)					\
+		case (msg): result = (LRESULT)(fn)((hWnd), (wParam), (lParam));			break;
+
+#define END_MSG_MAP()								\
+		default:									\
+			result = ::DefWindowProc(hWnd, msg, wParam, lParam);						\
+		}																				\
+																						\
+		return result;																	\
+	}
+
+#define END_DLG_MSG_MAP()							\
+		default:									\
+			retVal = FALSE;																\
+		}																				\
+																						\
+		if(retVal)																		\
+			SetDlgMsgResult(hWnd, msg, result);											\
+																						\
+		return retVal;																	\
+	}
+
+// 窗口过程为全局函数
+#define GET_GLOBAL_WND_PROC(theClass)			GET_WND_PROC_INTERNAL(theClass,			_)
+#define DECLARE_GLOBAL_MSG_MAP(theClass)		DECLARE_MSG_MAP_INTERNAL(theClass,		_)
+#define BEGIN_GLOBAL_MSG_MAP(theClass)			BEGIN_MSG_MAP_INTERNAL(theClass,		_)
+#define END_GLOBAL_MSG_MAP()					END_MSG_MAP()
+
+#define GET_GLOBAL_DLG_PROC(theClass)			GET_DLG_PROC_INTERNAL(theClass,			_)
+#define DECLARE_GLOBAL_DLG_MSG_MAP(theClass)	DECLARE_DLG_MSG_MAP_INTERNAL(theClass,	_)
+#define BEGIN_GLOBAL_DLG_MSG_MAP(theClass)		BEGIN_DLG_MSG_MAP_INTERNAL(theClass,	_)
+#define END_GLOBAL_DLG_MSG_MAP()				END_DLG_MSG_MAP()
+
+// 绑定对象指针到窗口
+#define ATTACH_OBJ_PTR_TO_WINDOW(hwnd, objPtr)	::SetWindowLongPtr(hwnd, GWL_USERDATA, (LONG_PTR)objPtr)
+#define GET_OBJ_PTR_FROM_WINDOW(hwnd, theClass)	(theClass*)(LONG_PTR)::GetWindowLongPtr(hwnd, GWL_USERDATA)
+
+#define DEFINE_OBJ_PTR_FROM_WINDOW(hwnd, theClass, pObj)		\
+	theClass* pObj = GET_OBJ_PTR_FROM_WINDOW(hwnd, theClass);	\
+	ASSERT(pObj);
+
+
+/************************************************************************/
+/*                 		  应用程序唯一实例			 	            */
+/************************************************************************/
+
+class COnlyOneApp
+{
+public:
+	BOOL IsFirstApp	() {return m_bIsFirstApp;}
+	DWORD GetProcID	() {return m_dwProcID;}
+
+	COnlyOneApp(LPCTSTR pszAppFlag)
+	: m_dwProcID(0), m_bIsFirstApp(FALSE)
+	{
+		m_hMap = ::CreateFileMapping(INVALID_HANDLE_VALUE, nullptr, PAGE_READWRITE, 0, sizeof(DWORD), pszAppFlag);
+
+		if(m_hMap)
+		{
+			if(::GetLastError() != ERROR_ALREADY_EXISTS)
+			{
+				m_bIsFirstApp	= TRUE;
+				m_dwProcID		= ::GetCurrentProcessId();
+
+				LPVOID lpBuff	= ::MapViewOfFile(m_hMap, FILE_MAP_WRITE, 0, 0, sizeof(DWORD));
+				ASSERT(lpBuff);
+
+				memcpy(lpBuff, &m_dwProcID, sizeof(DWORD));
+				::UnmapViewOfFile(lpBuff);
+			}
+			else
+			{
+				m_bIsFirstApp	= FALSE;
+				LPVOID lpBuff	= ::MapViewOfFile(m_hMap, FILE_MAP_READ, 0, 0, sizeof(DWORD));
+				ASSERT(lpBuff);
+
+				memcpy(&m_dwProcID, lpBuff, sizeof(DWORD));
+				::UnmapViewOfFile(lpBuff);
+			}
+		}
+		else
+		{
+			ASSERT(FALSE);
+		}
+	}
+
+	~COnlyOneApp() {if(m_hMap) {::CloseHandle(m_hMap); m_hMap = nullptr;}}
+
+private:
+	HANDLE	m_hMap;
+	DWORD	m_dwProcID;
+	BOOL	m_bIsFirstApp;
+
+	DECLARE_NO_COPY_CLASS(COnlyOneApp)
+};
+
+class COnlyOneWndApp
+{
+public:
+	BOOL IsFirstApp()			{return m_hwndPre == nullptr;}
+	HWND GetPreInstanceWindow()	{return m_hwndPre;}
+
+	COnlyOneWndApp(LPCTSTR lpszClassName, LPCTSTR lpszWindowName = nullptr)
+	{
+		m_hwndPre = ::FindWindow(lpszClassName, lpszWindowName);
+	}
+
+private:
+	HWND m_hwndPre;
+
+	DECLARE_NO_COPY_CLASS(COnlyOneWndApp)
+};
+
+/************************************************************************/
+/*                   	句柄 (HANDLE) 智能包装器 		 		        */
+/************************************************************************/
+
+template<HANDLE NULL_VALUE>
+class auto_handle
+{
+public:
+	auto_handle(HANDLE h = NULL_VALUE)			{set(h);}
+	auto_handle(auto_handle<NULL_VALUE>& other)	{set(other.release());}
+
+	~auto_handle()	{reset();}
+
+	auto_handle<NULL_VALUE>& reset(HANDLE h = NULL_VALUE)
+	{
+		if(h != m_h)
+		{
+			if(is_valid())
+				VERIFY(::CloseHandle(m_h));
+
+			set(h);
+		}
+
+		return *this;
+	}
+
+	auto_handle<NULL_VALUE>& reset(auto_handle<NULL_VALUE>& other)
+	{
+		if(this != &other)
+			reset(other.release());
+
+		return *this;
+	}
+
+	HANDLE release()
+	{
+		HANDLE h = get();
+		set(NULL_VALUE);
+	
+		return h;
+	}
+
+	operator HANDLE	()	const	{return m_h;}
+	HANDLE get		()	const	{return m_h;}
+	HANDLE& get_ref	()	const	{return m_h;}
+	bool is_valid	()	const	{return m_h != NULL_VALUE;}
+
+	auto_handle<NULL_VALUE>& operator = (HANDLE h)							{return reset(h);}
+	auto_handle<NULL_VALUE>& operator = (auto_handle<NULL_VALUE>& other)	{return reset(other);}
+
+	bool operator == (HANDLE h)								const	{return m_h == h;}
+	bool operator != (HANDLE h)								const	{return !(operator == (h));	}
+	bool operator == (const auto_handle<NULL_VALUE>& other)	const	{return m_h == other.m_h;}
+	bool operator != (const auto_handle<NULL_VALUE>& other)	const	{return !(operator == (other));}
+
+private:
+	void set(HANDLE h)	{m_h = h;}
+
+	// ~! do not define these conversion, because it's very easy to making mistake !~
+	template<HANDLE _Other> auto_handle(const auto_handle<_Other>&);
+	template<HANDLE _Other> auto_handle<NULL_VALUE>& operator = (const auto_handle<_Other>&);
+
+private:
+	HANDLE	m_h;
+};
+
+typedef auto_handle<INVALID_HANDLE_VALUE>	auto_file_handle;	// 文件智能句柄
+typedef auto_handle<nullptr>				auto_res_handle;	// 普通资源智能句柄
+
+/************************************************************************/
+/*                 	  	 	DC 智能包装器 					            */
+/************************************************************************/
+
+class auto_dc
+{
+public:
+	auto_dc(HDC h = nullptr, HWND w = nullptr, bool is_create = false)
+	{
+		set(h, w, is_create);
+	}
+
+	auto_dc(auto_dc& other)
+	{
+		set(other.m_h, other.m_w, other.m_is_create);
+		other.release();
+	}
+
+	~auto_dc()	{reset();}
+
+	HDC GetDC(HWND hWnd)
+	{
+		HDC h = ::GetDC(hWnd);
+		reset(h, hWnd, false);
+
+		return h;
+	}
+
+	HDC GetWindowDC(HWND hWnd)
+	{
+		HDC h = ::GetWindowDC(hWnd);
+		reset(h, hWnd, false);
+
+		return h;
+	}
+
+	HDC GetDCEx(HWND hWnd, HRGN hrgnClip, DWORD flags)
+	{
+		HDC h = ::GetDCEx(hWnd, hrgnClip, flags);
+		reset(h, hWnd, false);
+
+		return h;
+	}
+
+	HDC CreateDC(LPCTSTR lpszDriver, LPCTSTR lpszDevice, LPCTSTR lpszOutput, CONST DEVMODE* lpInitData)
+	{
+		HDC h = ::CreateDC(lpszDriver, lpszDevice, lpszOutput, lpInitData);
+		reset(h, nullptr, true);
+
+		return h;
+	}
+
+	HDC CreateCompatibleDC(HDC hSrc)
+	{
+		HDC h = ::CreateCompatibleDC(hSrc);
+		reset(h, nullptr, true);
+
+		return h;
+	}
+
+	HGDIOBJ GetCurrentObject(UINT uObjectType)
+	{
+		return ::GetCurrentObject(m_h, uObjectType);
+	}
+
+	HBITMAP _GetCurrentBitmap()
+	{
+		return (HBITMAP)GetCurrentObject(OBJ_BITMAP);
+	}
+
+	HBRUSH _GetCurrentBrush()
+	{
+		return (HBRUSH)GetCurrentObject(OBJ_BRUSH);
+	}
+
+	HPALETTE _GetCurrentPalette()
+	{
+		return (HPALETTE)GetCurrentObject(OBJ_PAL);
+	}
+
+	HPEN _GetCurrentPen()
+	{
+		return (HPEN)GetCurrentObject(OBJ_PEN);
+	}
+
+	HFONT _GetCurrentFont()
+	{
+		return (HFONT)GetCurrentObject(OBJ_FONT);
+	}
+
+	int SelectClipRgn(HRGN hrgn)
+	{
+		return ::SelectClipRgn(m_h, hrgn);
+	}
+
+	int ExtSelectClipRgn(HRGN hrgn, int mode)
+	{
+		return ::ExtSelectClipRgn(m_h, hrgn, mode);
+	}
+
+	HGDIOBJ SelectObject(HGDIOBJ hgdiobj)
+	{
+		return ::SelectObject(m_h, hgdiobj);
+	}
+
+	HPALETTE SelectPalette(HPALETTE hpal, BOOL bForceBackground)
+	{
+		return ::SelectPalette(m_h, hpal, bForceBackground);
+	}
+
+	HBITMAP _SelectBitmap(HBITMAP hbm)
+	{
+		return (HBITMAP)SelectObject(hbm);
+	}
+
+	HBRUSH _SelectBrush(HBRUSH hbr)
+	{
+		return (HBRUSH)SelectObject(hbr);
+	}
+
+	HPEN _SelectPen(HPEN hpen)
+	{
+		return (HPEN)SelectObject(hpen);
+	}
+
+	HRGN _SelectRgn(HRGN hrgn)
+	{
+		return (HRGN)SelectObject(hrgn);
+	}
+
+	HFONT _SelectFont(HFONT hf)
+	{
+		return (HFONT)SelectObject(hf);
+	}
+
+	auto_dc& reset(HDC h = nullptr, HWND w = nullptr, bool is_create = false)
+	{
+		if(h != m_h || w != m_w)
+		{
+			if(is_valid())
+			{
+				if(m_is_create)
+					VERIFY(::DeleteDC(m_h));
+				else
+					VERIFY(::ReleaseDC(m_w, m_h));
+			}
+
+			set(h, w, is_create);
+		}
+
+		return *this;
+	}
+
+	auto_dc& reset(auto_dc& other)
+	{
+		if(this != &other)
+		{
+			reset(other.m_h, other.m_w, other.m_is_create);
+			other.release();
+		}
+
+		return *this;
+	}
+
+	HDC release()
+	{
+		HDC h = get_dc();
+		set(nullptr, nullptr, false);
+
+		return h;
+	}
+
+	/*
+	auto_dc& operator = (HDC h)
+	{
+		return reset(h);
+	}
+	*/
+
+	auto_dc& operator = (auto_dc& other)	{return reset(other);}
+
+	operator	HDC			()	const	{return m_h;}
+	HDC			get_dc		()	const	{return m_h;}
+	const HDC&	get_dc_ref	()	const	{return m_h;}
+	HWND		get_wnd		()	const	{return m_w;}
+	bool		is_valid	()	const	{return m_h != nullptr;}
+	bool		is_create	()	const	{return m_is_create;}
+
+private:
+	void set(HDC h, HWND w, bool is_create)
+	{
+		m_h			= h;
+		m_w			= w;
+		m_is_create	= is_create;
+	}
+
+private:
+	HDC		m_h;
+	HWND	m_w;
+	bool	m_is_create;
+};
+
+class paint_dc
+{
+public:
+	paint_dc(HWND hwnd) : m_hwnd(hwnd)
+	{
+		VERIFY(m_hdc = ::BeginPaint(m_hwnd, &m_ps));
+	}
+
+	~paint_dc()
+	{
+		VERIFY(::EndPaint(m_hwnd, &m_ps));
+	}
+
+	operator HDC ()	const	{return m_hdc;}
+	bool is_valid()	const	{return m_hdc != nullptr;}
+
+public:
+	PAINTSTRUCT	m_ps;
+	HWND		m_hwnd;
+	HDC			m_hdc;
+};
+/************************************************************************/
+/*                 	  	 	GDI Object 智能包装器 					    */
+/************************************************************************/
+
+template<class T>
+class auto_gdi_obj
+{
+public:
+	auto_gdi_obj(T obj = nullptr)				{set(obj);}
+	auto_gdi_obj(auto_gdi_obj<T>& other)	{set(other.release());}
+
+	~auto_gdi_obj()	{reset();}
+
+	auto_gdi_obj<T>& reset(T obj = nullptr)
+	{
+		if(obj != m_obj)
+		{
+			if(is_valid())
+			{
+				VERIFY(::DeleteObject(m_obj));
+			}
+
+			set(obj);
+		}
+
+		return *this;
+	}
+
+	auto_gdi_obj<T>& reset(auto_gdi_obj<T>& other)
+	{
+		if(this != &other)
+			reset(other.release());
+
+		return *this;
+	}
+
+	T release()
+	{
+		T obj = get();
+		set(nullptr);
+
+		return obj;
+	}
+
+	auto_gdi_obj<T>& operator = (T obj)						{return reset(obj);}
+	auto_gdi_obj<T>& operator = (auto_gdi_obj<T>& other)	{return reset(other);}
+
+	operator	T		()	const	{return m_obj;}
+	T			get		()	const	{return m_obj;}
+	const T&	get_ref	()	const	{return m_obj;}
+	bool		is_valid()	const	{return m_obj != nullptr;}
+
+private:
+	void set(T obj)	{m_obj = obj;}
+
+protected:
+	T m_obj;
+};
+
+typedef auto_gdi_obj<HBITMAP>		auto_bitmap_base;
+typedef auto_gdi_obj<HBRUSH>		auto_brush_base;
+typedef auto_gdi_obj<HPALETTE>		auto_palette_base;
+typedef auto_gdi_obj<HPEN>			auto_pen_base;
+typedef auto_gdi_obj<HRGN>			auto_rgn_base;
+typedef auto_gdi_obj<HFONT>			auto_font_base;
+
+class auto_bitmap : public auto_bitmap_base
+{
+public:
+	auto_bitmap(HBITMAP obj = nullptr) : auto_bitmap_base(obj) {}
+
+	auto_bitmap& operator = (HBITMAP obj)
+	{
+		return (auto_bitmap&)reset(obj);
+	}
+
+	HBITMAP CreateBitmap(int nWidth, int nHeight, UINT cPlanes, UINT cBitsPerPel, CONST VOID* lpvBits)
+	{
+		HBITMAP obj = ::CreateBitmap(nWidth, nHeight, cPlanes, cBitsPerPel, lpvBits);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBITMAP CreateBitmapIndirect(CONST BITMAP *lpbm)
+	{
+		HBITMAP obj = ::CreateBitmapIndirect(lpbm);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBITMAP CreateCompatibleBitmap(HDC hdc, int nWidth, int nHeight)
+	{
+		HBITMAP obj = ::CreateCompatibleBitmap(hdc, nWidth, nHeight);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBITMAP CreateDIBSection(HDC hdc, const BITMAPINFO* pbmi, UINT iUsage, void** ppvBits, HANDLE hSection, DWORD dwOffset)
+	{
+		HBITMAP obj = ::CreateDIBSection(hdc, pbmi, iUsage, ppvBits, hSection, dwOffset);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBITMAP LoadBitmap(HINSTANCE hInstance, LPCTSTR lpBitmapName)
+	{
+		HBITMAP obj = ::LoadBitmap(hInstance, lpBitmapName);
+		reset(obj);
+
+		return obj;
+	}
+
+	int GetBitmap(BITMAP* pBitMap)
+	{
+		ASSERT(m_obj != nullptr);
+		return ::GetObject(m_obj, sizeof(BITMAP), pBitMap);
+	}
+
+	int GetDIBSection(DIBSECTION* pDIBSection)
+	{
+		ASSERT(m_obj != nullptr);
+		return ::GetObject(m_obj, sizeof(DIBSECTION), pDIBSection);
+	}
+};
+
+class auto_brush : public auto_brush_base
+{
+public:
+	auto_brush(HBRUSH obj = nullptr) : auto_brush_base(obj) {}
+
+	auto_brush& operator = (HBRUSH obj)
+	{
+		return (auto_brush&)reset(obj);
+	}
+
+	HBRUSH CreateDIBPatternBrushPt(const void* lpPackedDIB, UINT iUsage)
+	{
+		HBRUSH obj = ::CreateDIBPatternBrushPt(lpPackedDIB, iUsage);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBRUSH CreatePatternBrush(HBITMAP hbmp)
+	{
+		HBRUSH obj = ::CreatePatternBrush(hbmp);
+		reset(obj);
+
+		return obj;
+	}
+
+	HBRUSH CreateSolidBrush(COLORREF crColor)
+	{
+		HBRUSH obj = ::CreateSolidBrush(crColor);
+		reset(obj);
+
+		return obj;
+	}
+
+	int GetLogBrush(LOGBRUSH* pLogBrush)
+	{
+		ASSERT(m_obj != nullptr);
+		return ::GetObject(m_obj, sizeof(LOGBRUSH), pLogBrush);
+	}
+};
+
+class auto_palette : public auto_palette_base
+{
+public:
+	auto_palette(HPALETTE obj = nullptr) : auto_palette_base(obj) {}
+
+	auto_palette& operator = (HPALETTE obj)
+	{
+		return (auto_palette&)reset(obj);
+	}
+
+	HPALETTE CreatePalette(CONST LOGPALETTE* lplgpl)
+	{
+		HPALETTE obj = ::CreatePalette(lplgpl);
+		reset(obj);
+
+		return obj;
+	}
+
+	int GetEntryCount()
+	{
+		ASSERT(m_obj != nullptr);
+
+		WORD nEntries;
+		::GetObject(m_obj, sizeof(WORD), &nEntries);
+		return (int)nEntries;
+	}
+};
+
+class auto_pen : public auto_pen_base
+{
+public:
+	auto_pen(HPEN obj = nullptr) : auto_pen_base(obj) {}
+
+	auto_pen& operator = (HPEN obj)
+	{
+		return (auto_pen&)reset(obj);
+	}
+
+	HPEN CreatePen(int fnPenStyle, int nWidth, COLORREF crColor)
+	{
+		HPEN obj = ::CreatePen(fnPenStyle, nWidth, crColor);
+		reset(obj);
+
+		return obj;
+	}
+
+	HPEN CreatePenIndirect(const LOGPEN* lplgpn)
+	{
+		HPEN obj = ::CreatePenIndirect(lplgpn);
+		reset(obj);
+
+		return obj;
+	}
+
+	int GetLogPen(LOGPEN* pLogPen)
+	{
+		ASSERT(m_obj != nullptr);
+		return ::GetObject(m_obj, sizeof(LOGPEN), pLogPen);
+	}
+};
+
+class auto_rgn : public auto_rgn_base
+{
+public:
+	auto_rgn(HRGN obj = nullptr) : auto_rgn_base(obj) {}
+
+	auto_rgn& operator = (HRGN obj)
+	{
+		return (auto_rgn&)reset(obj);
+	}
+
+	HRGN CreateRectRgn(int nLeftRect, int nTopRect, int nRightRect, int nBottomRect)
+	{
+		HRGN obj = ::CreateRectRgn(nLeftRect, nTopRect, nRightRect, nBottomRect);
+		reset(obj);
+
+		return obj;
+	}
+
+	HRGN CreateRectRgnIndirect(const RECT* lprc)
+	{
+		HRGN obj = ::CreateRectRgnIndirect(lprc);
+		reset(obj);
+
+		return obj;
+	}
+};
+
+class auto_font : public auto_font_base
+{
+public:
+	auto_font(HFONT obj = nullptr) : auto_font_base(obj) {}
+
+	auto_font& operator = (HFONT obj)
+	{
+		return (auto_font&)reset(obj);
+	}
+
+	HFONT CreateFont(
+						int nHeight,				// height of font
+						int nWidth,					// average character width
+						int nEscapement,			// angle of escapement
+						int nOrientation,			// base-line orientation angle
+						int fnWeight,				// font weight
+						DWORD bItalic,				// italic attribute option
+						DWORD bUnderline,			// underline attribute option
+						DWORD cStrikeOut,			// strikeout attribute option
+						DWORD nCharSet,				// character set identifier
+						DWORD nOutPrecision,		// output precision
+						DWORD nClipPrecision,		// clipping precision
+						DWORD nQuality,				// output quality
+						DWORD nPitchAndFamily,		// pitch and family
+						LPCTSTR lpszFace           // typeface name
+					)
+	{
+		HFONT obj = ::CreateFont(
+									nHeight,
+									nWidth,
+									nEscapement,
+									nOrientation,
+									fnWeight,
+									bItalic,
+									bUnderline,
+									cStrikeOut,
+									nCharSet,
+									nOutPrecision,
+									nClipPrecision,
+									nQuality,
+									nPitchAndFamily,
+									lpszFace
+								);
+		reset(obj);
+
+		return obj;
+	}
+
+	HFONT CreateFontIndirect(const LOGFONT* lplf)
+	{
+		HFONT obj = ::CreateFontIndirect(lplf);
+		reset(obj);
+
+		return obj;
+	}
+
+	int GetLogFont(LOGFONT* pLogFont)
+	{
+		ASSERT(m_obj != nullptr);
+		return ::GetObject(m_obj, sizeof(LOGFONT), pLogFont);
+	}
+};

socket/common/Src/bufferpool.cpp

@@ -0,0 +1,437 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/******************************************************************************
+Module:  BufferPool.cpp
+Notices: Copyright (c) 2013 Bruce Liang
+Purpose: ¼òµ¥Äڴ滺³å³Ø
+Desc:
+******************************************************************************/
+
+#include "stdafx.h"
+#include "bufferpool.h"
+#include "SysHelper.h"
+#include "WaitFor.h"
+
+const DWORD TItem::DEFAULT_ITEM_CAPACITY			= ::SysGetPageSize();
+const DWORD CBufferPool::DEFAULT_MAX_CACHE_SIZE		= 0;
+const DWORD CBufferPool::DEFAULT_ITEM_CAPACITY		= CItemPool::DEFAULT_ITEM_CAPACITY;
+const DWORD CBufferPool::DEFAULT_ITEM_POOL_SIZE		= CItemPool::DEFAULT_POOL_SIZE;
+const DWORD CBufferPool::DEFAULT_ITEM_POOL_HOLD		= CItemPool::DEFAULT_POOL_HOLD;
+const DWORD CBufferPool::DEFAULT_BUFFER_LOCK_TIME	= 10 * 1000;
+const DWORD CBufferPool::DEFAULT_BUFFER_POOL_SIZE	= 150;
+const DWORD CBufferPool::DEFAULT_BUFFER_POOL_HOLD	= 600;
+
+TItem* TItem::Construct(CPrivateHeap& heap, int capacity, BYTE* pData, int length)
+{
+	ASSERT(capacity > 0);
+
+	int item_size	= sizeof(TItem);
+	TItem* pItem	= (TItem*)heap.Alloc(item_size + capacity);
+	pItem->head		= (BYTE*)pItem + item_size;
+
+	pItem->TItem::TItem(heap, capacity, pData, length);
+
+	return pItem;
+}
+
+void TItem::Destruct(TItem* pItem)
+{
+	ASSERT(pItem != nullptr);
+
+	CPrivateHeap& heap = pItem->heap;
+	pItem->TItem::~TItem();
+	heap.Free(pItem);
+}
+
+inline int TItem::Cat(const BYTE* pData, int length)
+{
+	ASSERT(pData != nullptr && length > 0);
+
+	int cat = min(Remain(), length);
+
+	if(cat > 0)
+	{
+		memcpy(end, pData, cat);
+		end += cat;
+	}
+
+	return cat;
+}
+
+inline int TItem::Cat(const TItem& other)
+{
+	ASSERT(this != &other);
+	return Cat(other.Ptr(), other.Size());
+}
+
+inline int TItem::Fetch(BYTE* pData, int length)
+{
+	ASSERT(pData != nullptr && length > 0);
+
+	int fetch = min(Size(), length);
+	memcpy(pData, begin, fetch);
+	begin	 += fetch;
+
+	return fetch;
+}
+
+inline int TItem::Peek(BYTE* pData, int length)
+{
+	ASSERT(pData != nullptr && length > 0);
+
+	int peek = min(Size(), length);
+	memcpy(pData, begin, peek);
+
+	return peek;
+}
+
+inline int TItem::Reduce(int length)
+{
+	ASSERT(length > 0);
+
+	int reduce   = min(Size(), length);
+	begin		+= reduce;
+
+	return reduce;
+}
+
+inline void	TItem::Reset(int first, int last)
+{
+	ASSERT(first >= -1 && first <= capacity);
+	ASSERT(last >= -1 && last <= capacity);
+
+	if(first >= 0)	begin	= head + min(first, capacity);
+	if(last >= 0)	end		= head + min(last, capacity);
+}
+
+int TItemList::Cat(const BYTE* pData, int length)
+{
+	int remain = length;
+
+	while(remain > 0)
+	{
+		TItem* pItem = Back();
+
+		if(pItem == nullptr || pItem->IsFull())
+			pItem = PushBack(itPool.PickFreeItem());
+
+		int cat  = pItem->Cat(pData, remain);
+
+		pData	+= cat;
+		remain	-= cat;
+	}
+
+	return length;
+}
+
+int TItemList::Cat(const TItem* pItem)
+{
+	return Cat(pItem->Ptr(), pItem->Size());
+}
+
+int TItemList::Cat(const TItemList& other)
+{
+	ASSERT(this != &other);
+
+	int length = 0;
+
+	for(TItem* pItem = other.Front(); pItem != nullptr; pItem = pItem->next)
+		length += Cat(pItem);
+
+	return length;
+}
+
+int TItemList::Fetch(BYTE* pData, int length)
+{
+	int remain = length;
+
+	while(remain > 0 && Size() > 0)
+	{
+		TItem* pItem = Front();
+		int fetch	 = pItem->Fetch(pData, remain);
+
+		pData	+= fetch;
+		remain	-= fetch;
+
+		if(pItem->IsEmpty())
+			itPool.PutFreeItem(PopFront());
+	}
+
+	return length - remain;
+}
+
+int TItemList::Peek(BYTE* pData, int length)
+{
+	int remain	 = length;
+	TItem* pItem = Front();
+
+	while(remain > 0 && pItem != nullptr)
+	{
+		int peek = pItem->Peek(pData, remain);
+
+		pData	+= peek;
+		remain	-= peek;
+		pItem	 = pItem->next;
+	}
+
+	return length - remain;
+}
+
+int TItemList::Reduce(int length)
+{
+	int remain = length;
+
+	while(remain > 0 && Size() > 0)
+	{
+		TItem* pItem = Front();
+		remain		-= pItem->Reduce(remain);
+
+		if(pItem->IsEmpty())
+			itPool.PutFreeItem(PopFront());
+	}
+
+	return length - remain;
+}
+
+void TItemList::Release()
+{
+	itPool.PutFreeItem(*this);
+}
+
+TBuffer* TBuffer::Construct(CBufferPool& pool, ULONG_PTR dwID)
+{
+	ASSERT(dwID != 0);
+
+	CPrivateHeap& heap	= pool.GetPrivateHeap();
+	TBuffer* pBuffer	= (TBuffer*)heap.Alloc(sizeof(TBuffer));
+
+	pBuffer->TBuffer::TBuffer(heap, pool.GetItemPool(), dwID);
+
+	return pBuffer;
+}
+
+void TBuffer::Destruct(TBuffer* pBuffer)
+{
+	ASSERT(pBuffer != nullptr);
+
+	CPrivateHeap& heap = pBuffer->heap;
+	pBuffer->TBuffer::~TBuffer();
+	heap.Free(pBuffer);
+}
+
+inline void TBuffer::Reset()
+{
+	id		 = 0;
+	length	 = 0;
+	freeTime = ::TimeGetTime();
+}
+
+int TBuffer::Cat(const BYTE* pData, int len)
+{
+	items.Cat(pData, len);
+	return IncreaseLength(len);
+}
+
+int TBuffer::Cat(const TItem* pItem)
+{
+	items.Cat(pItem);
+	return IncreaseLength(pItem->Size());
+}
+
+int TBuffer::Cat(const TItemList& other)
+{
+	ASSERT(&items != &other);
+
+	for(TItem* pItem = other.Front(); pItem != nullptr; pItem = pItem->next)
+		Cat(pItem);
+
+	return length;
+}
+
+int TBuffer::Fetch(BYTE* pData, int len)
+{
+	int fetch = items.Fetch(pData, len);
+	DecreaseLength(fetch);
+
+	return fetch;
+}
+
+int TBuffer::Peek(BYTE* pData, int len)
+{
+	return items.Peek(pData, len);
+}
+
+int TBuffer::Reduce(int len)
+{
+	int reduce = items.Reduce(len);
+	DecreaseLength(reduce);
+
+	return reduce;
+}
+
+void CBufferPool::PutFreeBuffer(ULONG_PTR dwID)
+{
+	ASSERT(dwID != 0);
+
+	TBuffer* pBuffer = FindCacheBuffer(dwID);
+
+	if(pBuffer != nullptr)
+		PutFreeBuffer(pBuffer);
+}
+
+void CBufferPool::PutFreeBuffer(TBuffer* pBuffer)
+{
+	ASSERT(pBuffer != nullptr);
+
+	if(!pBuffer->IsValid())
+		return;
+
+	m_bfCache.Remove(pBuffer->ID());
+
+	BOOL bOK = FALSE;
+
+	{
+		CCriSecLock locallock(pBuffer->cs);
+
+		if(pBuffer->IsValid())
+		{
+			pBuffer->Reset();
+			bOK = TRUE;
+		}
+	}
+
+	if(bOK)
+	{
+		m_itPool.PutFreeItem(pBuffer->items);
+
+		if(!m_lsFreeBuffer.TryPut(pBuffer))
+		{
+			m_lsGCBuffer.PushBack(pBuffer);
+
+			if(m_lsGCBuffer.Size() > m_dwBufferPoolSize)
+				ReleaseGCBuffer();
+		}
+	}
+}
+
+void CBufferPool::ReleaseGCBuffer(BOOL bForce)
+{
+	TBuffer* pBuffer = nullptr;
+	DWORD now		 = ::TimeGetTime();
+
+	while(m_lsGCBuffer.PopFront(&pBuffer))
+	{
+		if(bForce || (int)(now - pBuffer->freeTime) >= (int)m_dwBufferLockTime)
+			TBuffer::Destruct(pBuffer);
+		else
+		{
+			m_lsGCBuffer.PushBack(pBuffer);
+			break;
+		}
+	}
+}
+
+TBuffer* CBufferPool::PutCacheBuffer(ULONG_PTR dwID)
+{
+	ASSERT(dwID != 0);
+
+	TBuffer* pBuffer = PickFreeBuffer(dwID);
+	m_bfCache.Set(dwID, pBuffer);
+
+	return pBuffer;
+}
+
+TBuffer* CBufferPool::PickFreeBuffer(ULONG_PTR dwID)
+{
+	ASSERT( dwID != 0);
+
+	DWORD dwIndex;
+	TBuffer* pBuffer = nullptr;
+
+	if(m_lsFreeBuffer.TryLock(&pBuffer, dwIndex))
+	{
+		if(::GetTimeGap32(pBuffer->freeTime) >= m_dwBufferLockTime)
+			VERIFY(m_lsFreeBuffer.ReleaseLock(nullptr, dwIndex));
+		else
+		{
+			VERIFY(m_lsFreeBuffer.ReleaseLock(pBuffer, dwIndex));
+			pBuffer = nullptr;
+		}
+	}
+
+	if(pBuffer)	pBuffer->id	= dwID;
+	else		pBuffer		= TBuffer::Construct(*this, dwID);
+
+	ASSERT(pBuffer);
+	return pBuffer;
+}
+
+TBuffer* CBufferPool::FindCacheBuffer(ULONG_PTR dwID)
+{
+	ASSERT(dwID != 0);
+
+	TBuffer* pBuffer = nullptr;
+
+	if(m_bfCache.Get(dwID, &pBuffer) != TBufferCache::GR_VALID)
+		pBuffer = nullptr;
+
+	return pBuffer;
+}
+
+void CBufferPool::Prepare()
+{
+	m_itPool.Prepare();
+
+	m_bfCache.Reset(m_dwMaxCacheSize);
+	m_lsFreeBuffer.Reset(m_dwBufferPoolHold);
+}
+
+void CBufferPool::Clear()
+{
+	DWORD size					= 0;
+	unique_ptr<ULONG_PTR[]> ids	= m_bfCache.GetAllElementIndexes(size, FALSE);
+
+	for(DWORD i = 0; i < size; i++)
+	{
+		TBuffer* pBuffer = FindCacheBuffer(ids[i]);
+		if(pBuffer) TBuffer::Destruct(pBuffer);
+	}
+
+	m_bfCache.Reset();
+
+	TBuffer* pBuffer = nullptr;
+
+	while(m_lsFreeBuffer.TryGet(&pBuffer))
+		TBuffer::Destruct(pBuffer);
+
+	VERIFY(m_lsFreeBuffer.IsEmpty());
+	m_lsFreeBuffer.Reset();
+
+	ReleaseGCBuffer(TRUE);
+	VERIFY(m_lsGCBuffer.IsEmpty());
+
+	m_itPool.Clear();
+	m_heap.Reset();
+}

socket/common/Src/bufferpool.h

@@ -0,0 +1,683 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+/******************************************************************************
+Module:  BufferPool.h
+Notices: Copyright (c) 2013 Bruce Liang
+Purpose: ¼òµ¥Äڴ滺³å³Ø
+Desc:
+******************************************************************************/
+
+#pragma once
+
+#include "Singleton.h"
+#include "STLHelper.h"
+#include "RingBuffer.h"
+#include "PrivateHeap.h"
+
+struct TItem
+{
+	template<typename T> friend struct	TSimpleList;
+	template<typename T> friend class	CNodePoolT;
+
+	friend struct	TItemList;
+	friend struct	TBuffer;
+
+public:
+	inline int Cat		(const BYTE* pData, int length);
+	inline int Cat		(const TItem& other);
+	inline int Fetch	(BYTE* pData, int length);
+	inline int Peek		(BYTE* pData, int length);
+	inline int Reduce	(int length);
+	inline void	Reset	(int first = 0, int last = 0);
+
+	BYTE*		Ptr		()			{return begin;}
+	const BYTE*	Ptr		()	const	{return begin;}
+	int			Size	()	const	{return (int)(end - begin);}
+	int			Remain	()	const	{return capacity - (int)(end - head);}
+	int			Capacity()	const	{return capacity;}
+	bool		IsEmpty	()	const	{return Size()	 == 0;}
+	bool		IsFull	()	const	{return Remain() == 0;}
+
+public:
+	operator		BYTE*	()			{return Ptr();}
+	operator const	BYTE*	() const	{return Ptr();}
+
+public:
+	static TItem* Construct(CPrivateHeap& heap,
+							int		capacity	= DEFAULT_ITEM_CAPACITY,
+							BYTE*	pData		= nullptr,
+							int		length		= 0);
+
+	static void Destruct(TItem* pItem);
+
+private:
+	TItem(CPrivateHeap& hp, int cap = DEFAULT_ITEM_CAPACITY, BYTE* pData = nullptr, int length = 0)
+	: heap(hp), capacity(cap), begin(head), end(head), next(nullptr), last(nullptr)
+	{
+		if(pData != nullptr && length != 0)
+			Cat(pData, length);
+	}
+
+	~TItem() {}
+
+	DECLARE_NO_COPY_CLASS(TItem)
+
+public:
+	static const DWORD DEFAULT_ITEM_CAPACITY;
+
+private:
+	CPrivateHeap& heap;
+
+private:
+	TItem* next;
+	TItem* last;
+
+	int		capacity;
+	BYTE*	head;
+	BYTE*	begin;
+	BYTE*	end;
+};
+
+template<class T> struct TSimpleList
+{
+public:
+	T* PushFront(T* pItem)
+	{
+		if(pFront != nullptr)
+		{
+			pFront->last = pItem;
+			pItem->next	 = pFront;
+		}
+		else
+		{
+			pItem->last = nullptr;
+			pItem->next = nullptr;
+			pBack		= pItem;
+		}
+
+		pFront = pItem;
+		++size;
+
+		return pItem;
+	}
+
+	T* PushBack(T* pItem)
+	{
+		if(pBack != nullptr)
+		{
+			pBack->next	= pItem;
+			pItem->last	= pBack;
+		}
+		else
+		{
+			pItem->last = nullptr;
+			pItem->next = nullptr;
+			pFront		= pItem;
+		}
+
+		pBack = pItem;
+		++size;
+
+		return pItem;
+	}
+
+	T* PopFront()
+	{
+		T* pItem = pFront;
+
+		if(pFront != pBack)
+		{
+			pFront = pFront->next;
+			pFront->last = nullptr;
+		}
+		else if(pFront != nullptr)
+		{
+			pFront	= nullptr;
+			pBack	= nullptr;
+		}
+
+		if(pItem != nullptr)
+		{
+			pItem->next = nullptr;
+			pItem->last = nullptr;
+
+			--size;
+		}
+
+		return pItem;
+	}
+
+	T* PopBack()
+	{
+		T* pItem = pBack;
+
+		if(pFront != pBack)
+		{
+			pBack = pBack->last;
+			pBack->next	= nullptr;
+		}
+		else if(pBack != nullptr)
+		{
+			pFront	= nullptr;
+			pBack	= nullptr;
+		}
+
+		if(pItem != nullptr)
+		{
+			pItem->next = nullptr;
+			pItem->last = nullptr;
+
+			--size;
+		}
+
+		return pItem;
+	}
+
+	TSimpleList<T>& Shift(TSimpleList<T>& other)
+	{
+		if(&other != this && other.size > 0)
+		{
+			if(size > 0)
+			{
+				pBack->next = other.pFront;
+				other.pFront->last = pBack;
+			}
+			else
+			{
+				pFront = other.pFront;
+			}
+
+			pBack	 = other.pBack;
+			size	+= other.size;
+
+			other.Reset();
+		}
+
+		return *this;
+	}
+
+	void Clear()
+	{
+		if(size > 0)
+		{
+			T* pItem;
+			while((pItem = PopFront()) != nullptr)
+				T::Destruct(pItem);
+		}
+	}
+
+	T*		Front	()	const	{return pFront;}
+	T*		Back	()	const	{return pBack;}
+	int		Size	()	const	{return size;}
+	bool	IsEmpty	()	const	{return size == 0;}
+
+public:
+	TSimpleList()	{Reset();}
+	~TSimpleList()	{Clear();}
+
+	DECLARE_NO_COPY_CLASS(TSimpleList<T>)
+
+private:
+	void Reset()
+	{
+		pFront	= nullptr;
+		pBack	= nullptr;
+		size	= 0;
+	}
+
+private:
+	int	size;
+	T*	pFront;
+	T*	pBack;
+};
+
+template<class T> class CNodePoolT
+{
+public:
+	void PutFreeItem(T* pItem)
+	{
+		ASSERT(pItem != nullptr);
+
+		if(!m_lsFreeItem.TryPut(pItem))
+			T::Destruct(pItem);
+	}
+
+	void PutFreeItem(TSimpleList<T>& lsItem)
+	{
+		if(lsItem.IsEmpty())
+			return;
+
+		T* pItem;
+		while((pItem = lsItem.PopFront()) != nullptr)
+			PutFreeItem(pItem);
+	}
+
+	T* PickFreeItem()
+	{
+		T* pItem = nullptr;
+
+		if(m_lsFreeItem.TryGet(&pItem))
+			pItem->Reset();
+		else
+			pItem = T::Construct(m_heap, m_dwItemCapacity);
+
+		return pItem;
+	}
+
+	inline void Prepare()
+	{
+		m_lsFreeItem.Reset(m_dwPoolHold);
+	}
+
+	inline void Clear()
+	{
+		T* pItem = nullptr;
+
+		while(m_lsFreeItem.TryGet(&pItem))
+			T::Destruct(pItem);
+
+		VERIFY(m_lsFreeItem.IsEmpty());
+		m_lsFreeItem.Reset();
+
+		m_heap.Reset();
+	}
+
+public:
+	void SetItemCapacity(DWORD dwItemCapacity)	{m_dwItemCapacity	= dwItemCapacity;}
+	void SetPoolSize	(DWORD dwPoolSize)		{m_dwPoolSize		= dwPoolSize;}
+	void SetPoolHold	(DWORD dwPoolHold)		{m_dwPoolHold		= dwPoolHold;}
+	DWORD GetItemCapacity	()					{return m_dwItemCapacity;}
+	DWORD GetPoolSize		()					{return m_dwPoolSize;}
+	DWORD GetPoolHold		()					{return m_dwPoolHold;}
+
+public:
+	CNodePoolT(	DWORD dwPoolSize	 = DEFAULT_POOL_SIZE,
+				DWORD dwPoolHold	 = DEFAULT_POOL_HOLD,
+				DWORD dwItemCapacity = DEFAULT_ITEM_CAPACITY)
+				: m_dwPoolSize(dwPoolSize)
+				, m_dwPoolHold(dwPoolHold)
+				, m_dwItemCapacity(dwItemCapacity)
+	{
+	}
+
+	~CNodePoolT()	{Clear();}
+
+	DECLARE_NO_COPY_CLASS(CNodePoolT)
+
+public:
+	static const DWORD DEFAULT_ITEM_CAPACITY;
+	static const DWORD DEFAULT_POOL_SIZE;
+	static const DWORD DEFAULT_POOL_HOLD;
+
+private:
+	CPrivateHeap	m_heap;
+
+	DWORD			m_dwItemCapacity;
+	DWORD			m_dwPoolSize;
+	DWORD			m_dwPoolHold;
+
+	CRingPool<T>	m_lsFreeItem;
+};
+
+template<class T> const DWORD CNodePoolT<T>::DEFAULT_ITEM_CAPACITY	= TItem::DEFAULT_ITEM_CAPACITY;
+template<class T> const DWORD CNodePoolT<T>::DEFAULT_POOL_SIZE		= 300;
+template<class T> const DWORD CNodePoolT<T>::DEFAULT_POOL_HOLD		= 1200;
+
+typedef CNodePoolT<TItem>	CItemPool;
+
+struct TItemList : public TSimpleList<TItem>
+{
+public:
+	int Cat		(const BYTE* pData, int length);
+	int Cat		(const TItem* pItem);
+	int Cat		(const TItemList& other);
+	int Fetch	(BYTE* pData, int length);
+	int Peek	(BYTE* pData, int length);
+	int Reduce	(int length);
+	void Release();
+
+public:
+	TItemList(CItemPool& pool) : itPool(pool)
+	{
+	}
+
+private:
+	CItemPool& itPool;
+};
+
+struct TItemListEx : public TItemList
+{
+public:
+	TItem* PushFront(TItem* pItem)
+	{
+		length += pItem->Size();
+		return __super::PushFront(pItem);
+	}
+
+	TItem* PushBack(TItem* pItem)
+	{
+		length += pItem->Size();
+		return __super::PushBack(pItem);
+	}
+
+	TItem* PopFront()
+	{
+		TItem* pItem = __super::PopFront();
+
+		if(pItem != nullptr)
+			length -= pItem->Size();
+
+		return pItem;
+	}
+
+	TItem* PopBack()
+	{
+		TItem* pItem = __super::PopBack();
+
+		if(pItem != nullptr)
+			length -= pItem->Size();
+
+		return pItem;
+	}
+
+	TItemListEx& Shift(TItemListEx& other)
+	{
+		if(&other != this && other.length > 0)
+		{
+			length += other.length;
+			other.length = 0;
+
+			__super::Shift(other);
+		}
+
+		return *this;
+	}
+
+	void Clear()
+	{
+		__super::Clear();
+		length = 0;
+	}
+
+	void Release()
+	{
+		__super::Release();
+		length = 0;
+	}
+
+public:
+	int Cat(const BYTE* pData, int length)
+	{
+		int cat = __super::Cat(pData, length);
+		this->length += cat;
+
+		return cat;
+	}
+
+	int Cat(const TItem* pItem)
+	{
+		int cat = __super::Cat(pItem->Ptr(), pItem->Size());
+		this->length += cat;
+
+		return cat;
+	}
+
+	int Cat(const TItemList& other)
+	{
+		int cat = __super::Cat(other);
+		this->length += cat;
+
+		return cat;
+	}
+
+	int Fetch(BYTE* pData, int length)
+	{
+		int fetch	  = __super::Fetch(pData, length);
+		this->length -= fetch;
+
+		return fetch;
+	}
+
+	int Reduce(int length)
+	{
+		int reduce	  = __super::Reduce(length);
+		this->length -= reduce;
+
+		return reduce;
+	}
+	
+	int Length() const {return length;}
+
+public:
+	TItemListEx(CItemPool& pool) : TItemList(pool), length(0)
+	{
+	}
+
+	~TItemListEx()
+	{
+		ASSERT(length >= 0);
+	}
+
+	DECLARE_NO_COPY_CLASS(TItemListEx)
+
+private:
+	int length;
+};
+
+struct TItemPtr
+{
+public:
+	TItem* Reset(TItem* pItem = nullptr)
+	{
+		if(m_pItem != nullptr)
+			itPool.PutFreeItem(m_pItem);
+
+		m_pItem = pItem;
+
+		return m_pItem;
+	}
+
+	TItem* Attach(TItem* pItem)
+	{
+		return Reset(pItem);
+	}
+
+	TItem* Detach()
+	{
+		TItem* pItem = m_pItem;
+		m_pItem		 = nullptr;
+
+		return pItem;
+	}
+
+	bool IsValid			()				{return m_pItem != nullptr;}
+	TItem* operator ->		()				{return m_pItem;}
+	TItem* operator =		(TItem* pItem)	{return Reset(pItem);}
+	operator TItem*			()				{return m_pItem;}
+	TItem* Ptr				()				{return m_pItem;}
+	const TItem* Ptr		()	const		{return m_pItem;}
+	operator const TItem*	()	const		{return m_pItem;}
+
+public:
+	TItemPtr(CItemPool& pool, TItem* pItem = nullptr)
+	: itPool(pool), m_pItem(pItem)
+	{
+
+	}
+
+	~TItemPtr()
+	{
+		Reset();
+	}
+
+	DECLARE_NO_COPY_CLASS(TItemPtr)
+
+private:
+	CItemPool&	itPool;
+	TItem*		m_pItem;
+};
+
+struct TBuffer
+{
+	template<typename T> friend struct TSimpleList;
+	friend class CBufferPool;
+
+public:
+	static TBuffer* Construct(CBufferPool& pool, ULONG_PTR dwID);
+	static void Destruct(TBuffer* pBuffer);
+
+public:
+	int Cat		(const BYTE* pData, int len);
+	int Cat		(const TItem* pItem);
+	int Cat		(const TItemList& other);
+	int Fetch	(BYTE* pData, int length);
+	int Peek	(BYTE* pData, int length);
+	int Reduce	(int len);
+
+public:
+	CCriSec&	CriSec	()	{return cs;}
+	TItemList&	ItemList()	{return items;}
+
+	ULONG_PTR ID		()	const	{return id;}
+	int Length			()	const	{return length;}
+	bool IsValid		()	const	{return id != 0;}
+
+private:
+	int IncreaseLength	(int len)	{return (length += len);}
+	int DecreaseLength	(int len)	{return (length -= len);}
+
+	inline void Reset	();
+
+private:
+	TBuffer(CPrivateHeap& hp, CItemPool& itPool, ULONG_PTR dwID = 0)
+	: heap(hp), items(itPool), id(dwID), length(0)
+	{
+	}
+
+	~TBuffer()	{}
+
+	DECLARE_NO_COPY_CLASS(TBuffer)
+
+private:
+	CPrivateHeap&	heap;
+
+private:
+	ULONG_PTR		id;
+	int				length;
+	DWORD			freeTime;
+
+private:
+	TBuffer*		next;
+	TBuffer*		last;
+
+	CCriSec			cs;
+	TItemList		items;
+};
+
+class CBufferPool
+{
+	typedef CRingPool<TBuffer>						TBufferList;
+	typedef CCASQueue<TBuffer>						TBufferQueue;
+
+	typedef CRingCache2<TBuffer, ULONG_PTR, true>	TBufferCache;
+
+public:
+	void		PutFreeBuffer	(ULONG_PTR dwID);
+	TBuffer*	PutCacheBuffer	(ULONG_PTR dwID);
+	TBuffer*	FindCacheBuffer	(ULONG_PTR dwID);
+	TBuffer*	PickFreeBuffer	(ULONG_PTR dwID);
+	void		PutFreeBuffer	(TBuffer* pBuffer);
+
+	void		Prepare			();
+	void		Clear			();
+
+private:
+	void ReleaseGCBuffer	(BOOL bForce = FALSE);
+
+public:
+	void SetItemCapacity	(DWORD dwItemCapacity)		{m_itPool.SetItemCapacity(dwItemCapacity);}
+	void SetItemPoolSize	(DWORD dwItemPoolSize)		{m_itPool.SetPoolSize(dwItemPoolSize);}
+	void SetItemPoolHold	(DWORD dwItemPoolHold)		{m_itPool.SetPoolHold(dwItemPoolHold);}
+
+	void SetMaxCacheSize	(DWORD dwMaxCacheSize)		{m_dwMaxCacheSize	= dwMaxCacheSize;}
+	void SetBufferLockTime	(DWORD dwBufferLockTime)	{m_dwBufferLockTime	= dwBufferLockTime;}
+	void SetBufferPoolSize	(DWORD dwBufferPoolSize)	{m_dwBufferPoolSize	= dwBufferPoolSize;}
+	void SetBufferPoolHold	(DWORD dwBufferPoolHold)	{m_dwBufferPoolHold	= dwBufferPoolHold;}
+
+	DWORD GetItemCapacity	()							{return m_itPool.GetItemCapacity();}
+	DWORD GetItemPoolSize	()							{return m_itPool.GetPoolSize();}
+	DWORD GetItemPoolHold	()							{return m_itPool.GetPoolHold();}
+
+	DWORD GetMaxCacheSize	()							{return m_dwMaxCacheSize;}
+	DWORD GetBufferLockTime	()							{return m_dwBufferLockTime;}
+	DWORD GetBufferPoolSize	()							{return m_dwBufferPoolSize;}
+	DWORD GetBufferPoolHold	()							{return m_dwBufferPoolHold;}
+
+	TBuffer* operator []	(ULONG_PTR dwID)			{return FindCacheBuffer(dwID);}
+
+public:
+	CBufferPool(DWORD dwPoolSize	 = DEFAULT_BUFFER_POOL_SIZE,
+				DWORD dwPoolHold	 = DEFAULT_BUFFER_POOL_HOLD,
+				DWORD dwLockTime	 = DEFAULT_BUFFER_LOCK_TIME,
+				DWORD dwMaxCacheSize = DEFAULT_MAX_CACHE_SIZE)
+	: m_dwBufferPoolSize(dwPoolSize)
+	, m_dwBufferPoolHold(dwPoolHold)
+	, m_dwBufferLockTime(dwLockTime)
+	, m_dwMaxCacheSize(dwMaxCacheSize)
+	{
+
+	}
+
+	~CBufferPool()	{Clear();}
+
+	DECLARE_NO_COPY_CLASS(CBufferPool)
+
+public:
+	CPrivateHeap&	GetPrivateHeap()	{return m_heap;}
+	CItemPool&		GetItemPool()		{return m_itPool;}
+
+public:
+	static const DWORD DEFAULT_MAX_CACHE_SIZE;
+	static const DWORD DEFAULT_ITEM_CAPACITY;
+	static const DWORD DEFAULT_ITEM_POOL_SIZE;
+	static const DWORD DEFAULT_ITEM_POOL_HOLD;
+	static const DWORD DEFAULT_BUFFER_LOCK_TIME;
+	static const DWORD DEFAULT_BUFFER_POOL_SIZE;
+	static const DWORD DEFAULT_BUFFER_POOL_HOLD;
+
+private:
+	DWORD			m_dwMaxCacheSize;
+	DWORD			m_dwBufferLockTime;
+	DWORD			m_dwBufferPoolSize;
+	DWORD			m_dwBufferPoolHold;
+
+	CPrivateHeap	m_heap;
+	CItemPool		m_itPool;
+
+	TBufferCache	m_bfCache;
+
+	TBufferList		m_lsFreeBuffer;
+	TBufferQueue	m_lsGCBuffer;
+};

socket/common/Src/bufferptr.cpp

@@ -0,0 +1,26 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "stdafx.h"
+#include "bufferptr.h"

socket/common/Src/bufferptr.h

@@ -0,0 +1,184 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <memory.h>
+#include <malloc.h>
+
+template<class T, size_t MAX_CACHE_SIZE = 0>
+class CBufferPtrT
+{
+public:
+	explicit CBufferPtrT(size_t size = 0, bool zero = false)		{Reset(); Malloc(size, zero);}
+	explicit CBufferPtrT(const T* pch, size_t size)					{Reset(); Copy(pch, size);}
+	CBufferPtrT(const CBufferPtrT& other)							{Reset(); Copy(other);}
+	template<size_t S> CBufferPtrT(const CBufferPtrT<T, S>& other)	{Reset(); Copy(other);}
+
+	~CBufferPtrT() {Free();}
+
+	T* Malloc(size_t size = 1, bool zero = false)
+	{
+		Free();
+		return Alloc(size, zero, false);
+	}
+
+	T* Realloc(size_t size, bool zero = false)
+	{
+		return Alloc(size, zero, true);
+	}
+
+	void Free()
+	{
+		if(m_pch)
+		{
+			free(m_pch);
+			Reset();
+		}
+	}
+
+	template<size_t S> CBufferPtrT& Copy(const CBufferPtrT<T, S>& other)
+	{
+		if((void*)&other != (void*)this)
+			Copy(other.Ptr(), other.Size());
+
+		return *this;
+	}
+
+	CBufferPtrT& Copy(const T* pch, size_t size)
+	{
+		Malloc(size);
+
+		if(m_pch)
+			memcpy(m_pch, pch, size * sizeof(T));
+
+		return *this;
+	}
+
+	template<size_t S> CBufferPtrT& Cat(const CBufferPtrT<T, S>& other)
+	{
+		if((void*)&other != (void*)this)
+			Cat(other.Ptr(), other.Size());
+
+		return *this;
+	}
+
+	CBufferPtrT& Cat(const T* pch, size_t size = 1)
+	{
+		size_t pre_size = m_size;
+		Realloc(m_size + size);
+
+		if(m_pch)
+			memcpy(m_pch + pre_size, pch, size * sizeof(T));
+
+		return *this;
+	}
+
+	template<size_t S> bool Equal(const CBufferPtrT<T, S>& other) const
+	{
+		if((void*)&other == (void*)this)
+			return true;
+		else if(m_size != other.Size())
+			return false;
+		else if(m_size == 0)
+			return true;
+		else
+			return (memcmp(m_pch, other.Ptr(), m_size * sizeof(T)) == 0);
+	}
+
+	bool Equal(T* pch) const
+	{
+		if(m_pch == pch)
+			return true;
+		else if(!m_pch || !pch)
+			return false;
+		else
+			return (memcmp(m_pch, pch, m_size * sizeof(T)) == 0);
+	}
+
+	T*			Ptr()					{return m_pch;}
+	const T*	Ptr()			const	{return m_pch;}
+	T&			Get(int i)				{return *(m_pch + i);}
+	const T&	Get(int i)		const	{return *(m_pch + i);}
+	size_t		Size()			const	{return m_size;}
+	bool		IsValid()		const	{return m_pch != 0;}
+
+	operator							T*	()									{return Ptr();}
+	operator const						T*	()			const					{return Ptr();}
+	T& operator							[]	(int i)								{return Get(i);}
+	const T& operator					[]	(int i)		const					{return Get(i);}
+	bool operator						==	(T* pv)		const					{return Equal(pv);}
+	template<size_t S> bool operator	==	(const CBufferPtrT<T, S>& other)	{return Equal(other);}
+	CBufferPtrT& operator				=	(const CBufferPtrT& other)			{return Copy(other);}
+	template<size_t S> CBufferPtrT& operator = (const CBufferPtrT<T, S>& other)	{return Copy(other);}
+
+private:
+	void Reset()						{m_pch = 0; m_size = 0; m_capacity = 0;}
+	size_t GetAllocSize(size_t size)	{return max(size, min(size * 2, m_size + MAX_CACHE_SIZE));}
+
+	T* Alloc(size_t size, bool zero = false, bool is_realloc = false)
+	{
+		if(size >= 0 && size != m_size)
+		{
+			size_t rsize = GetAllocSize(size);
+			if(size > m_capacity || rsize < m_size)
+			{
+				m_pch = is_realloc							?
+					(T*)realloc(m_pch, rsize * sizeof(T))	:
+					(T*)malloc(rsize * sizeof(T))			;
+
+				if(m_pch || rsize == 0)
+				{
+					m_size		= size;
+					m_capacity	= rsize;
+				}
+				else
+					Reset();
+			}
+			else
+				m_size = size;
+		}
+
+		if(zero && m_pch)
+			memset(m_pch, 0, m_size * sizeof(T));
+
+		return m_pch;
+	}
+
+private:
+	T*		m_pch;
+	size_t	m_size;
+	size_t	m_capacity;
+};
+
+typedef CBufferPtrT<char>			CCharBufferPtr;
+typedef CBufferPtrT<wchar_t>		CWCharBufferPtr;
+typedef CBufferPtrT<unsigned char>	CByteBufferPtr;
+typedef CByteBufferPtr				CBufferPtr;
+
+#ifdef _UNICODE
+	typedef CWCharBufferPtr			CTCharBufferPtr;
+#else
+	typedef CCharBufferPtr			CTCharBufferPtr;
+#endif

socket/common/Src/debug/win32_crtdbg.cpp

@@ -0,0 +1,32 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#include "stdafx.h"
+#include "win32_crtdbg.h"
+
+#if defined _DEBUG && defined _DETECT_MEMORY_LEAK
+
+__dbg_impl::CDebugEnv __dbgEnv;
+
+#endif // _DEBUG && defined _DETECT_MEMORY_LEAK

socket/common/Src/debug/win32_crtdbg.h

@@ -0,0 +1,143 @@
+/*
+ * Copyright: JessMA Open Source (ldcsaa@gmail.com)
+ *
+ * Version	: 2.3.18
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+#pragma once
+
+#if defined _DEBUG && defined _DETECT_MEMORY_LEAK
+
+#ifdef new
+	#undef new
+#endif
+
+#ifdef delete
+	#undef delete
+#endif
+
+#ifndef _CRTDBG_MAP_ALLOC
+	#define _CRTDBG_MAP_ALLOC
+#endif
+
+#include <crtdbg.h>
+
+namespace __dbg_impl
+{
+	class CDebugEnv
+	{
+	public:
+		CDebugEnv()
+		{
+			::_CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
+			::_CrtMemCheckpoint(&s1);
+		}
+
+		~CDebugEnv()
+		{
+			::_CrtMemCheckpoint(&s2);
+
+			if (::_CrtMemDifference( &s3, &s1, &s2))
+			{
+				TRACE("!! Memory stats !!\n");
+				TRACE("----------------------------------------\n");
+				::_CrtMemDumpStatistics(&s3);
+				TRACE("----------------------------------------\n");
+			}
+		}
+
+	private:
+		_CrtMemState s1, s2, s3;
+	};
+
+	static __dbg_impl::CDebugEnv __dbgEnv;
+}
+
+#pragma warning(push)
+#pragma warning(disable: 4595)
+
+inline void* __cdecl operator new(size_t nSize, const char* lpszFileName, int nLine)
+{
+	// __dbg_impl::CGuard guard;
+	return ::_malloc_dbg(nSize, _NORMAL_BLOCK, lpszFileName, nLine);
+}
+
+inline void* __cdecl operator new[](size_t nSize, const char* lpszFileName, int nLine)
+{
+	return operator new(nSize, lpszFileName, nLine);
+}
+
+inline void* __cdecl operator new(size_t nSize)
+{
+	return operator new(nSize, __FILE__, __LINE__);
+}
+
+inline void* __cdecl operator new[](size_t nSize)
+{
+	return operator new(nSize, __FILE__, __LINE__);
+}
+
+inline void* __cdecl operator new(size_t nSize, const std::nothrow_t&)
+{
+	return operator new(nSize, __FILE__, __LINE__);
+}
+
+inline void* __cdecl operator new[](size_t nSize, const std::nothrow_t&)
+{
+	return operator new(nSize, __FILE__, __LINE__);
+}
+
+inline void __cdecl operator delete(void* p)
+{
+	// __dbg_impl::CGuard guard;
+	::_free_dbg(p, _NORMAL_BLOCK);
+}
+
+inline void __cdecl operator delete[](void* p)
+{
+	operator delete(p);
+}
+
+inline void __cdecl operator delete(void* p, const char* lpszFileName, int nLine)
+{
+	operator delete(p);
+}
+
+inline void __cdecl operator delete[](void* p, const char* lpszFileName, int nLine)
+{
+	operator delete(p);
+}
+
+inline void __cdecl operator delete(void *p, const std::nothrow_t&)
+{
+	operator delete(p);
+}
+
+inline void __cdecl operator delete[](void *p, const std::nothrow_t&)
+{
+	operator delete(p);
+}
+
+#pragma warning(pop)
+
+#define new new(__FILE__, __LINE__)
+
+#endif // _DEBUG && defined _DETECT_MEMORY_LEAK

websocketForMt4.sln

@@ -0,0 +1,28 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 14
+VisualStudioVersion = 14.0.25420.1
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "websocketForMt4", "websocketForMt4\websocketForMt4.vcxproj", "{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|x64 = Debug|x64
+		Debug|x86 = Debug|x86
+		Release|x64 = Release|x64
+		Release|x86 = Release|x86
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Debug|x64.ActiveCfg = Debug|x64
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Debug|x64.Build.0 = Debug|x64
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Debug|x86.ActiveCfg = Debug|Win32
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Debug|x86.Build.0 = Debug|Win32
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Release|x64.ActiveCfg = Release|x64
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Release|x64.Build.0 = Release|x64
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Release|x86.ActiveCfg = Release|Win32
+		{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}.Release|x86.Build.0 = Release|Win32
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+EndGlobal

websocketForMt4/ATW.cpp

@@ -0,0 +1,196 @@
+/* Copyright (C) 2011 阙荣文
+ *
+ * 这是一个开源免费软件,您可以自由的修改和发布.
+ * 禁止用作商业用途.
+ *
+ * 联系原作者: querw@sina.com 
+*/
+
+// ATW.h: interface for the CBase64 class.
+// by Ted.Que - Que's C++ Studio
+// 2010-11-12
+// 转换字符编码
+#include "stdafx.h"
+#include "ATW.h"
+
+
+std::string __do_w_to_a_utf8(const wchar_t *pwszText, UINT uCodePage)
+{
+	// 空指针输入
+	if(pwszText == NULL) return "";
+
+	// 无法计算需要的长度.
+	int nNeedSize = WideCharToMultiByte(uCodePage, 0, pwszText, -1, NULL, 0, NULL, NULL);
+	if( 0 == nNeedSize ) return "";
+
+	// 分配空间,转换.
+	char *pRet = new char[nNeedSize + 1]; // 虽然返回WideCharToMultiByte的长度是包含 null 字符的长度, 还是多+一个字符.
+	memset(pRet, 0, nNeedSize + 1);
+
+	std::string strRet("");
+	if ( 0 == WideCharToMultiByte(uCodePage, 0, pwszText, -1, pRet, nNeedSize, NULL, NULL) )
+	{
+	}
+	else
+	{
+		strRet = pRet;
+	}
+
+	delete []pRet;
+	return strRet;
+}
+
+std::wstring __do_a_utf8_to_w(const char* pszText, UINT uCodePage)
+{
+	// 空指针
+	if( pszText == NULL ) return L"";
+
+	// 计算长度
+	int nNeedSize = MultiByteToWideChar(uCodePage, 0, pszText, -1, NULL, 0);
+	if( 0 == nNeedSize ) return L"";
+
+	// 分配空间,转换
+	std::wstring strRet(L"");
+	wchar_t *pRet = new wchar_t[nNeedSize + 1];
+	memset(pRet, 0, (nNeedSize + 1) * sizeof(wchar_t));
+	if( 0 == MultiByteToWideChar(uCodePage, 0, pszText, -1, pRet, nNeedSize) )
+	{
+	}
+	else
+	{
+		strRet = pRet;
+	}
+	delete []pRet;
+	return strRet;
+}
+
+std::string WtoA(const std::wstring &strText)
+{
+	return __do_w_to_a_utf8(strText.c_str(), CP_ACP);
+}
+
+std::string WtoA(const wchar_t *pwszText)
+{
+	return __do_w_to_a_utf8(pwszText, CP_ACP);
+}
+
+std::wstring AtoW(const std::string &strText)
+{
+	return __do_a_utf8_to_w(strText.c_str(), CP_ACP);
+}
+
+std::wstring AtoW(const char* pszText)
+{
+	return __do_a_utf8_to_w(pszText, CP_ACP);
+}
+
+std::string WtoUTF8(const std::wstring &strText)
+{
+	return __do_w_to_a_utf8(strText.c_str(), CP_UTF8);
+}
+
+std::string WtoUTF8(const wchar_t *pwszText)
+{
+	return __do_w_to_a_utf8(pwszText, CP_UTF8);
+}
+
+std::wstring UTF8toW(const std::string &strText)
+{
+	return __do_a_utf8_to_w(strText.c_str(), CP_UTF8);
+}
+
+std::wstring UTF8toW(const char* pszText)
+{
+	return __do_a_utf8_to_w(pszText, CP_UTF8);
+}
+
+std::string UTF8toA(const std::string &src)
+{
+	return WtoA(UTF8toW(src));
+}
+
+std::string UTF8toA(const char *src)
+{
+	return WtoA(UTF8toW(src));
+}
+
+std::string AtoUTF8(const std::string &src)
+{
+	return WtoUTF8(AtoW(src));
+}
+
+std::string AtoUTF8(const char* src)
+{
+	return WtoUTF8(AtoW(src));
+}
+/*
+UTF-8 编码最多可以有6个字节
+
+1字节 0xxxxxxx
+2字节 110xxxxx 10xxxxxx
+3字节 1110xxxx 10xxxxxx 10xxxxxx
+4字节 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
+5字节 111110xx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
+6字节 1111110x 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx 10xxxxxx
+
+*/
+
+// 返回值说明: 
+// 0 -> 输入字符串符合UTF-8编码规则
+// -1 -> 检测到非法的UTF-8编码首字节
+// -2 -> 检测到非法的UTF-8字节编码的后续字节.
+
+int IsTextUTF8(const char* pszSrc)
+{
+	const unsigned char* puszSrc = (const unsigned char*)pszSrc; // 一定要无符号的,有符号的比较就不正确了.
+	// 看看有没有BOM表示 EF BB BF
+	if( puszSrc[0] != 0 && puszSrc[0] == 0xEF && 
+		puszSrc[1] != 0 && puszSrc[1] == 0xBB &&
+		puszSrc[2] != 0 && puszSrc[2] == 0xBF)
+	{
+		return 0;
+	}
+
+	// 如果没有 BOM标识
+	bool bIsNextByte = false;
+	int nBytes = 0; // 记录一个字符的UTF8编码已经占用了几个字节.
+	const unsigned char* pCur = (const unsigned char*)pszSrc; // 指针游标用无符号字符型. 因为高位为1, 如果用 char 型, 会变为负数,不利于编程时候的比较操作.
+	
+	while( pCur[0] != 0 )
+	{
+		if(!bIsNextByte)
+		{
+			bIsNextByte = true;
+			if ( (pCur[0] >> 7) == 0) { bIsNextByte = false; nBytes = 1; bIsNextByte = false; } // 最高位为0, ANSI 兼容的.
+			else if ((pCur[0] >> 5) == 0x06) { nBytes = 2; } // 右移5位后是 110 -> 2字节编码的UTF8字符的首字节
+			else if ((pCur[0] >> 4) == 0x0E) { nBytes = 3; } // 右移4位后是 1110 -> 3字节编码的UTF8字符的首字节
+			else if ((pCur[0] >> 3) == 0x1E) { nBytes = 4; } // 右移3位后是 11110 -> 4字节编码的UTF8字符的首字节
+			else if ((pCur[0] >> 2) == 0x3E) { nBytes = 5; } // 右移2位后是 111110 -> 5字节编码的UTF8字符的首字节
+			else if ((pCur[0] >> 1) == 0x7E) { nBytes = 6; } // 右移1位后是 1111110 -> 6字节编码的UTF8字符的首字节
+			else
+			{
+				nBytes = -1; // 非法的UTF8字符编码的首字节
+				break;
+			}
+		}
+		else
+		{
+			if ((pCur[0] >> 6) == 0x02) // 首先,后续字节必须以 10xxx 开头
+			{
+				nBytes--;
+				if (nBytes == 1) bIsNextByte = false; // 当 nBytes = 1时, 说明下一个字节应该是首字节.
+			}
+			else
+			{
+				nBytes = -2;
+				break;
+			}
+		}
+
+		// 下跳一个字符
+		pCur++;
+	}
+
+	if( nBytes == 1) return 0;
+	else return nBytes;
+}

websocketForMt4/ATW.h

@@ -0,0 +1,69 @@
+/* Copyright (C) 2011 阙荣文
+ *
+ * 这是一个开源免费软件,您可以自由的修改和发布.
+ * 禁止用作商业用途.
+ *
+ * 联系原作者: querw@sina.com 
+*/
+
+/*
+
+1. 实现USC的压缩,Unicode <-> UTF-8.
+2. 实现多字节码 <-> Unicode
+
+对于Unicode字符串,用 wstring 存储.
+对于非Unicode字符串用 string 存储. ANSI, GB2312 都一样
+对于UTF-8串,也用 string 存储, UTF-8的编码串中不会有null出现.
+*/
+
+/*
+ 不要使用ATL 中的 USES_CONVERSION; A2W, A2T, W2A 等的宏, 由于这些宏都调用 alloca() 函数在函数栈中分配内存.
+ 虽然非常方便,函数返回后自动回收, 但是有溢出的危险, 函数栈只有 1M 的大小.
+
+ 以下的函数使用的空间都是在堆中分配的,比较安全.
+*/
+
+#pragma once
+#include <string>
+#if defined(_WIN32) || defined(WIN32)
+#include "Windows.h"
+#endif
+
+#if defined(_UNICODE) || defined(UNICODE)
+#define TtoA WtoA
+#define AtoT AtoW
+#define WtoT(a) (a)
+#define TtoW(a) (a)
+typedef std::wstring _tstring;
+#else
+#define TtoA(a) (a)
+#define AtoT(a) (a)
+#define WtoT WtoA
+#define TtoW AtoW
+typedef std::string _tstring;
+#endif
+
+std::string WtoA(const wchar_t* pwszSrc);
+std::string WtoA(const std::wstring &strSrc);
+
+std::wstring AtoW(const char* pszSrc);
+std::wstring AtoW(const std::string &strSrc);
+
+std::string WtoUTF8(const wchar_t* pwszSrc);
+std::string WtoUTF8(const std::wstring &strSrc);
+
+std::wstring UTF8toW(const char* pszSrc);
+std::wstring UTF8toW(const std::string &strSr);
+
+std::string AtoUTF8(const char* src);
+std::string AtoUTF8(const std::string &src);
+
+std::string UTF8toA(const char* src);
+std::string UTF8toA(const std::string &src);
+
+// 检测一个以 null 结尾的字符串是否是UTF-8, 如果返回0, 也只表示这个串刚好符合UTF8的编码规则.
+// 返回值说明: 
+// 1 -> 输入字符串符合UTF-8编码规则
+// -1 -> 检测到非法的UTF-8编码首字节
+// -2 -> 检测到非法的UTF-8字节编码的后续字节.
+int IsTextUTF8(const char* pszSrc); 

websocketForMt4/Processor.cpp

@@ -0,0 +1,990 @@
+//+------------------------------------------------------------------+
+//|                                             MetaTrader AutoHedge |
+//|                          Copyright 2001-2014, KAB Software Corp. |
+//|                                                http://www.kab.hk |
+//+------------------------------------------------------------------+
+#include "stdafx.h"
+#include "Processor.h"
+#include <string>
+#include <direct.h>
+#include "SHA1.h"
+#include "csv.hpp"
+#include <fstream>
+using namespace std;
+
+
+volatile UINT      ExtPumpingMsg = 0;
+volatile UINT      ExtDealingMsg = 0;
+
+static const std::string base64_chars =
+"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+"abcdefghijklmnopqrstuvwxyz"
+"0123456789+/";
+
+#define WORK_BUFFER_SIZE (1024)
+//+------------------------------------------------------------------+
+//|                                                                  |
+//+------------------------------------------------------------------+
+
+TradeTransmit::TradeTransmit()
+	: m_run(false)
+  {
+	  m_master = "";
+	  m_server_update = true;
+	  m_serveraddress = "127.0.0.1";
+	  m_serverport = 0;
+	  memset(m_groups, 0, 256);
+	  m_mt4_login = 0;
+	  m_mt4_password = "";
+	  m_mt4_addr = "";
+  }
+//+------------------------------------------------------------------+
+//|                                                                  |
+//+------------------------------------------------------------------+
+TradeTransmit::~TradeTransmit()
+  {
+	 
+	  m_run = false;
+	  if (m_deal_msg_thread.joinable())
+		  m_deal_msg_thread.join();
+  }
+
+//+------------------------------------------------------------------+
+//|                                                                  |
+//+------------------------------------------------------------------+
+void __stdcall TradeTransmit::PumpingFuncEx(int code, int type, void * data, void *param)
+{
+	TradeTransmit *p = (TradeTransmit*)param;
+	p->DealFunEx(code, type, data);
+}
+
+void TradeTransmit::Initialize(void)
+{
+
+	Out("Initialize parameter...");
+	m_factory.Init("mtmanapi.dll");
+	int iRet = m_factory.WinsockStartup();
+	ExtPumpingMsg = RegisterWindowMessage("MetaTrader4_Pumping_Message");
+	ExtDealingMsg = RegisterWindowMessage("MetaTrader4_Dealing_Message");
+
+	char tmp[256], *cp;
+	GetModuleFileName(NULL, tmp, sizeof(tmp) - 1);
+	if ((cp = strrchr(tmp, '.')) != NULL) *cp = 0;
+	
+	int    nPos;
+	std::string spath(tmp);
+	nPos = spath.rfind('\\');
+	spath = spath.assign(spath, 0, nPos);
+	sprintf(m_log_file, "%s\\tradeLog", spath.c_str());
+	std::string csvfile = spath + "\\userinfo.csv";
+	strcat(tmp, ".ini");
+	if (_access(m_log_file, 0) == -1)
+		_mkdir(m_log_file);
+	char str[35] = { 0 };
+	m_mt4_login = GetPrivateProfileInt("MT4", "Login", 27, tmp);
+	if(m_mt4_login<=0)Out("mt4 login error!please check ini file");
+	GetPrivateProfileString("MT4", "Addr", "maxcolive.itraderserver.com:443", str, 35, tmp);
+	if(strlen(str)<=1)Out("mt4 addr error!please check ini file");
+	m_mt4_addr = str;
+	memset(str, 0, 25);
+	GetPrivateProfileString("MT4", "PassWord", "Mjk345", str, 20, tmp);
+	if (strlen(str) <= 1)Out("mt4 password error!please check ini file");
+	m_mt4_password = str;
+	memset(str, 0, 25);
+	GetPrivateProfileString("TCP", "Addr", "0.0.0.0", str, 20, tmp);
+	m_tcpserver.SetAddr(str);
+	int port  = GetPrivateProfileInt("TCP", "Port", 8080, tmp);
+	if (port <= 0)Out("tcp port error!please check ini file");
+	m_tcpserver.SetServerPort(port);
+	char symbol[1024];
+	GetPrivateProfileString("MT4", "symbol", "", symbol, 1023, tmp);
+	m_symbols=splitWithStl(symbol, ",");
+
+	string line;
+	ifstream file(csvfile);
+	Csv csv(file);
+
+	while (csv.getline(line) != 0 && file)
+	{
+		if (csv.getnfield() < 2)continue;
+		USER_INFO info = { 0 };
+
+		info.userid = csv.getfield(0);
+		info.pwd = csv.getfield(1);
+		m_userInfo.push_back(info);
+
+	}
+	if (file)
+		file.close();
+}
+
+int TradeTransmit::Start()
+{
+
+	Out("server starting!!!");
+	Initialize();
+	if (m_factory.IsValid() == FALSE
+		|| (m_pmanager = m_factory.Create(ManAPIVersion)) == NULL
+		|| (m_pmanager_pump = m_factory.Create(ManAPIVersion)) == NULL)
+	{
+
+		return -1;
+	}
+	m_run = true;
+	Out("connect mt4 server...");
+	int iRet = ConnectManager(m_pmanager, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+	if (iRet != RET_OK)
+	{
+		Sleep(500);
+		iRet = ConnectManager(m_pmanager, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+	}
+	if (iRet != RET_OK)
+	{
+		Out("connect mt4 server fail");
+		return -2;
+	}
+	iRet = ConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+	if (iRet != RET_OK)
+	{
+		Sleep(500);
+		iRet = ConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+	}
+	if (iRet != RET_OK)
+	{
+		Out("connect mt4 server fail");
+		return -2;
+	}
+	m_trade_event = CreateEvent(NULL, FALSE, FALSE, NULL);
+	m_timer.run();
+	iRet=m_tcpserver.Start();
+	if (iRet != 0)
+	{
+		Out("start tcp server fail");
+		return -3;
+	}
+	if (!m_deal_msg_thread.joinable())
+		m_deal_msg_thread = std::thread(&TradeTransmit::DealTcpMsg, this);
+	if (!m_deal_mt4_thread.joinable())
+		m_deal_mt4_thread = std::thread(&TradeTransmit::DealMt4Msg, this);
+	m_timer.add_task([this]()
+	{
+		PumpHeart();
+	}, 1000 * 15);
+	Out("start server success!");
+	/*std::string csvfliename("\\trade");
+	if (m_csv_record.startflag() != true)
+		m_csv_record.open(m_log_file + csvfliename, ".csv");*/
+	return 0;
+}
+
+
+void TradeTransmit::Out(LPCSTR msg,...)
+  {
+   char buffer[1024];
+//--- format string
+   va_list arg_ptr;
+   va_start(arg_ptr,msg);
+   _vsnprintf(buffer,sizeof(buffer)-1,msg,arg_ptr);
+   va_end(arg_ptr);
+
+   std::cout << buffer << std::endl;
+  }
+
+void TradeTransmit::Stop()
+{
+	
+	m_run = false;
+
+	SetEvent(m_trade_event);
+	m_tcpserver.Stop();
+	m_timer.stop();
+	if (m_deal_msg_thread.joinable())
+		m_deal_msg_thread.join();
+	if (m_deal_mt4_thread.joinable())
+		m_deal_mt4_thread.join();
+	if (m_pmanager_pump != NULL)
+	{
+		m_pmanager_pump->Release();
+		m_pmanager_pump = NULL;
+	}
+	if (m_pmanager != NULL)
+	{
+		m_pmanager->Release();
+		m_pmanager = NULL;
+	}
+	m_csv_record.stop();
+}
+int TradeTransmit::ConnectManager(CManagerInterface *manager, const char*  szIP, const int iUser, const char*  szPassword)
+{
+	int iRet = manager->Connect(szIP);
+	if (iRet != RET_OK)
+	{
+		return iRet;
+	}
+	iRet = manager->Login(iUser, szPassword);
+	return iRet;
+}
+
+int TradeTransmit::ConnectPump(CManagerInterface *managerpump, const char* szIP, const int iUser, const char* szPassword)
+{
+	int iRet = managerpump->Connect(szIP);
+	if (iRet != RET_OK)
+	{
+		return iRet;
+	}
+	iRet = managerpump->Login(iUser, szPassword);
+	if (iRet != RET_OK)
+	{
+		return iRet;
+	}
+	int iCount = 0;
+
+	int flag = 0;
+	while ((iRet = managerpump->PumpingSwitchEx(TradeTransmit::PumpingFuncEx, flag, this)) != 0)
+	{
+		if (iCount++ >= 5)
+		{
+			return iRet;
+		}
+	}
+	return iRet;
+}
+void TradeTransmit::ReConnectPump(CManagerInterface * manager, const char * szIP, const int iUser, const char * szPassword)
+{
+	int iRet = m_pmanager_pump->Ping();
+	if (iRet != 0)
+	{
+		int iRet = ConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+		if (iRet != RET_OK)
+		{
+			m_timer.add_task([this]()
+			{
+				ReConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+			}, 500);
+			return;
+		}
+
+		m_timer.add_task([this]()
+		{
+			PumpHeart();
+		}, 1000 * 15);
+		Out("pump reconnect success!");
+	}
+}
+void TradeTransmit::DealFunEx(int code, int type, void * data)
+{
+	switch (code)
+	{
+	case PUMP_START_PUMPING:
+		//m_pmanager_pump->Ping();
+	{
+		for (int i = 0; i < m_symbols.size(); ++i)
+		{
+			m_pmanager_pump->SymbolAdd(m_symbols.at(i).c_str());
+		}
+			
+
+	}
+		break;
+	case PUMP_STOP_PUMPING:
+		if (m_run)
+		{
+			Out("PUMPING STOP");
+			m_timer.add_task([this]()
+			{
+				ReConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+			}, 100);
+		}
+		break;
+	case PUMP_UPDATE_BIDASK:
+	{
+		SymbolInfo si[32];
+		int total=0;
+		while (total = m_pmanager_pump->SymbolInfoUpdated(si, 32) > 0)
+		{
+			for (int i = 0; i < total; i++)
+			{
+				
+				//printf("%s ask:%lf,bid:%lf", si[i].symbol, si[i].ask, si[i].bid);
+				json sjson;
+				sjson["type"] = 100;
+				sjson["symbol"] = si[i].symbol;
+				sjson["ask"] = si[i].ask;
+				sjson["bid"] = si[i].bid;
+				unsigned long n = 0;
+				char * data = packData(sjson.dump().c_str(), &n, strlen(sjson.dump().c_str()));
+				for (auto iter = m_userList.begin(); iter != m_userList.end(); ++iter)
+				{
+					m_tcpserver.Send(iter->dwConnID,(LPBYTE)data, n);
+				}
+				//delete[] data;
+			}
+				
+			//printf("\n");
+		}
+
+	}
+		break;
+	case PUMP_UPDATE_SYMBOLS:
+
+		break;
+	case PUMP_UPDATE_GROUPS:
+
+		break;
+	case PUMP_UPDATE_USERS:
+		break;
+	case PUMP_UPDATE_ONLINE:
+		break;
+	case PUMP_UPDATE_TRADES:
+	{
+		if (data != NULL )
+		{
+			
+		}
+	}
+	break;
+	case PUMP_UPDATE_ACTIVATION:
+		break;
+	case PUMP_UPDATE_MARGINCALL:
+	{
+		/*if (data != NULL)
+		{
+			MT4_MSG msg = { 0 };
+			msg.code = PUMP_UPDATE_MARGINCALL;
+			memcpy(&msg.ml, (MarginLevel*)data, sizeof(MarginLevel));
+			AddMt4Msg(&msg);
+		}*/
+	}
+		break;
+	case PUMP_UPDATE_REQUESTS:
+	{
+		/*if (data != NULL)
+		{
+			MT4_MSG msg = { 0 };
+			msg.code = PUMP_UPDATE_REQUESTS;
+			memcpy(&msg.rinfo,(RequestInfo*)data,sizeof(RequestInfo));
+			AddMt4Msg(&msg);
+		}*/
+	}
+		break;
+	default: break;
+	}
+}
+void TradeTransmit::PumpHeart()
+{
+
+	int iRet =m_pmanager_pump->Ping();
+	if (iRet != 0)
+	{
+		Out("pump lost,reconnect!");
+		ReConnectPump(m_pmanager_pump, m_mt4_addr.c_str(), m_mt4_login, m_mt4_password.c_str());
+		return;
+	}
+	m_timer.add_task([this]()
+	{
+		PumpHeart();
+	}, 1000*15);
+}
+void TradeTransmit::AddMt4Msg(MT4_MSG * mt4_msg)
+{
+	std::lock_guard<std::mutex> lk(m_trade_mutex);
+	m_trade_list.push_back(*mt4_msg);
+	SetEvent(m_trade_event);
+}
+bool TradeTransmit::ReadMt4Msg(MT4_MSG & mt4_msg)
+{
+	std::lock_guard<std::mutex> lk(m_trade_mutex);
+	if (m_trade_list.size() > 0)
+	{
+		mt4_msg = m_trade_list.front();
+		m_trade_list.pop_front();
+		return true;
+	}
+	return false;
+}
+void TradeTransmit::DealTradeMsg(TradeRecord * trade,int type)
+{
+	if (trade == NULL)return;
+	if (trade->cmd > OP_SELL_STOP ||trade->cmd < 0)return;
+
+	float volume = trade->volume*1.00f / 100.0f;
+	char _str[5] = { 0 };
+	sprintf(_str, "%0.2f", volume);
+	Out("trade transmit: order %d,login %d,symbol %s,volume %s", trade->order, trade->login, trade->symbol, _str);
+	m_csv_record.write(tools::logger::LVNORMAL, "trade transmit,order %d,login %d,symbol %s,volume %s", trade->order, trade->login, trade->symbol, _str);
+
+	json json_msg;
+	json_msg["type"] = TCP_TRADE;
+	json_msg["order"] = trade->order;
+	json_msg["login"] = trade->login;
+	json_msg["symbol"] = trade->symbol;
+	json_msg["cmd"] = trade->cmd;
+	
+	json_msg["volume"] = _str;
+	if(trade->open_time>0)
+	{ 
+		std::string date;
+		StampToGmt(trade->open_time, date);
+		json_msg["open_time"] = date;
+	}
+	else
+		json_msg["open_time"] = "";
+
+	json_msg["state"] = trade->state;
+	json_msg["open_price"] = trade->open_price;
+	json_msg["sl"] = trade->sl;
+	json_msg["tp"] = trade->tp;
+	if (trade->close_time>0)
+	{
+		std::string date;
+		StampToGmt(trade->close_time, date);
+		json_msg["close_time"] = date;
+	}
+	else
+		json_msg["close_time"] = "";
+	json_msg["close_price"] = trade->close_price;
+	if (trade->cmd >= OP_BUY && trade->cmd <= OP_SELL)
+	{
+		if (type == TRANS_UPDATE)
+		{
+			if (trade->timestamp == trade->open_time)
+				json_msg["transtype"] = MT4_TRADE_PENDING_ACTIVE;
+			else
+				json_msg["transtype"] = MT4_TRADE_UPDATE;
+		}
+			
+		if (type == TRANS_DELETE)
+			json_msg["transtype"] = MT4_TRADE_CLOSE;
+	
+		if (type == TRANS_ADD)
+			json_msg["transtype"] = MT4_TRADE_OPEN;
+
+	}
+	if (trade->cmd > OP_SELL && trade->cmd <= OP_SELL_STOP)
+	{
+		if (type == TRANS_ADD)
+			json_msg["transtype"] = MT4_TRADE_PENDING;
+		if (type == TRANS_DELETE)
+			json_msg["transtype"] = MT4_TRADE_PENDING_DELETE;
+		if (type == TRANS_UPDATE)
+			json_msg["transtype"] = MT4_TRADE_PENDING_UPDATE;
+	}
+	//m_tcpserver.BroadMsg(json_msg);
+}
+
+void TradeTransmit::DealUserMsg(UserRecord * user)
+{
+	if (user == NULL)return;
+	json json_msg;
+	json_msg["login"] = user->login;
+	json_msg["group"] = user->group;
+	json_msg["enable"] = user->enable;
+	json_msg["name"] = user->name;
+	json_msg["country"] = user->country;
+	json_msg["city"] = user->city;
+	json_msg["state"] = user->state;
+	json_msg["zipcode"] = user->zipcode;
+	json_msg["address"] = user->address;
+	json_msg["phone"] = user->phone;
+	json_msg["email"] = user->email;
+	//m_tcpserver.BroadMsg(json_msg);
+}
+void TradeTransmit::DealRequestMsg(RequestInfo * info)
+{
+	if (info == NULL)return;
+	json json_msg;
+	json_msg["id"] = info->id;
+	json_msg["status"] = info->status;
+	json_msg["login"] = info->login;
+	json_msg["time"] = info->time;
+	json_msg["group"] = info->group;
+	json_msg["balance"] = info->balance;
+	json_msg["credit"] = info->credit;
+	//m_tcpserver.BroadMsg(json_msg);
+}
+void TradeTransmit::DealMarginMsg(MarginLevel * ml)
+{
+	if (ml == NULL)return;
+
+	json json_msg;
+	json_msg["login"] = ml->login;
+	json_msg["group"] = ml->group;
+	json_msg["leverage"] = ml->leverage;
+	json_msg["updated"] = ml->updated;
+	json_msg["group"] = ml->group;
+	json_msg["balance"] = ml->balance;
+	json_msg["equity"] = ml->equity;
+	json_msg["volume"] = ml->volume;
+	json_msg["margin_free"] = ml->margin_free;
+	json_msg["margin_level"] = ml->margin_level;
+	json_msg["balance"] = ml->balance;
+	json_msg["margin_type"] = ml->margin_type;
+	//m_tcpserver.BroadMsg(json_msg);
+}
+
+void TradeTransmit::SendMsg(std::string type, vector<json> desc, time_t open_time, time_t error_time, int error_code,std::string opr)
+{
+	json json_msg;
+	json_msg["type"] = type;
+	for (unsigned int i = 0; i < desc.size(); ++i)
+	{
+		json_msg["desc"][i] = desc.at(i);
+	}
+		
+
+	if (open_time> 0)
+		json_msg["opentime"] = open_time;
+	if (error_time > 0)
+		json_msg["errortime"] = error_time;
+	
+	json_msg["status"] = error_code;
+
+	if (opr.length() > 0)
+		json_msg["opr"] = opr;
+	std::string msg = json_msg.dump() + "\r\n";
+
+}
+
+
+void TradeTransmit::DealTcpMsg()
+{
+	while (m_run)
+	{
+		//m_tcpserver.WaitRecvEvent();
+		if (!m_run)return;
+		std::vector<string> vec;
+		CONNID dwConnID;
+		int flag;
+		std::string ip;
+		std::string u_id;
+		int ilen = 0;
+		while (m_tcpserver.ReadMsg(vec, dwConnID, flag, ip, u_id))
+		{
+			if (flag == -1)
+			{
+				deleteUser(dwConnID);
+				continue;
+			}
+			for (unsigned int i = 0; i < vec.size(); i++)
+			{
+
+				if (flag == 0)
+				{
+					//握手
+					handShake(vec.at(i).c_str(), dwConnID);
+					checkUser(vec.at(i).c_str(), dwConnID);
+					continue;
+				}
+				//解码 
+				WebSocketStreamHeader header{};
+				int iRead = readHeader((const unsigned char *)vec.at(i).c_str(), &header);
+				if (iRead == WebSocketOpCode::ConnectionClose)
+				{
+					m_tcpserver.CloseConnect(dwConnID);
+					continue;
+				}
+				if (iRead == WebSocketOpCode::Pong)
+				{
+					continue;
+				}
+			}
+			vec.clear();
+			dwConnID = 0;
+		}
+	}
+}
+
+void TradeTransmit::DealMt4Msg()
+{
+	while (m_run)
+	{
+		WaitForSingleObject(m_trade_event, INFINITE);
+		if (!m_run)return;
+		
+		MT4_MSG msg = {0};
+		while (ReadMt4Msg(msg))
+		{
+			switch (msg.code)
+			{
+			case PUMP_UPDATE_USERS:
+			{
+				//DealUserMsg(&msg.ur);//暂时只要交易单的转发
+			}
+			break;
+			case PUMP_UPDATE_TRADES:
+			{
+				//DealTradeMsg(&msg.tr,msg.type);
+			}
+			break;
+			case PUMP_UPDATE_ACTIVATION:
+			{
+
+			}
+			break;
+			case PUMP_UPDATE_MARGINCALL:
+			{
+				//DealMarginMsg(&msg.ml);//暂时只要交易单的转发
+			}
+			break;
+			case PUMP_UPDATE_REQUESTS:
+			{
+				//DealRequestMsg(&msg.rinfo);//暂时只要交易单的转发
+			}
+			break;
+			default:
+				break;
+			}
+			
+		}
+	}
+}
+
+void TradeTransmit::StampToGmt(int stampTime,std::string &datetime)
+{
+	time_t t;
+	struct tm *p;
+	t = stampTime;
+	p = gmtime(&t);
+	char s[80];
+	strftime(s, 80, "%Y-%m-%d %H:%M:%S", p);
+
+	datetime = s;
+}
+
+std::vector<std::string> TradeTransmit::splitWithStl(const std::string &str, const std::string &pattern)
+{
+     std::vector<std::string> resVec;
+
+     if ("" == str)
+     {
+         return resVec;
+     }
+
+    std::string strs = str + pattern;
+
+    size_t pos = strs.find(pattern);
+    size_t size = strs.size();
+
+    while (pos != std::string::npos)
+    {
+        std::string x = strs.substr(0, pos);
+        resVec.push_back(x);
+        strs = strs.substr(pos + 1, size);
+        pos = strs.find(pattern);
+    }
+
+    return resVec;
+}
+
+char* TradeTransmit::packData(const char * message, unsigned long * len, unsigned long n)
+{
+	static char * packData = new char[1024];
+	memset(packData, 0, sizeof(1024));
+	if (n < 126)
+	{
+		packData[0] = 0x81;
+		packData[1] = n;
+		memcpy(packData + 2, message, n);
+		*len = n + 2;
+	}
+	else if (n < 32767)
+	{
+		packData[0] = 0x81;
+		packData[1] = 126;
+		packData[2] = (n >> 8 & 0xFF);
+		packData[3] = (n & 0xFF);
+		memcpy(packData + 4, message, n);
+		*len = n + 4;
+	}
+	else
+	{
+		// 暂不处理超长内容  
+		*len = 0;
+	}
+	return packData;
+	//char * packData = new char[n + 4];
+	//memset(packData, 0, sizeof(n + 4));
+	//if (n < 126)
+	//{
+	//	packData[0] = 0x81;
+	//	packData[1] = n;
+	//	memcpy(packData + 2, message, n);
+	//	*len = n + 2;
+	//}
+	//else if (n < 32767)
+	//{
+	//	packData[0] = 0x81;
+	//	packData[1] = 126;
+	//	packData[2] = (n >> 8 & 0xFF);
+	//	packData[3] = (n & 0xFF);
+	//	memcpy(packData + 4, message, n);
+	//	*len = n + 4;
+	//}
+	//else
+	//{
+	//	// 暂不处理超长内容  
+	//	*len = 0;
+	//}
+	//return packData;
+}
+int TradeTransmit::readHeader(const unsigned char* cData, WebSocketStreamHeader* header)
+{
+	if (cData == NULL)return false;
+
+	const unsigned char *buf = cData;
+
+	header->fin = buf[0] & 0x80;
+	header->masked = buf[1] & 0x80;
+	unsigned char stream_size = buf[1] & 0x7F;
+
+	header->opcode = buf[0] & 0x0F;
+	if (header->opcode == WebSocketOpCode::ContinuationFrame) {
+		//连续帧  
+		return WebSocketOpCode::ContinuationFrame;
+		//return false;
+	}
+	else if (header->opcode == WebSocketOpCode::TextFrame) {
+		//文本帧  
+	}
+	else if (header->opcode == WebSocketOpCode::BinaryFrame) {
+		//二进制帧  
+
+	}
+	else if (header->opcode == WebSocketOpCode::ConnectionClose) {
+		//连接关闭消息  
+		return WebSocketOpCode::ConnectionClose;
+		//return false;
+	}
+	else if (header->opcode == WebSocketOpCode::Ping) {
+		//  ping  
+		return WebSocketOpCode::Ping;
+	}
+	else if (header->opcode == WebSocketOpCode::Pong) {
+		// pong  
+		return WebSocketOpCode::Pong;
+	}
+	else {
+		//非法帧  
+		return -1;
+	}
+
+	if (stream_size <= 125) {
+		//  small stream  
+		header->header_size = 6;
+		header->payload_size = stream_size;
+		header->mask_offset = 2;
+	}
+	else if (stream_size == 126) {
+		//  medium stream   
+		header->header_size = 8;
+		unsigned short s = 0;
+		memcpy(&s, (const char*)&buf[2], 2);
+		header->payload_size = ntohs(s);
+		header->mask_offset = 4;
+		return 100;
+	}
+	else if (stream_size == 127) {
+
+		unsigned long long l = 0;
+		memcpy(&l, (const char*)&buf[2], 8);
+
+		header->payload_size = l;
+		header->mask_offset = 10;
+	}
+	else {
+		//Couldnt decode stream size 非法大小数据包  
+		return -1;
+	}
+
+	if (header->payload_size > (65535 / 2)) {
+		return -1;
+	}
+
+	return 0;
+}
+bool TradeTransmit::decodeRawData(const WebSocketStreamHeader& header, BYTE cbSrcData[], WORD wSrcLen, BYTE cbTagData[])
+{
+	const unsigned char *final_buf = cbSrcData;
+	if (wSrcLen < header.header_size + 1) {
+		return false;
+	}
+
+	char masks[4];
+	memcpy(masks, final_buf + header.mask_offset, 4);
+	memcpy(cbTagData, final_buf + header.mask_offset + 4, header.payload_size);
+
+	for (INT_PTR i = 0; i < header.payload_size; ++i) {
+		cbTagData[i] = (cbTagData[i] ^ masks[i % 4]);
+	}
+	//如果是文本包，在数据最后加一个结束字符“\0”  
+	if (header.opcode == WebSocketOpCode::TextFrame)
+		cbTagData[header.payload_size] = '\0';
+
+	return true;
+}
+
+std::string TradeTransmit::base64Encode(unsigned char const* bytes_to_encode, unsigned int in_len)
+{
+	std::string ret;
+	int i = 0;
+	int j = 0;
+	unsigned char char_array_3[3];
+	unsigned char char_array_4[4];
+
+	while (in_len--) {
+		char_array_3[i++] = *(bytes_to_encode++);
+		if (i == 3) {
+			char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
+			char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
+			char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
+			char_array_4[3] = char_array_3[2] & 0x3f;
+
+			for (i = 0; (i <4); i++)
+				ret += base64_chars[char_array_4[i]];
+			i = 0;
+		}
+	}
+
+	if (i)
+	{
+		for (j = i; j < 3; j++)
+			char_array_3[j] = '\0';
+
+		char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
+		char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
+		char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
+		char_array_4[3] = char_array_3[2] & 0x3f;
+
+		for (j = 0; (j < i + 1); j++)
+			ret += base64_chars[char_array_4[j]];
+
+		while ((i++ < 3))
+			ret += '=';
+
+	}
+
+	return ret;
+
+}
+
+void TradeTransmit::handShake(string inMessage, CONNID &dwConnID)
+{
+	std::istringstream stream(inMessage);
+	std::string reqType;
+	std::getline(stream, reqType);
+	bool ck = true;
+	if (reqType.substr(0, 4) != "GET ")
+	{
+		ck = false;
+	}
+
+	std::string header;
+	std::string::size_type pos = 0;
+	std::string websocketKey;
+	bool bs = false;
+	std::string userId = "";
+	int type = 0;
+	if (ck)
+	{
+		while (std::getline(stream, header) && header != "\r")
+		{
+			header.erase(header.end() - 1);
+			pos = header.find(": ", 0);
+			if (pos != std::string::npos)
+			{
+				std::string key = header.substr(0, pos);
+				std::string value = header.substr(pos + 2);
+				if (key == "Sec-WebSocket-Key")
+				{
+					bs = true;
+					websocketKey = value;
+					break;
+				}
+			}
+		}
+	}
+
+	// 填充http响应头信息  
+	std::string response = "HTTP/1.1 101 Web Socket Handshake\r\n";
+	response += "Upgrade: websocket\r\n";
+	response += "Connection: Upgrade\r\n";
+	response += "Sec-WebSocket-Accept: ";
+
+	const std::string magicKey("258EAFA5-E914-47DA-95CA-C5AB0DC85B11");
+	std::string serverKey = websocketKey + magicKey;
+
+	std::string strKey = websocketKey + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
+	SHA1 sha;
+	unsigned int iDigSet[5];
+	sha.Reset();
+	sha << strKey.c_str();
+	sha.Result(iDigSet);
+
+	for (int i = 0; i < 5; i++)iDigSet[i] = htonl(iDigSet[i]);           //将字节转换成网络字节顺序  
+
+	strKey = base64Encode(reinterpret_cast<const unsigned char*>(iDigSet), 20);
+
+	response += strKey + "\r\n\r\n";
+	int iLen = (int)strlen(response.c_str());
+	
+	m_tcpserver.Send(dwConnID, (LPBYTE)response.c_str(), iLen);
+}
+
+void TradeTransmit::checkUser(string inMessage, CONNID & dwConnID)
+{
+	std::istringstream stream(inMessage);
+	USER_INFO ui{};
+	ui.dwConnID = dwConnID;
+	std::string userid="";//在这里做账号控制
+	std::string pwd = "";//在这里做账号控制
+	/*int id_pos = inMessage.find("UserId", 4);
+	if (id_pos != string::npos)
+	{
+		int pos_e = inMessage.find("&", id_pos + 6);
+		if (pos_e == string::npos)
+			pos_e = inMessage.find(" ", id_pos + 6);
+		if (pos_e != string::npos)
+		{
+			userid = inMessage.substr(id_pos + 7, pos_e - id_pos - 7);
+			ui.userid = userid;
+		}
+	}
+	int pos_b = inMessage.find("password", id_pos);
+	if (pos_b != string::npos)
+	{
+		int pos_e = inMessage.find("&", pos_b + 8);
+		if (pos_e == string::npos)
+			pos_e = inMessage.find(" ", pos_b + 8);
+		if (pos_e != string::npos)
+		{
+			pwd = inMessage.substr(pos_b + 9, pos_e - pos_b - 9);
+			ui.pwd = pwd;
+		}
+	}
+	auto u_iter = std::find_if(m_userInfo.begin(), m_userInfo.end(), [&userid, &pwd](USER_INFO &info) {return (userid == info.userid &&pwd== info.pwd); });
+	if (u_iter == m_userInfo.end())
+	{
+		m_tcpserver.CloseConnect(dwConnID);
+		return;
+	}
+	auto iter = std::find_if(m_userList.begin(), m_userList.end(), [userid](USER_INFO &info) {return (userid == info.userid); });
+	if (iter != m_userList.end())
+	{
+		CONNID tmp = iter->dwConnID;
+		iter->dwConnID = dwConnID;
+		m_tcpserver.CloseConnect(tmp);
+		return;
+	}*/
+
+	m_userList.push_back(ui);
+}
+
+void TradeTransmit::deleteUser(CONNID dwConnID)
+{
+	m_tcpserver.DeleteInfo(dwConnID);
+	auto iter = std::find_if(m_userList.begin(), m_userList.end(), [dwConnID](USER_INFO &info) {return (dwConnID == info.dwConnID); });//
+	if (iter != m_userList.end())
+	{
+		m_userList.erase(iter);
+	}
+}

websocketForMt4/Processor.h

@@ -0,0 +1,155 @@
+//+------------------------------------------------------------------+
+//|                                             MetaTrader AutoHedge |
+//|                          Copyright 2001-2014, KAB Software Corp. |
+//|                                                http://www.kab.hk |
+//+------------------------------------------------------------------+
+#pragma once
+
+#include <vector>
+#include <map>
+#include "TcpServerProcess.h"
+#include "..\public\MT4ManagerAPI.h"
+#include <mutex>
+#include <vector>
+#include <thread>
+#include "json.hpp"
+using json = nlohmann::json;
+#include "logger.h"
+using namespace tools;
+//#pragma comment(lib, "ws2_32")
+
+const int           ERROR_JSON_FAIL = -2;//json格式解析错误
+
+const int           ERROR_GET_OPEN_USER_FAIL = -21;//获取开仓用户信息失败
+const int          	ERROR_GET_OPEN_GROUP_FAIL = -22;//获取开仓组信息失败
+const int          	ERROR_GET_OPEN_PRICES_FAIL = -23;//获取开仓价格信息失败
+const int         	ERROR_OPEN_INTERFACE_FAIL = -24;//调用开仓接口失败
+const int         	ERROR_GET_OPEN_TRADE_FAIL = -25;//获取开仓单信息失败
+const int         	ERROR_GET_OPEN_LOTSTEP_FAIL = -26;//获取kaic lotstep失败
+
+
+const int			ERROR_CLOSE_SYMBOL_MISMATCH = -31;//品种不匹配
+const int			ERROR_TRADE_ALREADY_CLOSE = -32;//单已经平仓
+const int           ERROR_GET_CLOSE_USER_FAIL = -33;//获取平仓用户信息失败
+const int          	ERROR_GET_CLOSE_GROUP_FAIL = -34;//获取平仓组信息失败
+const int          	ERROR_GET_CLOSE_PRICES_FAIL = -35;//获取平仓价格信息失败
+const int         	ERROR_CLOSE_INTERFACE_FAIL = -36;//调用平仓接口失败
+const int         	ERROR_GET_CLOSE_TRADE_FAIL = -37;//获取平仓单信息失败
+
+const int         	ERROR_JSON_LEN = -41;						//长度过长
+const int         	ERROR_JSON_TYPE = -42;						//不存在的type
+const int         	ERROR_JSON_NAME = -43;						//不存在的name
+const int         	ERROR_JSON_MASTER = -44;						//不存在的master
+
+
+//+------------------------------------------------------------------+
+//|                                                                  |
+//+------------------------------------------------------------------+
+struct MT4_MSG
+{
+	int code;
+	int type;
+	TradeRecord tr;
+	UserRecord ur;
+	RequestInfo rinfo;
+	MarginLevel ml;
+};
+enum { TCP_HEART = 0,TCP_TRADE,TCP_STATUS};
+enum { MT4_TRADE_OPEN = 0, MT4_TRADE_CLOSE, MT4_TRADE_PENDING, MT4_TRADE_PENDING_ACTIVE, MT4_TRADE_PENDING_UPDATE,
+	MT4_TRADE_PENDING_DELETE, MT4_TRADE_UPDATE
+};
+struct WebSocketStreamHeader {
+	unsigned int header_size;               //数据包头大小  
+	int mask_offset;                    //掩码偏移  
+	unsigned int payload_size;              //数据大小  
+	bool fin;                                               //帧标记  
+	bool masked;                            //掩码  
+	unsigned char opcode;                   //操作码  
+	unsigned char res[3];
+};
+enum WebSocketOpCode {
+	ContinuationFrame = 0x0,                //连续帧  
+	TextFrame = 0x1,                    //文本帧  
+	BinaryFrame = 0x2,                  //二进制帧  
+	ConnectionClose = 0x8,                  //连接关闭  
+	Ping = 0x9,
+	Pong = 0xA
+};
+struct USER_INFO
+{
+	CONNID dwConnID;
+	std::string userid;
+	std::string pwd;
+	std::string symbols;
+};
+class TradeTransmit
+  {
+	
+private:
+
+ 
+  public:
+	  TradeTransmit();
+	  ~TradeTransmit();
+   //--- initializing
+   void					Initialize(void);
+   int					Start();
+   void					Stop();
+   void					Out( LPCSTR msg, ...);
+   void					SendMsg(std::string type, std::vector<json> desc, time_t open_time, time_t error_time, int error_code,std::string opr);
+
+   void					DealTcpMsg();
+   void					DealMt4Msg();
+ 
+   int					ConnectPump(CManagerInterface *managerpump, const char* szIP, const int iUser, const char* szPassword);
+   int					ConnectManager(CManagerInterface *manager, const char*  szIP, const int iUser, const char*  szPassword);
+   void					ReConnectPump(CManagerInterface *manager, const char*  szIP, const int iUser, const char*  szPassword);
+   void					DealFunEx(int code, int type, void * data);
+   void					PumpHeart();
+   void					AddMt4Msg(MT4_MSG * mt4_msg);
+   bool					ReadMt4Msg(MT4_MSG & mt4_msg);
+   void					DealTradeMsg(TradeRecord *trade,int type);
+   void					DealUserMsg(UserRecord *user);
+   void					DealRequestMsg(RequestInfo *info);
+   void					DealMarginMsg(MarginLevel *ml);
+   void					StampToGmt(int stampTime, std::string &datetime);
+   static void __stdcall		PumpingFuncEx(int code, int type, void * data, void *param);
+   std::vector<std::string> splitWithStl(const std::string &str, const std::string &pattern);
+   char*				packData(const char * message, unsigned long * len, unsigned long n);
+   bool					decodeRawData(const WebSocketStreamHeader& header, BYTE cbSrcData[], WORD wSrcLen, BYTE cbTagData[]);
+   int					readHeader(const unsigned char* cData, WebSocketStreamHeader* header);
+   std::string			base64Encode(unsigned char const* bytes_to_encode, unsigned int in_len);
+   void					handShake(string inMessage, CONNID &dwConnID);
+   void					checkUser(string inMessage, CONNID &dwConnID);
+   void					deleteUser(CONNID dwConnID);
+private:
+	CManagerFactory   m_factory;
+	CManagerInterface *m_pmanager;
+	CManagerInterface *m_pmanager_pump;
+	HANDLE				m_trade_event;
+	std::mutex			m_trade_mutex;
+	int					m_mt4_login;
+	std::string			m_mt4_password;
+	std::string			m_mt4_addr;
+	std::deque<MT4_MSG>	m_trade_list;
+	char				m_log_file[MAX_PATH];
+	tools::logger		m_csv_record;
+
+	bool				 m_run;
+	tools::tim::timer	m_timer;
+	std::thread		 m_deal_msg_thread;
+	std::thread		 m_deal_mt4_thread;
+
+	std::string			m_serveraddress;
+	int					m_serverport;
+	bool				m_server_update;
+	std::string			m_master;
+	char				m_groups[256];
+	CTcpServerProcess	m_tcpserver;
+	std::vector<std::string>	m_symbols;
+
+	std::list<USER_INFO>	m_userList;
+	std::list<USER_INFO>	m_userInfo;
+  };
+
+//+------------------------------------------------------------------+

websocketForMt4/ReadMe.txt

@@ -0,0 +1,30 @@
+========================================================================
+    控制台应用程序：websocketForMt4 项目概述
+========================================================================
+
+应用程序向导已为您创建了此 websocketForMt4 应用程序。
+
+本文件概要介绍组成 websocketForMt4 应用程序的每个文件的内容。
+
+
+websocketForMt4.vcxproj
+    这是使用应用程序向导生成的 VC++ 项目的主项目文件，其中包含生成该文件的 Visual C++ 的版本信息，以及有关使用应用程序向导选择的平台、配置和项目功能的信息。
+
+websocketForMt4.vcxproj.filters
+    这是使用“应用程序向导”生成的 VC++ 项目筛选器文件。它包含有关项目文件与筛选器之间的关联信息。在 IDE 中，通过这种关联，在特定节点下以分组形式显示具有相似扩展名的文件。例如，“.cpp”文件与“源文件”筛选器关联。
+
+websocketForMt4.cpp
+    这是主应用程序源文件。
+
+/////////////////////////////////////////////////////////////////////////////
+其他标准文件:
+
+StdAfx.h, StdAfx.cpp
+    这些文件用于生成名为 websocketForMt4.pch 的预编译头 (PCH) 文件和名为 StdAfx.obj 的预编译类型文件。
+
+/////////////////////////////////////////////////////////////////////////////
+其他注释:
+
+应用程序向导使用“TODO:”注释来指示应添加或自定义的源代码部分。
+
+/////////////////////////////////////////////////////////////////////////////

websocketForMt4/SHA1.cpp

@@ -0,0 +1,548 @@
+#include "SHA1.h"
+/*
+*  SHA1
+*
+*  Description:
+*      This is the constructor for the sha1 class.
+*
+*  Parameters:
+*      None.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+SHA1::SHA1()
+{
+	Reset();
+}
+
+/*
+*  ~SHA1
+*
+*  Description:
+*      This is the destructor for the sha1 class
+*
+*  Parameters:
+*      None.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+SHA1::~SHA1()
+{
+	// The destructor does nothing
+}
+
+/*
+*  Reset
+*
+*  Description:
+*      This function will initialize the sha1 class member variables
+*      in preparation for computing a new message digest.
+*
+*  Parameters:
+*      None.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::Reset()
+{
+	Length_Low = 0;
+	Length_High = 0;
+	Message_Block_Index = 0;
+
+	H[0] = 0x67452301;
+	H[1] = 0xEFCDAB89;
+	H[2] = 0x98BADCFE;
+	H[3] = 0x10325476;
+	H[4] = 0xC3D2E1F0;
+
+	Computed = false;
+	Corrupted = false;
+}
+
+/*
+*  Result
+*
+*  Description:
+*      This function will return the 160-bit message digest into the
+*      array provided.
+*
+*  Parameters:
+*      message_digest_array: [out]
+*          This is an array of five unsigned integers which will be filled
+*          with the message digest that has been computed.
+*
+*  Returns:
+*      True if successful, false if it failed.
+*
+*  Comments:
+*
+*/
+bool SHA1::Result(unsigned *message_digest_array)
+{
+	int i;                                  // Counter
+
+	if (Corrupted)
+	{
+		return false;
+	}
+
+	if (!Computed)
+	{
+		PadMessage();
+		Computed = true;
+	}
+
+	for (i = 0; i < 5; i++)
+	{
+		message_digest_array[i] = H[i];
+	}
+
+	return true;
+}
+
+/*
+*  Input
+*
+*  Description:
+*      This function accepts an array of octets as the next portion of
+*      the message.
+*
+*  Parameters:
+*      message_array: [in]
+*          An array of characters representing the next portion of the
+*          message.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::Input(const unsigned char *message_array,
+	unsigned            length)
+{
+	if (!length)
+	{
+		return;
+	}
+
+	if (Computed || Corrupted)
+	{
+		Corrupted = true;
+		return;
+	}
+
+	while (length-- && !Corrupted)
+	{
+		Message_Block[Message_Block_Index++] = (*message_array & 0xFF);
+
+		Length_Low += 8;
+		Length_Low &= 0xFFFFFFFF;               // Force it to 32 bits
+		if (Length_Low == 0)
+		{
+			Length_High++;
+			Length_High &= 0xFFFFFFFF;          // Force it to 32 bits
+			if (Length_High == 0)
+			{
+				Corrupted = true;               // Message is too long
+			}
+		}
+
+		if (Message_Block_Index == 64)
+		{
+			ProcessMessageBlock();
+		}
+
+		message_array++;
+	}
+}
+
+/*
+*  Input
+*
+*  Description:
+*      This function accepts an array of octets as the next portion of
+*      the message.
+*
+*  Parameters:
+*      message_array: [in]
+*          An array of characters representing the next portion of the
+*          message.
+*      length: [in]
+*          The length of the message_array
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::Input(const char  *message_array,
+	unsigned    length)
+{
+	Input((unsigned char *)message_array, length);
+}
+
+/*
+*  Input
+*
+*  Description:
+*      This function accepts a single octets as the next message element.
+*
+*  Parameters:
+*      message_element: [in]
+*          The next octet in the message.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::Input(unsigned char message_element)
+{
+	Input(&message_element, 1);
+}
+
+/*
+*  Input
+*
+*  Description:
+*      This function accepts a single octet as the next message element.
+*
+*  Parameters:
+*      message_element: [in]
+*          The next octet in the message.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::Input(char message_element)
+{
+	Input((unsigned char *)&message_element, 1);
+}
+
+/*
+*  operator<<
+*
+*  Description:
+*      This operator makes it convenient to provide character strings to
+*      the SHA1 object for processing.
+*
+*  Parameters:
+*      message_array: [in]
+*          The character array to take as input.
+*
+*  Returns:
+*      A reference to the SHA1 object.
+*
+*  Comments:
+*      Each character is assumed to hold 8 bits of information.
+*
+*/
+SHA1& SHA1::operator<<(const char *message_array)
+{
+	const char *p = message_array;
+
+	while (*p)
+	{
+		Input(*p);
+		p++;
+	}
+
+	return *this;
+}
+
+/*
+*  operator<<
+*
+*  Description:
+*      This operator makes it convenient to provide character strings to
+*      the SHA1 object for processing.
+*
+*  Parameters:
+*      message_array: [in]
+*          The character array to take as input.
+*
+*  Returns:
+*      A reference to the SHA1 object.
+*
+*  Comments:
+*      Each character is assumed to hold 8 bits of information.
+*
+*/
+SHA1& SHA1::operator<<(const unsigned char *message_array)
+{
+	const unsigned char *p = message_array;
+
+	while (*p)
+	{
+		Input(*p);
+		p++;
+	}
+
+	return *this;
+}
+
+/*
+*  operator<<
+*
+*  Description:
+*      This function provides the next octet in the message.
+*
+*  Parameters:
+*      message_element: [in]
+*          The next octet in the message
+*
+*  Returns:
+*      A reference to the SHA1 object.
+*
+*  Comments:
+*      The character is assumed to hold 8 bits of information.
+*
+*/
+SHA1& SHA1::operator<<(const char message_element)
+{
+	Input((unsigned char *)&message_element, 1);
+
+	return *this;
+}
+
+/*
+*  operator<<
+*
+*  Description:
+*      This function provides the next octet in the message.
+*
+*  Parameters:
+*      message_element: [in]
+*          The next octet in the message
+*
+*  Returns:
+*      A reference to the SHA1 object.
+*
+*  Comments:
+*      The character is assumed to hold 8 bits of information.
+*
+*/
+SHA1& SHA1::operator<<(const unsigned char message_element)
+{
+	Input(&message_element, 1);
+
+	return *this;
+}
+
+/*
+*  ProcessMessageBlock
+*
+*  Description:
+*      This function will process the next 512 bits of the message
+*      stored in the Message_Block array.
+*
+*  Parameters:
+*      None.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*      Many of the variable names in this function, especially the single
+*      character names, were used because those were the names used
+*      in the publication.
+*
+*/
+void SHA1::ProcessMessageBlock()
+{
+	const unsigned K[] = {               // Constants defined for SHA-1
+		0x5A827999,
+		0x6ED9EBA1,
+		0x8F1BBCDC,
+		0xCA62C1D6
+	};
+	int         t;                          // Loop counter
+	unsigned    temp;                       // Temporary word value
+	unsigned    W[80];                      // Word sequence
+	unsigned    A, B, C, D, E;              // Word buffers
+
+											/*
+											*  Initialize the first 16 words in the array W
+											*/
+	for (t = 0; t < 16; t++)
+	{
+		W[t] = ((unsigned)Message_Block[t * 4]) << 24;
+		W[t] |= ((unsigned)Message_Block[t * 4 + 1]) << 16;
+		W[t] |= ((unsigned)Message_Block[t * 4 + 2]) << 8;
+		W[t] |= ((unsigned)Message_Block[t * 4 + 3]);
+	}
+
+	for (t = 16; t < 80; t++)
+	{
+		W[t] = CircularShift(1, W[t - 3] ^ W[t - 8] ^ W[t - 14] ^ W[t - 16]);
+	}
+
+	A = H[0];
+	B = H[1];
+	C = H[2];
+	D = H[3];
+	E = H[4];
+
+	for (t = 0; t < 20; t++)
+	{
+		temp = CircularShift(5, A) + ((B & C) | ((~B) & D)) + E + W[t] + K[0];
+		temp &= 0xFFFFFFFF;
+		E = D;
+		D = C;
+		C = CircularShift(30, B);
+		B = A;
+		A = temp;
+	}
+
+	for (t = 20; t < 40; t++)
+	{
+		temp = CircularShift(5, A) + (B ^ C ^ D) + E + W[t] + K[1];
+		temp &= 0xFFFFFFFF;
+		E = D;
+		D = C;
+		C = CircularShift(30, B);
+		B = A;
+		A = temp;
+	}
+
+	for (t = 40; t < 60; t++)
+	{
+		temp = CircularShift(5, A) +
+			((B & C) | (B & D) | (C & D)) + E + W[t] + K[2];
+		temp &= 0xFFFFFFFF;
+		E = D;
+		D = C;
+		C = CircularShift(30, B);
+		B = A;
+		A = temp;
+	}
+
+	for (t = 60; t < 80; t++)
+	{
+		temp = CircularShift(5, A) + (B ^ C ^ D) + E + W[t] + K[3];
+		temp &= 0xFFFFFFFF;
+		E = D;
+		D = C;
+		C = CircularShift(30, B);
+		B = A;
+		A = temp;
+	}
+
+	H[0] = (H[0] + A) & 0xFFFFFFFF;
+	H[1] = (H[1] + B) & 0xFFFFFFFF;
+	H[2] = (H[2] + C) & 0xFFFFFFFF;
+	H[3] = (H[3] + D) & 0xFFFFFFFF;
+	H[4] = (H[4] + E) & 0xFFFFFFFF;
+
+	Message_Block_Index = 0;
+}
+
+/*
+*  PadMessage
+*
+*  Description:
+*      According to the standard, the message must be padded to an even
+*      512 bits.  The first padding bit must be a '1'.  The last 64 bits
+*      represent the length of the original message.  All bits in between
+*      should be 0.  This function will pad the message according to those
+*      rules by filling the message_block array accordingly.  It will also
+*      call ProcessMessageBlock() appropriately.  When it returns, it
+*      can be assumed that the message digest has been computed.
+*
+*  Parameters:
+*      None.
+*
+*  Returns:
+*      Nothing.
+*
+*  Comments:
+*
+*/
+void SHA1::PadMessage()
+{
+	/*
+	*  Check to see if the current message block is too small to hold
+	*  the initial padding bits and length.  If so, we will pad the
+	*  block, process it, and then continue padding into a second block.
+	*/
+	if (Message_Block_Index > 55)
+	{
+		Message_Block[Message_Block_Index++] = 0x80;
+		while (Message_Block_Index < 64)
+		{
+			Message_Block[Message_Block_Index++] = 0;
+		}
+
+		ProcessMessageBlock();
+
+		while (Message_Block_Index < 56)
+		{
+			Message_Block[Message_Block_Index++] = 0;
+		}
+	}
+	else
+	{
+		Message_Block[Message_Block_Index++] = 0x80;
+		while (Message_Block_Index < 56)
+		{
+			Message_Block[Message_Block_Index++] = 0;
+		}
+
+	}
+
+	/*
+	*  Store the message length as the last 8 octets
+	*/
+	Message_Block[56] = (Length_High >> 24) & 0xFF;
+	Message_Block[57] = (Length_High >> 16) & 0xFF;
+	Message_Block[58] = (Length_High >> 8) & 0xFF;
+	Message_Block[59] = (Length_High) & 0xFF;
+	Message_Block[60] = (Length_Low >> 24) & 0xFF;
+	Message_Block[61] = (Length_Low >> 16) & 0xFF;
+	Message_Block[62] = (Length_Low >> 8) & 0xFF;
+	Message_Block[63] = (Length_Low) & 0xFF;
+
+	ProcessMessageBlock();
+}
+
+
+/*
+*  CircularShift
+*
+*  Description:
+*      This member function will perform a circular shifting operation.
+*
+*  Parameters:
+*      bits: [in]
+*          The number of bits to shift (1-31)
+*      word: [in]
+*          The value to shift (assumes a 32-bit integer)
+*
+*  Returns:
+*      The shifted value.
+*
+*  Comments:
+*
+*/
+unsigned SHA1::CircularShift(int bits, unsigned word)
+{
+	return ((word << bits) & 0xFFFFFFFF) | ((word & 0xFFFFFFFF) >> (32 - bits));
+}

websocketForMt4/SHA1.h

@@ -0,0 +1,91 @@
+/*
+*  sha1.h
+*
+*  Copyright (C) 1998, 2009
+*  Paul E. Jones <paulej@packetizer.com>
+*  All Rights Reserved.
+*
+*****************************************************************************
+*  $Id: sha1.h 12 2009-06-22 19:34:25Z paulej $
+*****************************************************************************
+*
+*  Description:
+*      This class implements the Secure Hashing Standard as defined
+*      in FIPS PUB 180-1 published April 17, 1995.
+*
+*      Many of the variable names in this class, especially the single
+*      character names, were used because those were the names used
+*      in the publication.
+*
+*      Please read the file sha1.cpp for more information.
+*
+*/
+
+#ifndef _SHA1_H_
+#define _SHA1_H_
+
+class SHA1
+{
+public:
+
+	SHA1();
+	virtual ~SHA1();
+
+	/*
+	*  Re-initialize the class
+	*/
+	void Reset();
+
+	/*
+	*  Returns the message digest
+	*/
+	bool Result(unsigned *message_digest_array);
+
+	/*
+	*  Provide input to SHA1
+	*/
+	void Input(const unsigned char *message_array,
+		unsigned            length);
+	void Input(const char  *message_array,
+		unsigned    length);
+	void Input(unsigned char message_element);
+	void Input(char message_element);
+	SHA1& operator<<(const char *message_array);
+	SHA1& operator<<(const unsigned char *message_array);
+	SHA1& operator<<(const char message_element);
+	SHA1& operator<<(const unsigned char message_element);
+
+private:
+
+	/*
+	*  Process the next 512 bits of the message
+	*/
+	void ProcessMessageBlock();
+
+	/*
+	*  Pads the current message block to 512 bits
+	*/
+	void PadMessage();
+
+	/*
+	*  Performs a circular left shift operation
+	*/
+	inline unsigned CircularShift(int bits, unsigned word);
+
+	unsigned H[5];                      // Message digest buffers
+
+	unsigned Length_Low;                // Message length in bits
+	unsigned Length_High;               // Message length in bits
+
+	unsigned char Message_Block[64];    // 512-bit message blocks
+	int Message_Block_Index;            // Index into message block array
+
+	bool Computed;                      // Is the digest computed?
+	bool Corrupted;                     // Is the message digest corruped?
+
+};
+
+
+#endif // _SHA1_H_
+
+

websocketForMt4/TcpServerProcess.cpp

@@ -0,0 +1,330 @@
+#include "stdafx.h"
+#include "TcpServerProcess.h"
+
+#include "SHA1.h"
+#include "ATW.h"
+static const std::string base64_chars =
+"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+"abcdefghijklmnopqrstuvwxyz"
+"0123456789+/";
+
+CTcpServerProcess::CTcpServerProcess():m_server(this)
+{
+	m_reve_event = NULL;
+	m_connid_event = NULL;
+}
+
+
+CTcpServerProcess::~CTcpServerProcess()
+{
+	
+}
+
+void CTcpServerProcess::Send(CONNID dwConnID, LPCSTR msg)
+{
+	int iLen = (int)strlen(msg);
+	m_server.Send(dwConnID,(LPBYTE)msg, iLen);
+}
+void CTcpServerProcess::Send(CONNID dwConnID, const BYTE* pBuffer, int iLength)
+{
+	m_server.Send(dwConnID, pBuffer, iLength);
+}
+
+void CTcpServerProcess::BroadMsg(json broadmsg)
+{
+	Sleep(800);
+	DWORD count =m_server.GetConnectionCount();
+	CONNID *pIDs = new CONNID[count];
+	m_server.GetAllConnectionIDs(pIDs, count);
+
+	for (unsigned int i = 0; i < count; ++i)
+		Send(pIDs[i], (broadmsg.dump() + "\r\n").c_str());
+	delete pIDs;
+}
+
+void CTcpServerProcess::BroadMsg(const BYTE* pBuffer, int iLength)
+{
+	DWORD count = m_server.GetConnectionCount();
+	CONNID *pIDs = new CONNID[count];
+	m_server.GetAllConnectionIDs(pIDs, count);
+
+	for (unsigned int i = 0; i < count; ++i)
+		Send(pIDs[i], pBuffer, iLength);
+	delete pIDs;
+}
+
+
+EnHandleResult CTcpServerProcess::OnPrepareListen(ITcpServer* pSender, SOCKET soListen)
+{
+	TCHAR szAddress[40];
+	int iAddressLen = sizeof(szAddress) / sizeof(TCHAR);
+	USHORT usPort;
+	pSender->GetListenAddress(szAddress, iAddressLen, usPort);
+	return HR_OK;
+}
+
+EnHandleResult CTcpServerProcess::OnAccept(ITcpServer* pSender, CONNID dwConnID, SOCKET soClient)
+{
+	
+	std::lock_guard<std::mutex> lk(m_muter_tcp);
+	BOOL bPass = TRUE;
+	TCHAR szAddress[40];
+	int iAddressLen = sizeof(szAddress) / sizeof(TCHAR);
+	USHORT usPort;
+
+	pSender->GetRemoteAddress(dwConnID, szAddress, iAddressLen, usPort);
+
+	//SetconnidEvent();
+	/*TCP_MSG info = { 0 };
+	info.dwConnID = dwConnID;
+	info.tp = std::chrono::high_resolution_clock::now();
+	info.ip = WChar2Ansi(AtoW(szAddress));
+	m_tcpmsg.insert(pair<CONNID, TCP_MSG>(dwConnID, info));*/
+
+	TCP_MSG *pInfo = new TCP_MSG;
+	pInfo->dwConnID = dwConnID;
+	pInfo->flag = 0;
+	pInfo->userId = szAddress;
+	pInfo->tp = std::chrono::high_resolution_clock::now();
+	pInfo->ip = szAddress;
+
+	m_userIdInfo[pInfo->ip] = dwConnID;
+	pSender->SetConnectionExtra(dwConnID, pInfo);
+
+	//m_timer.add_task([this]() {CloseConnect(); }, 0);//不需要进行心跳判断
+	return bPass ? HR_OK : HR_ERROR;
+}
+
+EnHandleResult CTcpServerProcess::OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)
+{
+
+	return HR_OK;
+}
+EnHandleResult CTcpServerProcess::OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength)
+{
+	std::lock_guard<std::mutex> lk(m_muter_tcp);
+	std::string msg = "";
+	for (int i = 0; i < iLength; i++)
+	{
+		msg += pData[i];
+	}
+
+	TCP_MSG *pInfo = nullptr;
+	pSender->GetConnectionExtra(dwConnID, (PVOID *)&pInfo);
+	if (pInfo)
+	{
+		pInfo->tp = std::chrono::high_resolution_clock::now();
+		pInfo->deal_msg.push_back(msg);
+	}
+	m_safemsg.push(pInfo);
+	SetRecvEvent();
+
+	/*std::lock_guard<std::mutex> lk(m_muter_tcp);
+	TCP_MSG rcvmsg{};
+	rcvmsg.dwConnID = dwConnID;
+	for (int i = 0; i < iLength; i++)
+	{
+	
+		rcvmsg.msg += pData[i];
+	}
+	rcvmsg.deal_msg.push_back(rcvmsg.msg);
+	auto tcpmsg = m_tcpmsg.find(dwConnID);
+	if (tcpmsg != m_tcpmsg.end())
+	{
+		rcvmsg.flag = tcpmsg->second.flag;
+		rcvmsg.type = tcpmsg->second.type;
+		rcvmsg.ip = tcpmsg->second.ip;
+		rcvmsg.userId = tcpmsg->second.userId;
+		tcpmsg->second.tp= std::chrono::high_resolution_clock::now();
+	}
+	
+	m_rcvmsg.push_back(rcvmsg);
+	SetRecvEvent();*/
+	
+	return HR_OK;
+}
+
+EnHandleResult CTcpServerProcess::OnClose(ITcpServer* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode)
+{
+	{
+		/*std::lock_guard<std::mutex> lk(m_muter_tcp);
+		Iter iter = m_tcpmsg.find(dwConnID);
+		if (iter != m_tcpmsg.end())
+		{
+			auto usr = m_userIdInfo.find(iter->second.userId);
+			if (usr != m_userIdInfo.end() && usr->second== dwConnID)m_userIdInfo.erase(usr);
+			m_tcpmsg.erase(iter);
+		}*/
+
+		TCP_MSG *pInfo = nullptr;
+		pSender->GetConnectionExtra(dwConnID, (PVOID *)&pInfo);
+		/*if (pInfo)
+		{
+			auto usr = m_userIdInfo.find(pInfo->userId);
+			if (usr != m_userIdInfo.end() && usr->second == dwConnID)m_userIdInfo.erase(usr);
+			delete pInfo;
+		}*/
+		if (pInfo)
+		{
+			pInfo->flag = -1;
+			m_safemsg.push(pInfo);
+		}
+		
+	}
+	
+	return HR_OK;
+}
+
+EnHandleResult CTcpServerProcess::OnShutdown(ITcpServer* pSender)
+{
+	return HR_OK;
+}
+void CTcpServerProcess::WaitRecvEvent()
+{
+	WaitForSingleObject(m_reve_event, INFINITE);
+}
+void CTcpServerProcess::SetRecvEvent()
+{
+	SetEvent(m_reve_event);
+}
+void CTcpServerProcess::WaitconnidEvent()
+{
+	WaitForSingleObject(m_connid_event, INFINITE);
+}
+void CTcpServerProcess::SetconnidEvent()
+{
+	SetEvent(m_connid_event);
+}
+
+bool CTcpServerProcess::GetConnid(std::string addr, CONNID &dwConnID)
+{
+	std::lock_guard<std::mutex> lkaddr(m_muter_addr);
+	AddrIter addriter = m_tcpaddr_connid.find(addr);
+	if (addriter != m_tcpaddr_connid.end())
+	{
+		dwConnID = addriter->second;
+		return true;
+	}
+	return false;
+}
+
+bool CTcpServerProcess::ReadMsg(std::vector<string>& vec, CONNID &dwConnID, int &flag,std::string &ip, std::string &userId)
+{
+	/*if (m_rcvmsg.size() <= 0)return false;
+	std::lock_guard<std::mutex> lk(m_muter_tcp);
+	TCP_MSG rcvmsg = m_rcvmsg.front();
+	m_rcvmsg.pop_front();
+	dwConnID = rcvmsg.dwConnID;
+	flag = rcvmsg.flag;
+	ip = rcvmsg.ip;
+	userId =rcvmsg.userId;
+	if (rcvmsg.deal_msg.size() > 0)
+	{
+		vec.swap(rcvmsg.deal_msg);
+		return true;
+	}
+	return false; */
+	//std::lock_guard<std::mutex> lk(m_muter_tcp);
+	TCP_MSG *pmsg = nullptr;
+	m_safemsg.wait_and_pop(pmsg);
+	if (pmsg == nullptr)return false;
+	dwConnID = pmsg->dwConnID;
+	flag = pmsg->flag;
+	ip = pmsg->ip;
+	userId = pmsg->userId;
+	if (pmsg->flag == 0)
+		pmsg->flag = 1;
+	if (pmsg->deal_msg.size() > 0)
+	{
+		vec.swap(pmsg->deal_msg);
+		
+	}
+	return true;
+}
+
+void CTcpServerProcess::CloseClient(CONNID dwConnID)
+{
+	m_server.CloseClient(dwConnID);
+}
+
+int CTcpServerProcess::Start()
+{
+	m_reve_event = CreateEvent(NULL,FALSE,FALSE,NULL);
+	m_connid_event = CreateEvent(NULL, FALSE, FALSE, NULL);
+	TCHAR addr[MAX_PATH];
+	_stprintf_s(addr, MAX_PATH, _T("%S"), m_addr.c_str());//%S宽字符  
+	if (!m_server.Start(m_addr.c_str(), m_port))
+	{
+		return -1;
+	}
+	m_timer.run();
+	return 0;
+}
+void CTcpServerProcess::Stop()
+{
+	SetRecvEvent();
+	m_server.Stop();
+	if (m_reve_event != NULL)
+		CloseHandle(m_reve_event);
+	if (m_connid_event != NULL)
+		CloseHandle(m_connid_event);
+}
+
+std::string CTcpServerProcess::WChar2Ansi(std::wstring wstr)
+{
+	int nLen = WideCharToMultiByte(CP_ACP, 0, LPCWSTR(wstr.c_str()), -1, NULL, 0, NULL, NULL);
+
+	if (nLen <= 0) return std::string("");
+
+	char* pszDst = new char[nLen];
+	if (NULL == pszDst) return std::string("");
+
+	WideCharToMultiByte(CP_ACP, 0, LPCWSTR(wstr.c_str()), -1, pszDst, nLen, NULL, NULL);
+	pszDst[nLen - 1] = 0;
+
+	std::string strTemp(pszDst);
+	delete[] pszDst;
+
+	return strTemp;
+}
+
+int CTcpServerProcess::GetConnectionCount()
+{
+	return m_server.GetConnectionCount();
+}
+
+
+void CTcpServerProcess::CloseConnect()
+{
+	static std::chrono::high_resolution_clock::time_point local_tp = std::chrono::high_resolution_clock::now();
+	auto tp = std::chrono::high_resolution_clock::now();
+	auto tmp = std::chrono::duration_cast<std::chrono::seconds>(tp - local_tp).count();
+	if (tmp>30)
+	{
+		local_tp = tp;
+		std::map<CONNID, TCP_MSG> _map(m_tcpmsg);
+		for (auto m : _map)
+		{
+			tmp = std::chrono::duration_cast<std::chrono::seconds>(tp - m.second.tp).count();
+			if (tmp > (15 * 60))
+			{
+				m_server.Disconnect(m.second.dwConnID);
+			}
+		}
+	}
+}
+
+void CTcpServerProcess::CloseConnect(CONNID dwConnID)
+{
+	m_server.Disconnect(dwConnID);
+}
+
+void CTcpServerProcess::DeleteInfo(CONNID dwConnID)
+{
+	TCP_MSG *pInfo = nullptr;
+	m_server.GetConnectionExtra(dwConnID, (PVOID *)&pInfo);
+	if (pInfo)
+	{
+		delete pInfo;
+	}
+}

websocketForMt4/TcpServerProcess.h

@@ -0,0 +1,80 @@
+#pragma once
+#include "..\socket\HP-Socket\Src\TcpServer.h"
+#include "..\socket\HP-Socket\Src\SocketInterface.h"
+#include "timer.hpp"
+#include <string>
+#include <deque>
+#include <vector>
+#include <map>
+#include "threadsafe_queue.hpp"
+using namespace std;
+#include "json.hpp"
+using json = nlohmann::json;
+struct TCP_MSG
+{
+	CONNID dwConnID;
+	std::string userId;
+	int			type;
+	std::string msg;
+	char flag;
+	std::vector<string> deal_msg;
+	std::chrono::high_resolution_clock::time_point tp;
+	std::string ip;
+};
+
+
+class CTcpServerProcess:public CTcpServerListener
+{
+public:
+	CTcpServerProcess();
+	~CTcpServerProcess();
+public:
+	void Send(CONNID dwConnID,LPCSTR msg);
+	void Send(CONNID dwConnID, const BYTE* pBuffer, int iLength);
+	void WaitRecvEvent();
+	void SetRecvEvent();
+	bool ReadMsg(std::vector<string> &vec, CONNID & dwConnID, int &flag, std::string &ip,std::string &userId);
+	void CloseClient(CONNID dwConnID);
+	int Start();
+	void Stop();
+	void SetServerPort(int port) { m_port=port; }
+	void SetAddr(std::string addr) { m_addr= addr; }
+	void BroadMsg(json broadmsg);
+	void BroadMsg(const BYTE* pBuffer, int iLength);
+	//bool UpdateConnID(std::string &addr, CONNID & dwConnID);
+	std::string WChar2Ansi(std::wstring wstr);
+	void WaitconnidEvent();
+	void SetconnidEvent();
+	bool GetConnid(std::string addr, CONNID &dwConnID);
+	int  GetConnectionCount();
+	void CloseConnect();
+	void CloseConnect(CONNID dwConnID);
+	void DeleteInfo(CONNID dwConnID);
+	std::map<std::string, CONNID> m_userIdInfo;
+	CTcpServer					m_server;
+private:
+	virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen);
+	virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, SOCKET soClient);
+	virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength);
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength);
+	virtual EnHandleResult OnClose(ITcpServer* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode);
+	virtual EnHandleResult OnShutdown(ITcpServer* pSender);
+private:
+	
+	std::deque<CONNID>			m_de_connid;
+	std::map<CONNID, TCP_MSG>	m_tcpmsg;
+	std::map<std::string, CONNID>	m_tcpaddr_connid;
+	typedef std::map<CONNID, TCP_MSG>::iterator Iter;
+	typedef std::map<std::string, CONNID>::iterator AddrIter;
+	std::mutex					m_muter_tcp;
+	std::mutex					m_muter_addr;
+	HANDLE						m_reve_event;
+	HANDLE						m_connid_event;
+	std::string					m_addr;
+	int							m_port;
+	std::deque<TCP_MSG>			m_rcvmsg;
+	threadsafe_queue<TCP_MSG*>	m_safemsg;
+	tools::tim::timer			m_timer;
+
+};
+

websocketForMt4/csv.hpp

@@ -0,0 +1,133 @@
+/* Copyright (C) 1999 Lucent Technologies */
+/* Excerpted from 'The Practice of Programming' */
+/* by Brian W. Kernighan and Rob Pike */
+
+#include <iostream>
+#include <algorithm>
+#include <string>
+#include <vector>
+
+using namespace std;
+
+class Csv
+{ // read and parse comma-separated values
+    // sample input: "LU",86.25,"11/4/1998","2:19PM",+4.0625
+
+public:
+    Csv(istream& fin = cin, string sep = ",") :
+      fin(fin), fieldsep(sep) {}
+
+      int getline(string&);
+      string getfield(int n);
+      int getnfield() const { return nfield; }
+
+private:
+    istream& fin; // input file pointer
+    string line; // input line
+    vector<string> field; // field strings
+    int nfield; // number of fields
+    string fieldsep; // separator characters
+
+    int split();
+    int endofline(char);
+    int advplain(const string& line, string& fld, int);
+    int advquoted(const string& line, string& fld, int);
+};
+
+// endofline: check for and consume \r, \n, \r\n, or EOF
+int Csv::endofline(char c)
+{
+    int eol;
+
+    eol = (c=='\r' || c=='\n');
+    if (c == '\r')
+    {
+        fin.get(c);
+        if (!fin.eof() && c != '\n')
+            fin.putback(c); // read too far
+    }
+    return eol;
+}
+
+// getline: get one line, grow as needed
+int Csv::getline(string& str)
+{
+    char c;
+
+    for (line = ""; fin.get(c) && !endofline(c); )
+        line += c;
+    split();
+    str = line;
+    return !fin.eof();
+}
+
+// split: split line into fields
+int Csv::split()
+{
+    string fld;
+    int i, j;
+
+    nfield = 0;
+    if (line.length() == 0)
+        return 0;
+    i = 0;
+
+    do {
+        if (i < line.length() && line[i] == '"')
+            j = advquoted(line, fld, ++i); // skip quote
+        else
+            j = advplain(line, fld, i);
+        if (nfield >= field.size())
+            field.push_back(fld);
+        else
+            field[nfield] = fld;
+        nfield++;
+        i = j + 1;
+    } while (j < line.length());
+
+    return nfield;
+}
+
+// advquoted: quoted field; return index of next separator
+int Csv::advquoted(const string& s, string& fld, int i)
+{
+    int j;
+
+    fld = "";
+    for (j = i; j < s.length(); j++)
+    {
+        if (s[j] == '"' && s[++j] != '"')
+        {
+            int k = s.find_first_of(fieldsep, j);
+            if (k > s.length()) // no separator found
+                k = s.length();
+            for (k -= j; k-- > 0; )
+                fld += s[j++];
+            break;
+        }
+        fld += s[j];
+    }
+    return j;
+}
+
+// advplain: unquoted field; return index of next separator
+int Csv::advplain(const string& s, string& fld, int i)
+{
+    int j;
+
+    j = s.find_first_of(fieldsep, i); // look for separator
+    if (j > s.length()) // none found
+        j = s.length();
+    fld = string(s, i, j-i);
+    return j;
+}
+
+
+// getfield: return n-th field
+string Csv::getfield(int n)
+{
+    if (n < 0 || n >= nfield)
+        return "";
+    else
+        return field[n];
+}

websocketForMt4/json.hpp

@@ -0,0 +1,13985 @@
+/*
+    __ _____ _____ _____
+ __|  |   __|     |   | |  JSON for Modern C++
+|  |  |__   |  |  | | | |  version 2.1.1
+|_____|_____|_____|_|___|  https://github.com/nlohmann/json
+
+Licensed under the MIT License <http://opensource.org/licenses/MIT>.
+Copyright (c) 2013-2017 Niels Lohmann <http://nlohmann.me>.
+
+Permission is hereby  granted, free of charge, to any  person obtaining a copy
+of this software and associated  documentation files (the "Software"), to deal
+in the Software  without restriction, including without  limitation the rights
+to  use, copy,  modify, merge,  publish, distribute,  sublicense, and/or  sell
+copies  of  the Software,  and  to  permit persons  to  whom  the Software  is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE  IS PROVIDED "AS  IS", WITHOUT WARRANTY  OF ANY KIND,  EXPRESS OR
+IMPLIED,  INCLUDING BUT  NOT  LIMITED TO  THE  WARRANTIES OF  MERCHANTABILITY,
+FITNESS FOR  A PARTICULAR PURPOSE AND  NONINFRINGEMENT. IN NO EVENT  SHALL THE
+AUTHORS  OR COPYRIGHT  HOLDERS  BE  LIABLE FOR  ANY  CLAIM,  DAMAGES OR  OTHER
+LIABILITY, WHETHER IN AN ACTION OF  CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE  OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+#ifndef NLOHMANN_JSON_HPP
+#define NLOHMANN_JSON_HPP
+
+#include <algorithm> // all_of, copy, fill, find, for_each, none_of, remove, reverse, transform
+#include <array> // array
+#include <cassert> // assert
+#include <ciso646> // and, not, or
+#include <clocale> // lconv, localeconv
+#include <cmath> // isfinite, labs, ldexp, signbit
+#include <cstddef> // nullptr_t, ptrdiff_t, size_t
+#include <cstdint> // int64_t, uint64_t
+#include <cstdlib> // abort, strtod, strtof, strtold, strtoul, strtoll, strtoull
+#include <cstring> // strlen
+#include <forward_list> // forward_list
+#include <functional> // function, hash, less
+#include <initializer_list> // initializer_list
+#include <iostream> // istream, ostream
+#include <iterator> // advance, begin, back_inserter, bidirectional_iterator_tag, distance, end, inserter, iterator, iterator_traits, next, random_access_iterator_tag, reverse_iterator
+#include <limits> // numeric_limits
+#include <locale> // locale
+#include <map> // map
+#include <memory> // addressof, allocator, allocator_traits, unique_ptr
+#include <numeric> // accumulate
+#include <sstream> // stringstream
+#include <string> // getline, stoi, string, to_string
+#include <type_traits> // add_pointer, conditional, decay, enable_if, false_type, integral_constant, is_arithmetic, is_base_of, is_const, is_constructible, is_convertible, is_default_constructible, is_enum, is_floating_point, is_integral, is_nothrow_move_assignable, is_nothrow_move_constructible, is_pointer, is_reference, is_same, is_scalar, is_signed, remove_const, remove_cv, remove_pointer, remove_reference, true_type, underlying_type
+#include <utility> // declval, forward, make_pair, move, pair, swap
+#include <vector> // vector
+
+// exclude unsupported compilers
+#if defined(__clang__)
+    #if (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) < 30400
+        #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers"
+    #endif
+#elif defined(__GNUC__)
+    #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) < 40900
+        #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers"
+    #endif
+#endif
+
+// disable float-equal warnings on GCC/clang
+#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
+    #pragma GCC diagnostic push
+    #pragma GCC diagnostic ignored "-Wfloat-equal"
+#endif
+
+// disable documentation warnings on clang
+#if defined(__clang__)
+    #pragma GCC diagnostic push
+    #pragma GCC diagnostic ignored "-Wdocumentation"
+#endif
+
+// allow for portable deprecation warnings
+#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
+    #define JSON_DEPRECATED __attribute__((deprecated))
+#elif defined(_MSC_VER)
+    #define JSON_DEPRECATED __declspec(deprecated)
+#else
+    #define JSON_DEPRECATED
+#endif
+
+// allow to disable exceptions
+#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && not defined(JSON_NOEXCEPTION)
+    #define JSON_THROW(exception) throw exception
+    #define JSON_TRY try
+    #define JSON_CATCH(exception) catch(exception)
+#else
+    #define JSON_THROW(exception) std::abort()
+    #define JSON_TRY if(true)
+    #define JSON_CATCH(exception) if(false)
+#endif
+
+/*!
+@brief namespace for Niels Lohmann
+@see https://github.com/nlohmann
+@since version 1.0.0
+*/
+namespace nlohmann
+{
+
+/*!
+@brief unnamed namespace with internal helper functions
+
+This namespace collects some functions that could not be defined inside the
+@ref basic_json class.
+
+@since version 2.1.0
+*/
+namespace detail
+{
+////////////////
+// exceptions //
+////////////////
+
+/*!
+@brief general exception of the @ref basic_json class
+
+Extension of std::exception objects with a member @a id for exception ids.
+
+@note To have nothrow-copy-constructible exceptions, we internally use
+      std::runtime_error which can cope with arbitrary-length error messages.
+      Intermediate strings are built with static functions and then passed to
+      the actual constructor.
+
+@since version 3.0.0
+*/
+class exception : public std::exception
+{
+  public:
+    /// returns the explanatory string
+    virtual const char* what() const noexcept override
+    {
+        return m.what();
+    }
+
+    /// the id of the exception
+    const int id;
+
+  protected:
+    exception(int id_, const char* what_arg)
+        : id(id_), m(what_arg)
+    {}
+
+    static std::string name(const std::string& ename, int id)
+    {
+        return "[json.exception." + ename + "." + std::to_string(id) + "] ";
+    }
+
+  private:
+    /// an exception object as storage for error messages
+    std::runtime_error m;
+};
+
+/*!
+@brief exception indicating a parse error
+
+This excpetion is thrown by the library when a parse error occurs. Parse
+errors can occur during the deserialization of JSON text as well as when
+using JSON Patch.
+
+Member @a byte holds the byte index of the last read character in the input
+file.
+
+@note For an input with n bytes, 1 is the index of the first character
+      and n+1 is the index of the terminating null byte or the end of
+      file. This also holds true when reading a byte vector (CBOR or
+      MessagePack).
+
+Exceptions have ids 1xx.
+
+name / id                      | example massage | description
+------------------------------ | --------------- | -------------------------
+json.exception.parse_error.101 | parse error at 2: unexpected end of input; expected string literal | This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member @a byte indicates the error position.
+json.exception.parse_error.102 | parse error at 14: missing or wrong low surrogate | JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point.
+json.exception.parse_error.103 | parse error: code points above 0x10FFFF are invalid | Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid.
+json.exception.parse_error.104 | parse error: JSON patch must be an array of objects | [RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects.
+json.exception.parse_error.105 | parse error: operation must have string member 'op' | An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
+json.exception.parse_error.106 | parse error: array index '01' must not begin with '0' | An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number wihtout a leading `0`.
+json.exception.parse_error.107 | parse error: JSON pointer must be empty or begin with '/' - was: 'foo' | A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character.
+json.exception.parse_error.108 | parse error: escape character '~' must be followed with '0' or '1' | In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
+json.exception.parse_error.109 | parse error: array index 'one' is not a number | A JSON Pointer array index must be a number.
+json.exception.parse_error.110 | parse error at 1: cannot read 2 bytes from vector | When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read.
+json.exception.parse_error.111 | parse error: bad input stream | Parsing CBOR or MessagePack from an input stream where the [`badbit` or `failbit`](http://en.cppreference.com/w/cpp/io/ios_base/iostate) is set.
+json.exception.parse_error.112 | parse error at 1: error reading CBOR; last byte: 0xf8 | Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read.
+json.exception.parse_error.113 | parse error at 2: expected a CBOR string; last byte: 0x98 | While parsing a map key, a value that is not a string has been read.
+
+@since version 3.0.0
+*/
+class parse_error : public exception
+{
+  public:
+    /*!
+    @brief create a parse error exception
+    @param[in] id         the id of the exception
+    @param[in] byte_      the byte index where the error occured (or 0 if
+                          the position cannot be determined)
+    @param[in] what_arg   the explanatory string
+    @return parse_error object
+    */
+    static parse_error create(int id, size_t byte_, const std::string& what_arg)
+    {
+        std::string w = exception::name("parse_error", id) + "parse error" +
+                        (byte_ != 0 ? (" at " + std::to_string(byte_)) : "") +
+                        ": " + what_arg;
+        return parse_error(id, byte_, w.c_str());
+    }
+
+    /*!
+    @brief byte index of the parse error
+
+    The byte index of the last read character in the input file.
+
+    @note For an input with n bytes, 1 is the index of the first character
+          and n+1 is the index of the terminating null byte or the end of
+          file. This also holds true when reading a byte vector (CBOR or
+          MessagePack).
+    */
+    const size_t byte;
+
+  private:
+    parse_error(int id_, size_t byte_, const char* what_arg)
+        : exception(id_, what_arg), byte(byte_)
+    {}
+};
+
+/*!
+@brief exception indicating errors with iterators
+
+Exceptions have ids 2xx.
+
+name / id                           | example massage | description
+----------------------------------- | --------------- | -------------------------
+json.exception.invalid_iterator.201 | iterators are not compatible | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
+json.exception.invalid_iterator.202 | iterator does not fit current value | In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion.
+json.exception.invalid_iterator.203 | iterators do not fit current value | Either iterator passed to function @ref erase(IteratorType first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from.
+json.exception.invalid_iterator.204 | iterators out of range | When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (@ref begin(), @ref end()), because this is the only way the single stored value is expressed. All other ranges are invalid.
+json.exception.invalid_iterator.205 | iterator out of range | When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the @ref begin() iterator, because it is the only way to address the stored value. All other iterators are invalid.
+json.exception.invalid_iterator.206 | cannot construct with iterators from null | The iterators passed to constructor @ref basic_json(InputIT first, InputIT last) belong to a JSON null value and hence to not define a valid range.
+json.exception.invalid_iterator.207 | cannot use key() for non-object iterators | The key() member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key.
+json.exception.invalid_iterator.208 | cannot use operator[] for object iterators | The operator[] to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
+json.exception.invalid_iterator.209 | cannot use offsets with object iterators | The offset operators (+, -, +=, -=) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
+json.exception.invalid_iterator.210 | iterators do not fit | The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (@a first, @a last) is invalid.
+json.exception.invalid_iterator.211 | passed iterators may not belong to container | The iterator range passed to the insert function must not be a subrange of the container to insert to.
+json.exception.invalid_iterator.212 | cannot compare iterators of different containers | When two iterators are compared, they must belong to the same container.
+json.exception.invalid_iterator.213 | cannot compare order of object iterators | The order of object iterators cannot be compated, because JSON objects are unordered.
+json.exception.invalid_iterator.214 | cannot get value | Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to @ref begin().
+
+@since version 3.0.0
+*/
+class invalid_iterator : public exception
+{
+  public:
+    static invalid_iterator create(int id, const std::string& what_arg)
+    {
+        std::string w = exception::name("invalid_iterator", id) + what_arg;
+        return invalid_iterator(id, w.c_str());
+    }
+
+  private:
+    invalid_iterator(int id_, const char* what_arg)
+        : exception(id_, what_arg)
+    {}
+};
+
+/*!
+@brief exception indicating executing a member function with a wrong type
+
+Exceptions have ids 3xx.
+
+name / id                     | example massage | description
+----------------------------- | --------------- | -------------------------
+json.exception.type_error.301 | cannot create object from initializer list | To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead.
+json.exception.type_error.302 | type must be object, but is array | During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types.
+json.exception.type_error.303 | incompatible ReferenceType for get_ref, actual type is object | To retrieve a reference to a value stored in a @ref basic_json object with @ref get_ref, the type of the reference must match the value type. For instance, for a JSON array, the @a ReferenceType must be @ref array_t&.
+json.exception.type_error.304 | cannot use at() with string | The @ref at() member functions can only be executed for certain JSON types.
+json.exception.type_error.305 | cannot use operator[] with string | The @ref operator[] member functions can only be executed for certain JSON types.
+json.exception.type_error.306 | cannot use value() with string | The @ref value() member functions can only be executed for certain JSON types.
+json.exception.type_error.307 | cannot use erase() with string | The @ref erase() member functions can only be executed for certain JSON types.
+json.exception.type_error.308 | cannot use push_back() with string | The @ref push_back() and @ref operator+= member functions can only be executed for certain JSON types.
+json.exception.type_error.309 | cannot use insert() with | The @ref insert() member functions can only be executed for certain JSON types.
+json.exception.type_error.310 | cannot use swap() with number | The @ref swap() member functions can only be executed for certain JSON types.
+json.exception.type_error.311 | cannot use emplace_back() with string | The @ref emplace_back() member function can only be executed for certain JSON types.
+json.exception.type_error.313 | invalid value to unflatten | The @ref unflatten function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined.
+json.exception.type_error.314 | only objects can be unflattened | The @ref unflatten function only works for an object whose keys are JSON Pointers.
+json.exception.type_error.315 | values in object must be primitive | The @ref unflatten function only works for an object whose keys are JSON Pointers and whose values are primitive.
+
+@since version 3.0.0
+*/
+class type_error : public exception
+{
+  public:
+    static type_error create(int id, const std::string& what_arg)
+    {
+        std::string w = exception::name("type_error", id) + what_arg;
+        return type_error(id, w.c_str());
+    }
+
+  private:
+    type_error(int id_, const char* what_arg)
+        : exception(id_, what_arg)
+    {}
+};
+
+/*!
+@brief exception indicating access out of the defined range
+
+Exceptions have ids 4xx.
+
+name / id                       | example massage | description
+------------------------------- | --------------- | -------------------------
+json.exception.out_of_range.401 | array index 3 is out of range | The provided array index @a i is larger than @a size-1.
+json.exception.out_of_range.402 | array index '-' (3) is out of range | The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it.
+json.exception.out_of_range.403 | key 'foo' not found | The provided key was not found in the JSON object.
+json.exception.out_of_range.404 | unresolved reference token 'foo' | A reference token in a JSON Pointer could not be resolved.
+json.exception.out_of_range.405 | JSON pointer has no parent | The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value.
+json.exception.out_of_range.406 | number overflow parsing '10E1000' | A parsed number could not be stored as without changing it to NaN or INF.
+
+@since version 3.0.0
+*/
+class out_of_range : public exception
+{
+  public:
+    static out_of_range create(int id, const std::string& what_arg)
+    {
+        std::string w = exception::name("out_of_range", id) + what_arg;
+        return out_of_range(id, w.c_str());
+    }
+
+  private:
+    out_of_range(int id_, const char* what_arg)
+        : exception(id_, what_arg)
+    {}
+};
+
+/*!
+@brief exception indicating other errors
+
+Exceptions have ids 5xx.
+
+name / id                      | example massage | description
+------------------------------ | --------------- | -------------------------
+json.exception.other_error.501 | unsuccessful: {"op":"test","path":"/baz", "value":"bar"} | A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
+
+@since version 3.0.0
+*/
+class other_error : public exception
+{
+  public:
+    static other_error create(int id, const std::string& what_arg)
+    {
+        std::string w = exception::name("other_error", id) + what_arg;
+        return other_error(id, w.c_str());
+    }
+
+  private:
+    other_error(int id_, const char* what_arg)
+        : exception(id_, what_arg)
+    {}
+};
+
+
+
+///////////////////////////
+// JSON type enumeration //
+///////////////////////////
+
+/*!
+@brief the JSON type enumeration
+
+This enumeration collects the different JSON types. It is internally used to
+distinguish the stored values, and the functions @ref basic_json::is_null(),
+@ref basic_json::is_object(), @ref basic_json::is_array(),
+@ref basic_json::is_string(), @ref basic_json::is_boolean(),
+@ref basic_json::is_number() (with @ref basic_json::is_number_integer(),
+@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()),
+@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and
+@ref basic_json::is_structured() rely on it.
+
+@note There are three enumeration entries (number_integer, number_unsigned, and
+number_float), because the library distinguishes these three types for numbers:
+@ref basic_json::number_unsigned_t is used for unsigned integers,
+@ref basic_json::number_integer_t is used for signed integers, and
+@ref basic_json::number_float_t is used for floating-point numbers or to
+approximate integers which do not fit in the limits of their respective type.
+
+@sa @ref basic_json::basic_json(const value_t value_type) -- create a JSON
+value with the default value for a given type
+
+@since version 1.0.0
+*/
+enum class value_t : uint8_t
+{
+    null,            ///< null value
+    object,          ///< object (unordered set of name/value pairs)
+    array,           ///< array (ordered collection of values)
+    string,          ///< string value
+    boolean,         ///< boolean value
+    number_integer,  ///< number value (signed integer)
+    number_unsigned, ///< number value (unsigned integer)
+    number_float,    ///< number value (floating-point)
+    discarded        ///< discarded by the the parser callback function
+};
+
+/*!
+@brief comparison operator for JSON types
+
+Returns an ordering that is similar to Python:
+- order: null < boolean < number < object < array < string
+- furthermore, each type is not smaller than itself
+
+@since version 1.0.0
+*/
+inline bool operator<(const value_t lhs, const value_t rhs) noexcept
+{
+    static constexpr std::array<uint8_t, 8> order = {{
+            0, // null
+            3, // object
+            4, // array
+            5, // string
+            1, // boolean
+            2, // integer
+            2, // unsigned
+            2, // float
+        }
+    };
+
+    // discarded values are not comparable
+    if (lhs == value_t::discarded or rhs == value_t::discarded)
+    {
+        return false;
+    }
+
+    return order[static_cast<std::size_t>(lhs)] <
+           order[static_cast<std::size_t>(rhs)];
+}
+
+
+/////////////
+// helpers //
+/////////////
+
+// alias templates to reduce boilerplate
+template<bool B, typename T = void>
+using enable_if_t = typename std::enable_if<B, T>::type;
+
+template<typename T>
+using uncvref_t = typename std::remove_cv<typename std::remove_reference<T>::type>::type;
+
+/*
+Implementation of two C++17 constructs: conjunction, negation. This is needed
+to avoid evaluating all the traits in a condition
+
+For example: not std::is_same<void, T>::value and has_value_type<T>::value
+will not compile when T = void (on MSVC at least). Whereas
+conjunction<negation<std::is_same<void, T>>, has_value_type<T>>::value will
+stop evaluating if negation<...>::value == false
+
+Please note that those constructs must be used with caution, since symbols can
+become very long quickly (which can slow down compilation and cause MSVC
+internal compiler errors). Only use it when you have to (see example ahead).
+*/
+template<class...> struct conjunction : std::true_type {};
+template<class B1> struct conjunction<B1> : B1 {};
+template<class B1, class... Bn>
+struct conjunction<B1, Bn...> : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {};
+
+template<class B> struct negation : std::integral_constant < bool, !B::value > {};
+
+// dispatch utility (taken from ranges-v3)
+template<unsigned N> struct priority_tag : priority_tag < N - 1 > {};
+template<> struct priority_tag<0> {};
+
+
+//////////////////
+// constructors //
+//////////////////
+
+template<value_t> struct external_constructor;
+
+template<>
+struct external_constructor<value_t::boolean>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, typename BasicJsonType::boolean_t b) noexcept
+    {
+        j.m_type = value_t::boolean;
+        j.m_value = b;
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::string>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, const typename BasicJsonType::string_t& s)
+    {
+        j.m_type = value_t::string;
+        j.m_value = s;
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::number_float>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, typename BasicJsonType::number_float_t val) noexcept
+    {
+        j.m_type = value_t::number_float;
+        j.m_value = val;
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::number_unsigned>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, typename BasicJsonType::number_unsigned_t val) noexcept
+    {
+        j.m_type = value_t::number_unsigned;
+        j.m_value = val;
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::number_integer>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, typename BasicJsonType::number_integer_t val) noexcept
+    {
+        j.m_type = value_t::number_integer;
+        j.m_value = val;
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::array>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, const typename BasicJsonType::array_t& arr)
+    {
+        j.m_type = value_t::array;
+        j.m_value = arr;
+        j.assert_invariant();
+    }
+
+    template<typename BasicJsonType, typename CompatibleArrayType,
+             enable_if_t<not std::is_same<CompatibleArrayType,
+                                          typename BasicJsonType::array_t>::value,
+                         int> = 0>
+    static void construct(BasicJsonType& j, const CompatibleArrayType& arr)
+    {
+        using std::begin;
+        using std::end;
+        j.m_type = value_t::array;
+        j.m_value.array = j.template create<typename BasicJsonType::array_t>(begin(arr), end(arr));
+        j.assert_invariant();
+    }
+
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, const std::vector<bool>& arr)
+    {
+        j.m_type = value_t::array;
+        j.m_value = value_t::array;
+        j.m_value.array->reserve(arr.size());
+        for (bool x : arr)
+        {
+            j.m_value.array->push_back(x);
+        }
+        j.assert_invariant();
+    }
+};
+
+template<>
+struct external_constructor<value_t::object>
+{
+    template<typename BasicJsonType>
+    static void construct(BasicJsonType& j, const typename BasicJsonType::object_t& obj)
+    {
+        j.m_type = value_t::object;
+        j.m_value = obj;
+        j.assert_invariant();
+    }
+
+    template<typename BasicJsonType, typename CompatibleObjectType,
+             enable_if_t<not std::is_same<CompatibleObjectType,
+                                          typename BasicJsonType::object_t>::value,
+                         int> = 0>
+    static void construct(BasicJsonType& j, const CompatibleObjectType& obj)
+    {
+        using std::begin;
+        using std::end;
+
+        j.m_type = value_t::object;
+        j.m_value.object = j.template create<typename BasicJsonType::object_t>(begin(obj), end(obj));
+        j.assert_invariant();
+    }
+};
+
+
+////////////////////////
+// has_/is_ functions //
+////////////////////////
+
+/*!
+@brief Helper to determine whether there's a key_type for T.
+
+This helper is used to tell associative containers apart from other containers
+such as sequence containers. For instance, `std::map` passes the test as it
+contains a `mapped_type`, whereas `std::vector` fails the test.
+
+@sa http://stackoverflow.com/a/7728728/266378
+@since version 1.0.0, overworked in version 2.0.6
+*/
+#define NLOHMANN_JSON_HAS_HELPER(type)                                        \
+    template<typename T> struct has_##type {                                  \
+    private:                                                                  \
+        template<typename U, typename = typename U::type>                     \
+        static int detect(U &&);                                              \
+        static void detect(...);                                              \
+    public:                                                                   \
+        static constexpr bool value =                                         \
+                std::is_integral<decltype(detect(std::declval<T>()))>::value; \
+    }
+
+NLOHMANN_JSON_HAS_HELPER(mapped_type);
+NLOHMANN_JSON_HAS_HELPER(key_type);
+NLOHMANN_JSON_HAS_HELPER(value_type);
+NLOHMANN_JSON_HAS_HELPER(iterator);
+
+#undef NLOHMANN_JSON_HAS_HELPER
+
+
+template<bool B, class RealType, class CompatibleObjectType>
+struct is_compatible_object_type_impl : std::false_type {};
+
+template<class RealType, class CompatibleObjectType>
+struct is_compatible_object_type_impl<true, RealType, CompatibleObjectType>
+{
+    static constexpr auto value =
+        std::is_constructible<typename RealType::key_type,
+        typename CompatibleObjectType::key_type>::value and
+        std::is_constructible<typename RealType::mapped_type,
+        typename CompatibleObjectType::mapped_type>::value;
+};
+
+template<class BasicJsonType, class CompatibleObjectType>
+struct is_compatible_object_type
+{
+    static auto constexpr value = is_compatible_object_type_impl <
+                                  conjunction<negation<std::is_same<void, CompatibleObjectType>>,
+                                  has_mapped_type<CompatibleObjectType>,
+                                  has_key_type<CompatibleObjectType>>::value,
+                                  typename BasicJsonType::object_t, CompatibleObjectType >::value;
+};
+
+template<typename BasicJsonType, typename T>
+struct is_basic_json_nested_type
+{
+    static auto constexpr value = std::is_same<T, typename BasicJsonType::iterator>::value or
+                                  std::is_same<T, typename BasicJsonType::const_iterator>::value or
+                                  std::is_same<T, typename BasicJsonType::reverse_iterator>::value or
+                                  std::is_same<T, typename BasicJsonType::const_reverse_iterator>::value or
+                                  std::is_same<T, typename BasicJsonType::json_pointer>::value;
+};
+
+template<class BasicJsonType, class CompatibleArrayType>
+struct is_compatible_array_type
+{
+    static auto constexpr value =
+        conjunction<negation<std::is_same<void, CompatibleArrayType>>,
+        negation<is_compatible_object_type<
+        BasicJsonType, CompatibleArrayType>>,
+        negation<std::is_constructible<typename BasicJsonType::string_t,
+        CompatibleArrayType>>,
+        negation<is_basic_json_nested_type<BasicJsonType, CompatibleArrayType>>,
+        has_value_type<CompatibleArrayType>,
+        has_iterator<CompatibleArrayType>>::value;
+};
+
+template<bool, typename, typename>
+struct is_compatible_integer_type_impl : std::false_type {};
+
+template<typename RealIntegerType, typename CompatibleNumberIntegerType>
+struct is_compatible_integer_type_impl<true, RealIntegerType, CompatibleNumberIntegerType>
+{
+    // is there an assert somewhere on overflows?
+    using RealLimits = std::numeric_limits<RealIntegerType>;
+    using CompatibleLimits = std::numeric_limits<CompatibleNumberIntegerType>;
+
+    static constexpr auto value =
+        std::is_constructible<RealIntegerType,
+        CompatibleNumberIntegerType>::value and
+        CompatibleLimits::is_integer and
+        RealLimits::is_signed == CompatibleLimits::is_signed;
+};
+
+template<typename RealIntegerType, typename CompatibleNumberIntegerType>
+struct is_compatible_integer_type
+{
+    static constexpr auto value =
+        is_compatible_integer_type_impl <
+        std::is_integral<CompatibleNumberIntegerType>::value and
+        not std::is_same<bool, CompatibleNumberIntegerType>::value,
+        RealIntegerType, CompatibleNumberIntegerType > ::value;
+};
+
+
+// trait checking if JSONSerializer<T>::from_json(json const&, udt&) exists
+template<typename BasicJsonType, typename T>
+struct has_from_json
+{
+  private:
+    // also check the return type of from_json
+    template<typename U, typename = enable_if_t<std::is_same<void, decltype(uncvref_t<U>::from_json(
+                 std::declval<BasicJsonType>(), std::declval<T&>()))>::value>>
+    static int detect(U&&);
+    static void detect(...);
+
+  public:
+    static constexpr bool value = std::is_integral<decltype(
+                                      detect(std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
+};
+
+// This trait checks if JSONSerializer<T>::from_json(json const&) exists
+// this overload is used for non-default-constructible user-defined-types
+template<typename BasicJsonType, typename T>
+struct has_non_default_from_json
+{
+  private:
+    template <
+        typename U,
+        typename = enable_if_t<std::is_same<
+                                   T, decltype(uncvref_t<U>::from_json(std::declval<BasicJsonType>()))>::value >>
+    static int detect(U&&);
+    static void detect(...);
+
+  public:
+    static constexpr bool value = std::is_integral<decltype(detect(
+                                      std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
+};
+
+// This trait checks if BasicJsonType::json_serializer<T>::to_json exists
+template<typename BasicJsonType, typename T>
+struct has_to_json
+{
+  private:
+    template<typename U, typename = decltype(uncvref_t<U>::to_json(
+                 std::declval<BasicJsonType&>(), std::declval<T>()))>
+    static int detect(U&&);
+    static void detect(...);
+
+  public:
+    static constexpr bool value = std::is_integral<decltype(detect(
+                                      std::declval<typename BasicJsonType::template json_serializer<T, void>>()))>::value;
+};
+
+
+/////////////
+// to_json //
+/////////////
+
+template<typename BasicJsonType, typename T, enable_if_t<
+             std::is_same<T, typename BasicJsonType::boolean_t>::value, int> = 0>
+void to_json(BasicJsonType& j, T b) noexcept
+{
+    external_constructor<value_t::boolean>::construct(j, b);
+}
+
+template<typename BasicJsonType, typename CompatibleString,
+         enable_if_t<std::is_constructible<typename BasicJsonType::string_t,
+                     CompatibleString>::value, int> = 0>
+void to_json(BasicJsonType& j, const CompatibleString& s)
+{
+    external_constructor<value_t::string>::construct(j, s);
+}
+
+template<typename BasicJsonType, typename FloatType,
+         enable_if_t<std::is_floating_point<FloatType>::value, int> = 0>
+void to_json(BasicJsonType& j, FloatType val) noexcept
+{
+    external_constructor<value_t::number_float>::construct(j, static_cast<typename BasicJsonType::number_float_t>(val));
+}
+
+template <
+    typename BasicJsonType, typename CompatibleNumberUnsignedType,
+    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_unsigned_t,
+                CompatibleNumberUnsignedType>::value, int> = 0 >
+void to_json(BasicJsonType& j, CompatibleNumberUnsignedType val) noexcept
+{
+    external_constructor<value_t::number_unsigned>::construct(j, static_cast<typename BasicJsonType::number_unsigned_t>(val));
+}
+
+template <
+    typename BasicJsonType, typename CompatibleNumberIntegerType,
+    enable_if_t<is_compatible_integer_type<typename BasicJsonType::number_integer_t,
+                CompatibleNumberIntegerType>::value, int> = 0 >
+void to_json(BasicJsonType& j, CompatibleNumberIntegerType val) noexcept
+{
+    external_constructor<value_t::number_integer>::construct(j, static_cast<typename BasicJsonType::number_integer_t>(val));
+}
+
+template<typename BasicJsonType, typename EnumType,
+         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
+void to_json(BasicJsonType& j, EnumType e) noexcept
+{
+    using underlying_type = typename std::underlying_type<EnumType>::type;
+    external_constructor<value_t::number_integer>::construct(j, static_cast<underlying_type>(e));
+}
+
+template<typename BasicJsonType>
+void to_json(BasicJsonType& j, const std::vector<bool>& e)
+{
+    external_constructor<value_t::array>::construct(j, e);
+}
+
+template <
+    typename BasicJsonType, typename CompatibleArrayType,
+    enable_if_t <
+        is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value or
+        std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value,
+        int > = 0 >
+void to_json(BasicJsonType& j, const  CompatibleArrayType& arr)
+{
+    external_constructor<value_t::array>::construct(j, arr);
+}
+
+template <
+    typename BasicJsonType, typename CompatibleObjectType,
+    enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value,
+                int> = 0 >
+void to_json(BasicJsonType& j, const  CompatibleObjectType& arr)
+{
+    external_constructor<value_t::object>::construct(j, arr);
+}
+
+template <typename BasicJsonType, typename T, std::size_t N,
+          enable_if_t<not std::is_constructible<
+                          typename BasicJsonType::string_t, T (&)[N]>::value,
+                      int> = 0>
+void to_json(BasicJsonType& j, T (&arr)[N])
+{
+    external_constructor<value_t::array>::construct(j, arr);
+}
+
+///////////////
+// from_json //
+///////////////
+
+// overloads for basic_json template parameters
+template<typename BasicJsonType, typename ArithmeticType,
+         enable_if_t<std::is_arithmetic<ArithmeticType>::value and
+                     not std::is_same<ArithmeticType,
+                                      typename BasicJsonType::boolean_t>::value,
+                     int> = 0>
+void get_arithmetic_value(const BasicJsonType& j, ArithmeticType& val)
+{
+    switch (static_cast<value_t>(j))
+    {
+        case value_t::number_unsigned:
+        {
+            val = static_cast<ArithmeticType>(
+                      *j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
+            break;
+        }
+        case value_t::number_integer:
+        {
+            val = static_cast<ArithmeticType>(
+                      *j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
+            break;
+        }
+        case value_t::number_float:
+        {
+            val = static_cast<ArithmeticType>(
+                      *j.template get_ptr<const typename BasicJsonType::number_float_t*>());
+            break;
+        }
+        default:
+        {
+            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
+        }
+    }
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::boolean_t& b)
+{
+    if (not j.is_boolean())
+    {
+        JSON_THROW(type_error::create(302, "type must be boolean, but is " + j.type_name()));
+    }
+    b = *j.template get_ptr<const typename BasicJsonType::boolean_t*>();
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::string_t& s)
+{
+    if (not j.is_string())
+    {
+        JSON_THROW(type_error::create(302, "type must be string, but is " + j.type_name()));
+    }
+    s = *j.template get_ptr<const typename BasicJsonType::string_t*>();
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::number_float_t& val)
+{
+    get_arithmetic_value(j, val);
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::number_unsigned_t& val)
+{
+    get_arithmetic_value(j, val);
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::number_integer_t& val)
+{
+    get_arithmetic_value(j, val);
+}
+
+template<typename BasicJsonType, typename EnumType,
+         enable_if_t<std::is_enum<EnumType>::value, int> = 0>
+void from_json(const BasicJsonType& j, EnumType& e)
+{
+    typename std::underlying_type<EnumType>::type val;
+    get_arithmetic_value(j, val);
+    e = static_cast<EnumType>(val);
+}
+
+template<typename BasicJsonType>
+void from_json(const BasicJsonType& j, typename BasicJsonType::array_t& arr)
+{
+    if (not j.is_array())
+    {
+        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
+    }
+    arr = *j.template get_ptr<const typename BasicJsonType::array_t*>();
+}
+
+// forward_list doesn't have an insert method
+template<typename BasicJsonType, typename T, typename Allocator,
+         enable_if_t<std::is_convertible<BasicJsonType, T>::value, int> = 0>
+void from_json(const BasicJsonType& j, std::forward_list<T, Allocator>& l)
+{
+    if (not j.is_array())
+    {
+        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
+    }
+
+    for (auto it = j.rbegin(), end = j.rend(); it != end; ++it)
+    {
+        l.push_front(it->template get<T>());
+    }
+}
+
+template<typename BasicJsonType, typename CompatibleArrayType>
+void from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<0>)
+{
+    using std::begin;
+    using std::end;
+
+    std::transform(j.begin(), j.end(),
+                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
+    {
+        // get<BasicJsonType>() returns *this, this won't call a from_json
+        // method when value_type is BasicJsonType
+        return i.template get<typename CompatibleArrayType::value_type>();
+    });
+}
+
+template<typename BasicJsonType, typename CompatibleArrayType>
+auto from_json_array_impl(const BasicJsonType& j, CompatibleArrayType& arr, priority_tag<1>)
+-> decltype(
+    arr.reserve(std::declval<typename CompatibleArrayType::size_type>()),
+    void())
+{
+    using std::begin;
+    using std::end;
+
+    arr.reserve(j.size());
+    std::transform(j.begin(), j.end(),
+                   std::inserter(arr, end(arr)), [](const BasicJsonType & i)
+    {
+        // get<BasicJsonType>() returns *this, this won't call a from_json
+        // method when value_type is BasicJsonType
+        return i.template get<typename CompatibleArrayType::value_type>();
+    });
+}
+
+template<typename BasicJsonType, typename CompatibleArrayType,
+         enable_if_t<is_compatible_array_type<BasicJsonType, CompatibleArrayType>::value and
+                     std::is_convertible<BasicJsonType, typename CompatibleArrayType::value_type>::value and
+                     not std::is_same<typename BasicJsonType::array_t, CompatibleArrayType>::value, int> = 0>
+void from_json(const BasicJsonType& j, CompatibleArrayType& arr)
+{
+    if (not j.is_array())
+    {
+        JSON_THROW(type_error::create(302, "type must be array, but is " + j.type_name()));
+    }
+
+    from_json_array_impl(j, arr, priority_tag<1> {});
+}
+
+template<typename BasicJsonType, typename CompatibleObjectType,
+         enable_if_t<is_compatible_object_type<BasicJsonType, CompatibleObjectType>::value, int> = 0>
+void from_json(const BasicJsonType& j, CompatibleObjectType& obj)
+{
+    if (not j.is_object())
+    {
+        JSON_THROW(type_error::create(302, "type must be object, but is " + j.type_name()));
+    }
+
+    auto inner_object = j.template get_ptr<const typename BasicJsonType::object_t*>();
+    using std::begin;
+    using std::end;
+    // we could avoid the assignment, but this might require a for loop, which
+    // might be less efficient than the container constructor for some
+    // containers (would it?)
+    obj = CompatibleObjectType(begin(*inner_object), end(*inner_object));
+}
+
+// overload for arithmetic types, not chosen for basic_json template arguments
+// (BooleanType, etc..); note: Is it really necessary to provide explicit
+// overloads for boolean_t etc. in case of a custom BooleanType which is not
+// an arithmetic type?
+template<typename BasicJsonType, typename ArithmeticType,
+         enable_if_t <
+             std::is_arithmetic<ArithmeticType>::value and
+             not std::is_same<ArithmeticType, typename BasicJsonType::number_unsigned_t>::value and
+             not std::is_same<ArithmeticType, typename BasicJsonType::number_integer_t>::value and
+             not std::is_same<ArithmeticType, typename BasicJsonType::number_float_t>::value and
+             not std::is_same<ArithmeticType, typename BasicJsonType::boolean_t>::value,
+             int> = 0>
+void from_json(const BasicJsonType& j, ArithmeticType& val)
+{
+    switch (static_cast<value_t>(j))
+    {
+        case value_t::number_unsigned:
+        {
+            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_unsigned_t*>());
+            break;
+        }
+        case value_t::number_integer:
+        {
+            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_integer_t*>());
+            break;
+        }
+        case value_t::number_float:
+        {
+            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::number_float_t*>());
+            break;
+        }
+        case value_t::boolean:
+        {
+            val = static_cast<ArithmeticType>(*j.template get_ptr<const typename BasicJsonType::boolean_t*>());
+            break;
+        }
+        default:
+        {
+            JSON_THROW(type_error::create(302, "type must be number, but is " + j.type_name()));
+        }
+    }
+}
+
+struct to_json_fn
+{
+  private:
+    template<typename BasicJsonType, typename T>
+    auto call(BasicJsonType& j, T&& val, priority_tag<1>) const noexcept(noexcept(to_json(j, std::forward<T>(val))))
+    -> decltype(to_json(j, std::forward<T>(val)), void())
+    {
+        return to_json(j, std::forward<T>(val));
+    }
+
+    template<typename BasicJsonType, typename T>
+    void call(BasicJsonType&, T&&, priority_tag<0>) const noexcept
+    {
+        static_assert(sizeof(BasicJsonType) == 0,
+                      "could not find to_json() method in T's namespace");
+    }
+
+  public:
+    template<typename BasicJsonType, typename T>
+    void operator()(BasicJsonType& j, T&& val) const
+    noexcept(noexcept(std::declval<to_json_fn>().call(j, std::forward<T>(val), priority_tag<1> {})))
+    {
+        return call(j, std::forward<T>(val), priority_tag<1> {});
+    }
+};
+
+struct from_json_fn
+{
+  private:
+    template<typename BasicJsonType, typename T>
+    auto call(const BasicJsonType& j, T& val, priority_tag<1>) const
+    noexcept(noexcept(from_json(j, val)))
+    -> decltype(from_json(j, val), void())
+    {
+        return from_json(j, val);
+    }
+
+    template<typename BasicJsonType, typename T>
+    void call(const BasicJsonType&, T&, priority_tag<0>) const noexcept
+    {
+        static_assert(sizeof(BasicJsonType) == 0,
+                      "could not find from_json() method in T's namespace");
+    }
+
+  public:
+    template<typename BasicJsonType, typename T>
+    void operator()(const BasicJsonType& j, T& val) const
+    noexcept(noexcept(std::declval<from_json_fn>().call(j, val, priority_tag<1> {})))
+    {
+        return call(j, val, priority_tag<1> {});
+    }
+};
+
+// taken from ranges-v3
+template<typename T>
+struct static_const
+{
+    static constexpr T value{};
+};
+
+template<typename T>
+constexpr T static_const<T>::value;
+} // namespace detail
+
+
+/// namespace to hold default `to_json` / `from_json` functions
+namespace
+{
+constexpr const auto& to_json = detail::static_const<detail::to_json_fn>::value;
+constexpr const auto& from_json = detail::static_const<detail::from_json_fn>::value;
+}
+
+
+/*!
+@brief default JSONSerializer template argument
+
+This serializer ignores the template arguments and uses ADL
+([argument-dependent lookup](http://en.cppreference.com/w/cpp/language/adl))
+for serialization.
+*/
+template<typename = void, typename = void>
+struct adl_serializer
+{
+    /*!
+    @brief convert a JSON value to any value type
+
+    This function is usually called by the `get()` function of the
+    @ref basic_json class (either explicit or via conversion operators).
+
+    @param[in] j         JSON value to read from
+    @param[in,out] val  value to write to
+    */
+    template<typename BasicJsonType, typename ValueType>
+    static void from_json(BasicJsonType&& j, ValueType& val) noexcept(
+        noexcept(::nlohmann::from_json(std::forward<BasicJsonType>(j), val)))
+    {
+        ::nlohmann::from_json(std::forward<BasicJsonType>(j), val);
+    }
+
+    /*!
+    @brief convert any value type to a JSON value
+
+    This function is usually called by the constructors of the @ref basic_json
+    class.
+
+    @param[in,out] j  JSON value to write to
+    @param[in] val     value to read from
+    */
+    template<typename BasicJsonType, typename ValueType>
+    static void to_json(BasicJsonType& j, ValueType&& val) noexcept(
+        noexcept(::nlohmann::to_json(j, std::forward<ValueType>(val))))
+    {
+        ::nlohmann::to_json(j, std::forward<ValueType>(val));
+    }
+};
+
+
+/*!
+@brief a class to store JSON values
+
+@tparam ObjectType type for JSON objects (`std::map` by default; will be used
+in @ref object_t)
+@tparam ArrayType type for JSON arrays (`std::vector` by default; will be used
+in @ref array_t)
+@tparam StringType type for JSON strings and object keys (`std::string` by
+default; will be used in @ref string_t)
+@tparam BooleanType type for JSON booleans (`bool` by default; will be used
+in @ref boolean_t)
+@tparam NumberIntegerType type for JSON integer numbers (`int64_t` by
+default; will be used in @ref number_integer_t)
+@tparam NumberUnsignedType type for JSON unsigned integer numbers (@c
+`uint64_t` by default; will be used in @ref number_unsigned_t)
+@tparam NumberFloatType type for JSON floating-point numbers (`double` by
+default; will be used in @ref number_float_t)
+@tparam AllocatorType type of the allocator to use (`std::allocator` by
+default)
+@tparam JSONSerializer the serializer to resolve internal calls to `to_json()`
+and `from_json()` (@ref adl_serializer by default)
+
+@requirement The class satisfies the following concept requirements:
+- Basic
+ - [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible):
+   JSON values can be default constructed. The result will be a JSON null
+   value.
+ - [MoveConstructible](http://en.cppreference.com/w/cpp/concept/MoveConstructible):
+   A JSON value can be constructed from an rvalue argument.
+ - [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible):
+   A JSON value can be copy-constructed from an lvalue expression.
+ - [MoveAssignable](http://en.cppreference.com/w/cpp/concept/MoveAssignable):
+   A JSON value van be assigned from an rvalue argument.
+ - [CopyAssignable](http://en.cppreference.com/w/cpp/concept/CopyAssignable):
+   A JSON value can be copy-assigned from an lvalue expression.
+ - [Destructible](http://en.cppreference.com/w/cpp/concept/Destructible):
+   JSON values can be destructed.
+- Layout
+ - [StandardLayoutType](http://en.cppreference.com/w/cpp/concept/StandardLayoutType):
+   JSON values have
+   [standard layout](http://en.cppreference.com/w/cpp/language/data_members#Standard_layout):
+   All non-static data members are private and standard layout types, the
+   class has no virtual functions or (virtual) base classes.
+- Library-wide
+ - [EqualityComparable](http://en.cppreference.com/w/cpp/concept/EqualityComparable):
+   JSON values can be compared with `==`, see @ref
+   operator==(const_reference,const_reference).
+ - [LessThanComparable](http://en.cppreference.com/w/cpp/concept/LessThanComparable):
+   JSON values can be compared with `<`, see @ref
+   operator<(const_reference,const_reference).
+ - [Swappable](http://en.cppreference.com/w/cpp/concept/Swappable):
+   Any JSON lvalue or rvalue of can be swapped with any lvalue or rvalue of
+   other compatible types, using unqualified function call @ref swap().
+ - [NullablePointer](http://en.cppreference.com/w/cpp/concept/NullablePointer):
+   JSON values can be compared against `std::nullptr_t` objects which are used
+   to model the `null` value.
+- Container
+ - [Container](http://en.cppreference.com/w/cpp/concept/Container):
+   JSON values can be used like STL containers and provide iterator access.
+ - [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer);
+   JSON values can be used like STL containers and provide reverse iterator
+   access.
+
+@invariant The member variables @a m_value and @a m_type have the following
+relationship:
+- If `m_type == value_t::object`, then `m_value.object != nullptr`.
+- If `m_type == value_t::array`, then `m_value.array != nullptr`.
+- If `m_type == value_t::string`, then `m_value.string != nullptr`.
+The invariants are checked by member function assert_invariant().
+
+@internal
+@note ObjectType trick from http://stackoverflow.com/a/9860911
+@endinternal
+
+@see [RFC 7159: The JavaScript Object Notation (JSON) Data Interchange
+Format](http://rfc7159.net/rfc7159)
+
+@since version 1.0.0
+
+@nosubgrouping
+*/
+template <
+    template<typename U, typename V, typename... Args> class ObjectType = std::map,
+    template<typename U, typename... Args> class ArrayType = std::vector,
+    class StringType = std::string,
+    class BooleanType = bool,
+    class NumberIntegerType = std::int64_t,
+    class NumberUnsignedType = std::uint64_t,
+    class NumberFloatType = double,
+    template<typename U> class AllocatorType = std::allocator,
+    template<typename T, typename SFINAE = void> class JSONSerializer = adl_serializer
+    >
+class basic_json
+{
+  private:
+    template<detail::value_t> friend struct detail::external_constructor;
+    /// workaround type for MSVC
+    using basic_json_t = basic_json<ObjectType, ArrayType, StringType,
+          BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType,
+          AllocatorType, JSONSerializer>;
+
+  public:
+    using value_t = detail::value_t;
+    // forward declarations
+    template<typename U> class iter_impl;
+    template<typename Base> class json_reverse_iterator;
+    class json_pointer;
+    template<typename T, typename SFINAE>
+    using json_serializer = JSONSerializer<T, SFINAE>;
+
+
+    ////////////////
+    // exceptions //
+    ////////////////
+
+    /// @name exceptions
+    /// Classes to implement user-defined exceptions.
+    /// @{
+
+    /// @copydoc detail::exception
+    using exception = detail::exception;
+    /// @copydoc detail::parse_error
+    using parse_error = detail::parse_error;
+    /// @copydoc detail::invalid_iterator
+    using invalid_iterator = detail::invalid_iterator;
+    /// @copydoc detail::type_error
+    using type_error = detail::type_error;
+    /// @copydoc detail::out_of_range
+    using out_of_range = detail::out_of_range;
+    /// @copydoc detail::other_error
+    using other_error = detail::other_error;
+
+    /// @}
+
+
+    /////////////////////
+    // container types //
+    /////////////////////
+
+    /// @name container types
+    /// The canonic container types to use @ref basic_json like any other STL
+    /// container.
+    /// @{
+
+    /// the type of elements in a basic_json container
+    using value_type = basic_json;
+
+    /// the type of an element reference
+    using reference = value_type&;
+    /// the type of an element const reference
+    using const_reference = const value_type&;
+
+    /// a type to represent differences between iterators
+    using difference_type = std::ptrdiff_t;
+    /// a type to represent container sizes
+    using size_type = std::size_t;
+
+    /// the allocator type
+    using allocator_type = AllocatorType<basic_json>;
+
+    /// the type of an element pointer
+    using pointer = typename std::allocator_traits<allocator_type>::pointer;
+    /// the type of an element const pointer
+    using const_pointer = typename std::allocator_traits<allocator_type>::const_pointer;
+
+    /// an iterator for a basic_json container
+    using iterator = iter_impl<basic_json>;
+    /// a const iterator for a basic_json container
+    using const_iterator = iter_impl<const basic_json>;
+    /// a reverse iterator for a basic_json container
+    using reverse_iterator = json_reverse_iterator<typename basic_json::iterator>;
+    /// a const reverse iterator for a basic_json container
+    using const_reverse_iterator = json_reverse_iterator<typename basic_json::const_iterator>;
+
+    /// @}
+
+
+    /*!
+    @brief returns the allocator associated with the container
+    */
+    static allocator_type get_allocator()
+    {
+        return allocator_type();
+    }
+
+    /*!
+    @brief returns version information on the library
+
+    This function returns a JSON object with information about the library,
+    including the version number and information on the platform and compiler.
+
+    @return JSON object holding version information
+    key         | description
+    ----------- | ---------------
+    `compiler`  | Information on the used compiler. It is an object with the following keys: `c++` (the used C++ standard), `family` (the compiler family; possible values are `clang`, `icc`, `gcc`, `ilecpp`, `msvc`, `pgcpp`, `sunpro`, and `unknown`), and `version` (the compiler version).
+    `copyright` | The copyright line for the library as string.
+    `name`      | The name of the library as string.
+    `platform`  | The used platform as string. Possible values are `win32`, `linux`, `apple`, `unix`, and `unknown`.
+    `url`       | The URL of the project as string.
+    `version`   | The version of the library. It is an object with the following keys: `major`, `minor`, and `patch` as defined by [Semantic Versioning](http://semver.org), and `string` (the version string).
+
+    @liveexample{The following code shows an example output of the `meta()`
+    function.,meta}
+
+    @complexity Constant.
+
+    @since 2.1.0
+    */
+    static basic_json meta()
+    {
+        basic_json result;
+
+        result["copyright"] = "(C) 2013-2017 Niels Lohmann";
+        result["name"] = "JSON for Modern C++";
+        result["url"] = "https://github.com/nlohmann/json";
+        result["version"] =
+        {
+            {"string", "2.1.1"}, {"major", 2}, {"minor", 1}, {"patch", 1}
+        };
+
+#ifdef _WIN32
+        result["platform"] = "win32";
+#elif defined __linux__
+        result["platform"] = "linux";
+#elif defined __APPLE__
+        result["platform"] = "apple";
+#elif defined __unix__
+        result["platform"] = "unix";
+#else
+        result["platform"] = "unknown";
+#endif
+
+#if defined(__clang__)
+        result["compiler"] = {{"family", "clang"}, {"version", __clang_version__}};
+#elif defined(__ICC) || defined(__INTEL_COMPILER)
+        result["compiler"] = {{"family", "icc"}, {"version", __INTEL_COMPILER}};
+#elif defined(__GNUC__) || defined(__GNUG__)
+        result["compiler"] = {{"family", "gcc"}, {"version", std::to_string(__GNUC__) + "." + std::to_string(__GNUC_MINOR__) + "." + std::to_string(__GNUC_PATCHLEVEL__)}};
+#elif defined(__HP_cc) || defined(__HP_aCC)
+        result["compiler"] = "hp"
+#elif defined(__IBMCPP__)
+        result["compiler"] = {{"family", "ilecpp"}, {"version", __IBMCPP__}};
+#elif defined(_MSC_VER)
+        result["compiler"] = {{"family", "msvc"}, {"version", _MSC_VER}};
+#elif defined(__PGI)
+        result["compiler"] = {{"family", "pgcpp"}, {"version", __PGI}};
+#elif defined(__SUNPRO_CC)
+        result["compiler"] = {{"family", "sunpro"}, {"version", __SUNPRO_CC}};
+#else
+        result["compiler"] = {{"family", "unknown"}, {"version", "unknown"}};
+#endif
+
+#ifdef __cplusplus
+        result["compiler"]["c++"] = std::to_string(__cplusplus);
+#else
+        result["compiler"]["c++"] = "unknown";
+#endif
+        return result;
+    }
+
+
+    ///////////////////////////
+    // JSON value data types //
+    ///////////////////////////
+
+    /// @name JSON value data types
+    /// The data types to store a JSON value. These types are derived from
+    /// the template arguments passed to class @ref basic_json.
+    /// @{
+
+    /*!
+    @brief a type for an object
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON objects as follows:
+    > An object is an unordered collection of zero or more name/value pairs,
+    > where a name is a string and a value is a string, number, boolean, null,
+    > object, or array.
+
+    To store objects in C++, a type is defined by the template parameters
+    described below.
+
+    @tparam ObjectType  the container to store objects (e.g., `std::map` or
+    `std::unordered_map`)
+    @tparam StringType the type of the keys or names (e.g., `std::string`).
+    The comparison function `std::less<StringType>` is used to order elements
+    inside the container.
+    @tparam AllocatorType the allocator to use for objects (e.g.,
+    `std::allocator`)
+
+    #### Default type
+
+    With the default values for @a ObjectType (`std::map`), @a StringType
+    (`std::string`), and @a AllocatorType (`std::allocator`), the default
+    value for @a object_t is:
+
+    @code {.cpp}
+    std::map<
+      std::string, // key_type
+      basic_json, // value_type
+      std::less<std::string>, // key_compare
+      std::allocator<std::pair<const std::string, basic_json>> // allocator_type
+    >
+    @endcode
+
+    #### Behavior
+
+    The choice of @a object_t influences the behavior of the JSON class. With
+    the default type, objects have the following behavior:
+
+    - When all names are unique, objects will be interoperable in the sense
+      that all software implementations receiving that object will agree on
+      the name-value mappings.
+    - When the names within an object are not unique, later stored name/value
+      pairs overwrite previously stored name/value pairs, leaving the used
+      names unique. For instance, `{"key": 1}` and `{"key": 2, "key": 1}` will
+      be treated as equal and both stored as `{"key": 1}`.
+    - Internally, name/value pairs are stored in lexicographical order of the
+      names. Objects will also be serialized (see @ref dump) in this order.
+      For instance, `{"b": 1, "a": 2}` and `{"a": 2, "b": 1}` will be stored
+      and serialized as `{"a": 2, "b": 1}`.
+    - When comparing objects, the order of the name/value pairs is irrelevant.
+      This makes objects interoperable in the sense that they will not be
+      affected by these differences. For instance, `{"b": 1, "a": 2}` and
+      `{"a": 2, "b": 1}` will be treated as equal.
+
+    #### Limits
+
+    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
+    > An implementation may set limits on the maximum depth of nesting.
+
+    In this class, the object's limit of nesting is not constraint explicitly.
+    However, a maximum depth of nesting may be introduced by the compiler or
+    runtime environment. A theoretical limit can be queried by calling the
+    @ref max_size function of a JSON object.
+
+    #### Storage
+
+    Objects are stored as pointers in a @ref basic_json type. That is, for any
+    access to object values, a pointer of type `object_t*` must be
+    dereferenced.
+
+    @sa @ref array_t -- type for an array value
+
+    @since version 1.0.0
+
+    @note The order name/value pairs are added to the object is *not*
+    preserved by the library. Therefore, iterating an object may return
+    name/value pairs in a different order than they were originally stored. In
+    fact, keys will be traversed in alphabetical order as `std::map` with
+    `std::less` is used by default. Please note this behavior conforms to [RFC
+    7159](http://rfc7159.net/rfc7159), because any order implements the
+    specified "unordered" nature of JSON objects.
+    */
+    using object_t = ObjectType<StringType,
+          basic_json,
+          std::less<StringType>,
+          AllocatorType<std::pair<const StringType,
+          basic_json>>>;
+
+    /*!
+    @brief a type for an array
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON arrays as follows:
+    > An array is an ordered sequence of zero or more values.
+
+    To store objects in C++, a type is defined by the template parameters
+    explained below.
+
+    @tparam ArrayType  container type to store arrays (e.g., `std::vector` or
+    `std::list`)
+    @tparam AllocatorType allocator to use for arrays (e.g., `std::allocator`)
+
+    #### Default type
+
+    With the default values for @a ArrayType (`std::vector`) and @a
+    AllocatorType (`std::allocator`), the default value for @a array_t is:
+
+    @code {.cpp}
+    std::vector<
+      basic_json, // value_type
+      std::allocator<basic_json> // allocator_type
+    >
+    @endcode
+
+    #### Limits
+
+    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
+    > An implementation may set limits on the maximum depth of nesting.
+
+    In this class, the array's limit of nesting is not constraint explicitly.
+    However, a maximum depth of nesting may be introduced by the compiler or
+    runtime environment. A theoretical limit can be queried by calling the
+    @ref max_size function of a JSON array.
+
+    #### Storage
+
+    Arrays are stored as pointers in a @ref basic_json type. That is, for any
+    access to array values, a pointer of type `array_t*` must be dereferenced.
+
+    @sa @ref object_t -- type for an object value
+
+    @since version 1.0.0
+    */
+    using array_t = ArrayType<basic_json, AllocatorType<basic_json>>;
+
+    /*!
+    @brief a type for a string
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes JSON strings as follows:
+    > A string is a sequence of zero or more Unicode characters.
+
+    To store objects in C++, a type is defined by the template parameter
+    described below. Unicode values are split by the JSON class into
+    byte-sized characters during deserialization.
+
+    @tparam StringType  the container to store strings (e.g., `std::string`).
+    Note this container is used for keys/names in objects, see @ref object_t.
+
+    #### Default type
+
+    With the default values for @a StringType (`std::string`), the default
+    value for @a string_t is:
+
+    @code {.cpp}
+    std::string
+    @endcode
+
+    #### Encoding
+
+    Strings are stored in UTF-8 encoding. Therefore, functions like
+    `std::string::size()` or `std::string::length()` return the number of
+    bytes in the string rather than the number of characters or glyphs.
+
+    #### String comparison
+
+    [RFC 7159](http://rfc7159.net/rfc7159) states:
+    > Software implementations are typically required to test names of object
+    > members for equality. Implementations that transform the textual
+    > representation into sequences of Unicode code units and then perform the
+    > comparison numerically, code unit by code unit, are interoperable in the
+    > sense that implementations will agree in all cases on equality or
+    > inequality of two strings. For example, implementations that compare
+    > strings with escaped characters unconverted may incorrectly find that
+    > `"a\\b"` and `"a\u005Cb"` are not equal.
+
+    This implementation is interoperable as it does compare strings code unit
+    by code unit.
+
+    #### Storage
+
+    String values are stored as pointers in a @ref basic_json type. That is,
+    for any access to string values, a pointer of type `string_t*` must be
+    dereferenced.
+
+    @since version 1.0.0
+    */
+    using string_t = StringType;
+
+    /*!
+    @brief a type for a boolean
+
+    [RFC 7159](http://rfc7159.net/rfc7159) implicitly describes a boolean as a
+    type which differentiates the two literals `true` and `false`.
+
+    To store objects in C++, a type is defined by the template parameter @a
+    BooleanType which chooses the type to use.
+
+    #### Default type
+
+    With the default values for @a BooleanType (`bool`), the default value for
+    @a boolean_t is:
+
+    @code {.cpp}
+    bool
+    @endcode
+
+    #### Storage
+
+    Boolean values are stored directly inside a @ref basic_json type.
+
+    @since version 1.0.0
+    */
+    using boolean_t = BooleanType;
+
+    /*!
+    @brief a type for a number (integer)
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
+    > The representation of numbers is similar to that used in most
+    > programming languages. A number is represented in base 10 using decimal
+    > digits. It contains an integer component that may be prefixed with an
+    > optional minus sign, which may be followed by a fraction part and/or an
+    > exponent part. Leading zeros are not allowed. (...) Numeric values that
+    > cannot be represented in the grammar below (such as Infinity and NaN)
+    > are not permitted.
+
+    This description includes both integer and floating-point numbers.
+    However, C++ allows more precise storage if it is known whether the number
+    is a signed integer, an unsigned integer or a floating-point number.
+    Therefore, three different types, @ref number_integer_t, @ref
+    number_unsigned_t and @ref number_float_t are used.
+
+    To store integer numbers in C++, a type is defined by the template
+    parameter @a NumberIntegerType which chooses the type to use.
+
+    #### Default type
+
+    With the default values for @a NumberIntegerType (`int64_t`), the default
+    value for @a number_integer_t is:
+
+    @code {.cpp}
+    int64_t
+    @endcode
+
+    #### Default behavior
+
+    - The restrictions about leading zeros is not enforced in C++. Instead,
+      leading zeros in integer literals lead to an interpretation as octal
+      number. Internally, the value will be stored as decimal number. For
+      instance, the C++ integer literal `010` will be serialized to `8`.
+      During deserialization, leading zeros yield an error.
+    - Not-a-number (NaN) values will be serialized to `null`.
+
+    #### Limits
+
+    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
+    > An implementation may set limits on the range and precision of numbers.
+
+    When the default type is used, the maximal integer number that can be
+    stored is `9223372036854775807` (INT64_MAX) and the minimal integer number
+    that can be stored is `-9223372036854775808` (INT64_MIN). Integer numbers
+    that are out of range will yield over/underflow when used in a
+    constructor. During deserialization, too large or small integer numbers
+    will be automatically be stored as @ref number_unsigned_t or @ref
+    number_float_t.
+
+    [RFC 7159](http://rfc7159.net/rfc7159) further states:
+    > Note that when such software is used, numbers that are integers and are
+    > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
+    > that implementations will agree exactly on their numeric values.
+
+    As this range is a subrange of the exactly supported range [INT64_MIN,
+    INT64_MAX], this class's integer type is interoperable.
+
+    #### Storage
+
+    Integer number values are stored directly inside a @ref basic_json type.
+
+    @sa @ref number_float_t -- type for number values (floating-point)
+
+    @sa @ref number_unsigned_t -- type for number values (unsigned integer)
+
+    @since version 1.0.0
+    */
+    using number_integer_t = NumberIntegerType;
+
+    /*!
+    @brief a type for a number (unsigned)
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
+    > The representation of numbers is similar to that used in most
+    > programming languages. A number is represented in base 10 using decimal
+    > digits. It contains an integer component that may be prefixed with an
+    > optional minus sign, which may be followed by a fraction part and/or an
+    > exponent part. Leading zeros are not allowed. (...) Numeric values that
+    > cannot be represented in the grammar below (such as Infinity and NaN)
+    > are not permitted.
+
+    This description includes both integer and floating-point numbers.
+    However, C++ allows more precise storage if it is known whether the number
+    is a signed integer, an unsigned integer or a floating-point number.
+    Therefore, three different types, @ref number_integer_t, @ref
+    number_unsigned_t and @ref number_float_t are used.
+
+    To store unsigned integer numbers in C++, a type is defined by the
+    template parameter @a NumberUnsignedType which chooses the type to use.
+
+    #### Default type
+
+    With the default values for @a NumberUnsignedType (`uint64_t`), the
+    default value for @a number_unsigned_t is:
+
+    @code {.cpp}
+    uint64_t
+    @endcode
+
+    #### Default behavior
+
+    - The restrictions about leading zeros is not enforced in C++. Instead,
+      leading zeros in integer literals lead to an interpretation as octal
+      number. Internally, the value will be stored as decimal number. For
+      instance, the C++ integer literal `010` will be serialized to `8`.
+      During deserialization, leading zeros yield an error.
+    - Not-a-number (NaN) values will be serialized to `null`.
+
+    #### Limits
+
+    [RFC 7159](http://rfc7159.net/rfc7159) specifies:
+    > An implementation may set limits on the range and precision of numbers.
+
+    When the default type is used, the maximal integer number that can be
+    stored is `18446744073709551615` (UINT64_MAX) and the minimal integer
+    number that can be stored is `0`. Integer numbers that are out of range
+    will yield over/underflow when used in a constructor. During
+    deserialization, too large or small integer numbers will be automatically
+    be stored as @ref number_integer_t or @ref number_float_t.
+
+    [RFC 7159](http://rfc7159.net/rfc7159) further states:
+    > Note that when such software is used, numbers that are integers and are
+    > in the range \f$[-2^{53}+1, 2^{53}-1]\f$ are interoperable in the sense
+    > that implementations will agree exactly on their numeric values.
+
+    As this range is a subrange (when considered in conjunction with the
+    number_integer_t type) of the exactly supported range [0, UINT64_MAX],
+    this class's integer type is interoperable.
+
+    #### Storage
+
+    Integer number values are stored directly inside a @ref basic_json type.
+
+    @sa @ref number_float_t -- type for number values (floating-point)
+    @sa @ref number_integer_t -- type for number values (integer)
+
+    @since version 2.0.0
+    */
+    using number_unsigned_t = NumberUnsignedType;
+
+    /*!
+    @brief a type for a number (floating-point)
+
+    [RFC 7159](http://rfc7159.net/rfc7159) describes numbers as follows:
+    > The representation of numbers is similar to that used in most
+    > programming languages. A number is represented in base 10 using decimal
+    > digits. It contains an integer component that may be prefixed with an
+    > optional minus sign, which may be followed by a fraction part and/or an
+    > exponent part. Leading zeros are not allowed. (...) Numeric values that
+    > cannot be represented in the grammar below (such as Infinity and NaN)
+    > are not permitted.
+
+    This description includes both integer and floating-point numbers.
+    However, C++ allows more precise storage if it is known whether the number
+    is a signed integer, an unsigned integer or a floating-point number.
+    Therefore, three different types, @ref number_integer_t, @ref
+    number_unsigned_t and @ref number_float_t are used.
+
+    To store floating-point numbers in C++, a type is defined by the template
+    parameter @a NumberFloatType which chooses the type to use.
+
+    #### Default type
+
+    With the default values for @a NumberFloatType (`double`), the default
+    value for @a number_float_t is:
+
+    @code {.cpp}
+    double
+    @endcode
+
+    #### Default behavior
+
+    - The restrictions about leading zeros is not enforced in C++. Instead,
+      leading zeros in floating-point literals will be ignored. Internally,
+      the value will be stored as decimal number. For instance, the C++
+      floating-point literal `01.2` will be serialized to `1.2`. During
+      deserialization, leading zeros yield an error.
+    - Not-a-number (NaN) values will be serialized to `null`.
+
+    #### Limits
+
+    [RFC 7159](http://rfc7159.net/rfc7159) states:
+    > This specification allows implementations to set limits on the range and
+    > precision of numbers accepted. Since software that implements IEEE
+    > 754-2008 binary64 (double precision) numbers is generally available and
+    > widely used, good interoperability can be achieved by implementations
+    > that expect no more precision or range than these provide, in the sense
+    > that implementations will approximate JSON numbers within the expected
+    > precision.
+
+    This implementation does exactly follow this approach, as it uses double
+    precision floating-point numbers. Note values smaller than
+    `-1.79769313486232e+308` and values greater than `1.79769313486232e+308`
+    will be stored as NaN internally and be serialized to `null`.
+
+    #### Storage
+
+    Floating-point number values are stored directly inside a @ref basic_json
+    type.
+
+    @sa @ref number_integer_t -- type for number values (integer)
+
+    @sa @ref number_unsigned_t -- type for number values (unsigned integer)
+
+    @since version 1.0.0
+    */
+    using number_float_t = NumberFloatType;
+
+    /// @}
+
+  private:
+
+    /// helper for exception-safe object creation
+    template<typename T, typename... Args>
+    static T* create(Args&& ... args)
+    {
+        AllocatorType<T> alloc;
+        auto deleter = [&](T * object)
+        {
+            alloc.deallocate(object, 1);
+        };
+        std::unique_ptr<T, decltype(deleter)> object(alloc.allocate(1), deleter);
+        alloc.construct(object.get(), std::forward<Args>(args)...);
+        assert(object != nullptr);
+        return object.release();
+    }
+
+    ////////////////////////
+    // JSON value storage //
+    ////////////////////////
+
+    /*!
+    @brief a JSON value
+
+    The actual storage for a JSON value of the @ref basic_json class. This
+    union combines the different storage types for the JSON value types
+    defined in @ref value_t.
+
+    JSON type | value_t type    | used type
+    --------- | --------------- | ------------------------
+    object    | object          | pointer to @ref object_t
+    array     | array           | pointer to @ref array_t
+    string    | string          | pointer to @ref string_t
+    boolean   | boolean         | @ref boolean_t
+    number    | number_integer  | @ref number_integer_t
+    number    | number_unsigned | @ref number_unsigned_t
+    number    | number_float    | @ref number_float_t
+    null      | null            | *no value is stored*
+
+    @note Variable-length types (objects, arrays, and strings) are stored as
+    pointers. The size of the union should not exceed 64 bits if the default
+    value types are used.
+
+    @since version 1.0.0
+    */
+    union json_value
+    {
+        /// object (stored with pointer to save storage)
+        object_t* object;
+        /// array (stored with pointer to save storage)
+        array_t* array;
+        /// string (stored with pointer to save storage)
+        string_t* string;
+        /// boolean
+        boolean_t boolean;
+        /// number (integer)
+        number_integer_t number_integer;
+        /// number (unsigned integer)
+        number_unsigned_t number_unsigned;
+        /// number (floating-point)
+        number_float_t number_float;
+
+        /// default constructor (for null values)
+        json_value() = default;
+        /// constructor for booleans
+        json_value(boolean_t v) noexcept : boolean(v) {}
+        /// constructor for numbers (integer)
+        json_value(number_integer_t v) noexcept : number_integer(v) {}
+        /// constructor for numbers (unsigned)
+        json_value(number_unsigned_t v) noexcept : number_unsigned(v) {}
+        /// constructor for numbers (floating-point)
+        json_value(number_float_t v) noexcept : number_float(v) {}
+        /// constructor for empty values of a given type
+        json_value(value_t t)
+        {
+            switch (t)
+            {
+                case value_t::object:
+                {
+                    object = create<object_t>();
+                    break;
+                }
+
+                case value_t::array:
+                {
+                    array = create<array_t>();
+                    break;
+                }
+
+                case value_t::string:
+                {
+                    string = create<string_t>("");
+                    break;
+                }
+
+                case value_t::boolean:
+                {
+                    boolean = boolean_t(false);
+                    break;
+                }
+
+                case value_t::number_integer:
+                {
+                    number_integer = number_integer_t(0);
+                    break;
+                }
+
+                case value_t::number_unsigned:
+                {
+                    number_unsigned = number_unsigned_t(0);
+                    break;
+                }
+
+                case value_t::number_float:
+                {
+                    number_float = number_float_t(0.0);
+                    break;
+                }
+
+                case value_t::null:
+                {
+                    break;
+                }
+
+                default:
+                {
+                    if (t == value_t::null)
+                    {
+                        JSON_THROW(other_error::create(500, "961c151d2e87f2686a955a9be24d316f1362bf21 2.1.1")); // LCOV_EXCL_LINE
+                    }
+                    break;
+                }
+            }
+        }
+
+        /// constructor for strings
+        json_value(const string_t& value)
+        {
+            string = create<string_t>(value);
+        }
+
+        /// constructor for objects
+        json_value(const object_t& value)
+        {
+            object = create<object_t>(value);
+        }
+
+        /// constructor for arrays
+        json_value(const array_t& value)
+        {
+            array = create<array_t>(value);
+        }
+    };
+
+    /*!
+    @brief checks the class invariants
+
+    This function asserts the class invariants. It needs to be called at the
+    end of every constructor to make sure that created objects respect the
+    invariant. Furthermore, it has to be called each time the type of a JSON
+    value is changed, because the invariant expresses a relationship between
+    @a m_type and @a m_value.
+    */
+    void assert_invariant() const
+    {
+        assert(m_type != value_t::object or m_value.object != nullptr);
+        assert(m_type != value_t::array or m_value.array != nullptr);
+        assert(m_type != value_t::string or m_value.string != nullptr);
+    }
+
+  public:
+    //////////////////////////
+    // JSON parser callback //
+    //////////////////////////
+
+    /*!
+    @brief JSON callback events
+
+    This enumeration lists the parser events that can trigger calling a
+    callback function of type @ref parser_callback_t during parsing.
+
+    @image html callback_events.png "Example when certain parse events are triggered"
+
+    @since version 1.0.0
+    */
+    enum class parse_event_t : uint8_t
+    {
+        /// the parser read `{` and started to process a JSON object
+        object_start,
+        /// the parser read `}` and finished processing a JSON object
+        object_end,
+        /// the parser read `[` and started to process a JSON array
+        array_start,
+        /// the parser read `]` and finished processing a JSON array
+        array_end,
+        /// the parser read a key of a value in an object
+        key,
+        /// the parser finished reading a JSON value
+        value
+    };
+
+    /*!
+    @brief per-element parser callback type
+
+    With a parser callback function, the result of parsing a JSON text can be
+    influenced. When passed to @ref parse(std::istream&, const
+    parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
+    it is called on certain events (passed as @ref parse_event_t via parameter
+    @a event) with a set recursion depth @a depth and context JSON value
+    @a parsed. The return value of the callback function is a boolean
+    indicating whether the element that emitted the callback shall be kept or
+    not.
+
+    We distinguish six scenarios (determined by the event type) in which the
+    callback function can be called. The following table describes the values
+    of the parameters @a depth, @a event, and @a parsed.
+
+    parameter @a event | description | parameter @a depth | parameter @a parsed
+    ------------------ | ----------- | ------------------ | -------------------
+    parse_event_t::object_start | the parser read `{` and started to process a JSON object | depth of the parent of the JSON object | a JSON value with type discarded
+    parse_event_t::key | the parser read a key of a value in an object | depth of the currently parsed JSON object | a JSON string containing the key
+    parse_event_t::object_end | the parser read `}` and finished processing a JSON object | depth of the parent of the JSON object | the parsed JSON object
+    parse_event_t::array_start | the parser read `[` and started to process a JSON array | depth of the parent of the JSON array | a JSON value with type discarded
+    parse_event_t::array_end | the parser read `]` and finished processing a JSON array | depth of the parent of the JSON array | the parsed JSON array
+    parse_event_t::value | the parser finished reading a JSON value | depth of the value | the parsed JSON value
+
+    @image html callback_events.png "Example when certain parse events are triggered"
+
+    Discarding a value (i.e., returning `false`) has different effects
+    depending on the context in which function was called:
+
+    - Discarded values in structured types are skipped. That is, the parser
+      will behave as if the discarded value was never read.
+    - In case a value outside a structured type is skipped, it is replaced
+      with `null`. This case happens if the top-level element is skipped.
+
+    @param[in] depth  the depth of the recursion during parsing
+
+    @param[in] event  an event of type parse_event_t indicating the context in
+    the callback function has been called
+
+    @param[in,out] parsed  the current intermediate parse result; note that
+    writing to this value has no effect for parse_event_t::key events
+
+    @return Whether the JSON value which called the function during parsing
+    should be kept (`true`) or not (`false`). In the latter case, it is either
+    skipped completely or replaced by an empty discarded object.
+
+    @sa @ref parse(std::istream&, parser_callback_t) or
+    @ref parse(const CharT, const parser_callback_t) for examples
+
+    @since version 1.0.0
+    */
+    using parser_callback_t = std::function<bool(int depth,
+                              parse_event_t event,
+                              basic_json& parsed)>;
+
+
+    //////////////////
+    // constructors //
+    //////////////////
+
+    /// @name constructors and destructors
+    /// Constructors of class @ref basic_json, copy/move constructor, copy
+    /// assignment, static functions creating objects, and the destructor.
+    /// @{
+
+    /*!
+    @brief create an empty value with a given type
+
+    Create an empty JSON value with a given type. The value will be default
+    initialized with an empty value which depends on the type:
+
+    Value type  | initial value
+    ----------- | -------------
+    null        | `null`
+    boolean     | `false`
+    string      | `""`
+    number      | `0`
+    object      | `{}`
+    array       | `[]`
+
+    @param[in] value_type  the type of the value to create
+
+    @complexity Constant.
+
+    @liveexample{The following code shows the constructor for different @ref
+    value_t values,basic_json__value_t}
+
+    @since version 1.0.0
+    */
+    basic_json(const value_t value_type)
+        : m_type(value_type), m_value(value_type)
+    {
+        assert_invariant();
+    }
+
+    /*!
+    @brief create a null object
+
+    Create a `null` JSON value. It either takes a null pointer as parameter
+    (explicitly creating `null`) or no parameter (implicitly creating `null`).
+    The passed null pointer itself is not read -- it is only used to choose
+    the right constructor.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this constructor never throws
+    exceptions.
+
+    @liveexample{The following code shows the constructor with and without a
+    null pointer parameter.,basic_json__nullptr_t}
+
+    @since version 1.0.0
+    */
+    basic_json(std::nullptr_t = nullptr) noexcept
+        : basic_json(value_t::null)
+    {
+        assert_invariant();
+    }
+
+    /*!
+    @brief create a JSON value
+
+    This is a "catch all" constructor for all compatible JSON types; that is,
+    types for which a `to_json()` method exsits. The constructor forwards the
+    parameter @a val to that method (to `json_serializer<U>::to_json` method
+    with `U = uncvref_t<CompatibleType>`, to be exact).
+
+    Template type @a CompatibleType includes, but is not limited to, the
+    following types:
+    - **arrays**: @ref array_t and all kinds of compatible containers such as
+      `std::vector`, `std::deque`, `std::list`, `std::forward_list`,
+      `std::array`, `std::set`, `std::unordered_set`, `std::multiset`, and
+      `unordered_multiset` with a `value_type` from which a @ref basic_json
+      value can be constructed.
+    - **objects**: @ref object_t and all kinds of compatible associative
+      containers such as `std::map`, `std::unordered_map`, `std::multimap`,
+      and `std::unordered_multimap` with a `key_type` compatible to
+      @ref string_t and a `value_type` from which a @ref basic_json value can
+      be constructed.
+    - **strings**: @ref string_t, string literals, and all compatible string
+      containers can be used.
+    - **numbers**: @ref number_integer_t, @ref number_unsigned_t,
+      @ref number_float_t, and all convertible number types such as `int`,
+      `size_t`, `int64_t`, `float` or `double` can be used.
+    - **boolean**: @ref boolean_t / `bool` can be used.
+
+    See the examples below.
+
+    @tparam CompatibleType a type such that:
+    - @a CompatibleType is not derived from `std::istream`,
+    - @a CompatibleType is not @ref basic_json (to avoid hijacking copy/move
+         constructors),
+    - @a CompatibleType is not a @ref basic_json nested type (e.g.,
+         @ref json_pointer, @ref iterator, etc ...)
+    - @ref @ref json_serializer<U> has a
+         `to_json(basic_json_t&, CompatibleType&&)` method
+
+    @tparam U = `uncvref_t<CompatibleType>`
+
+    @param[in] val the value to be forwarded
+
+    @complexity Usually linear in the size of the passed @a val, also
+                depending on the implementation of the called `to_json()`
+                method.
+
+    @throw what `json_serializer<U>::to_json()` throws
+
+    @liveexample{The following code shows the constructor with several
+    compatible types.,basic_json__CompatibleType}
+
+    @since version 2.1.0
+    */
+    template<typename CompatibleType, typename U = detail::uncvref_t<CompatibleType>,
+             detail::enable_if_t<not std::is_base_of<std::istream, U>::value and
+                                 not std::is_same<U, basic_json_t>::value and
+                                 not detail::is_basic_json_nested_type<
+                                     basic_json_t, U>::value and
+                                 detail::has_to_json<basic_json, U>::value,
+                                 int> = 0>
+    basic_json(CompatibleType && val) noexcept(noexcept(JSONSerializer<U>::to_json(
+                std::declval<basic_json_t&>(), std::forward<CompatibleType>(val))))
+    {
+        JSONSerializer<U>::to_json(*this, std::forward<CompatibleType>(val));
+        assert_invariant();
+    }
+
+    /*!
+    @brief create a container (array or object) from an initializer list
+
+    Creates a JSON value of type array or object from the passed initializer
+    list @a init. In case @a type_deduction is `true` (default), the type of
+    the JSON value to be created is deducted from the initializer list @a init
+    according to the following rules:
+
+    1. If the list is empty, an empty JSON object value `{}` is created.
+    2. If the list consists of pairs whose first element is a string, a JSON
+       object value is created where the first elements of the pairs are
+       treated as keys and the second elements are as values.
+    3. In all other cases, an array is created.
+
+    The rules aim to create the best fit between a C++ initializer list and
+    JSON values. The rationale is as follows:
+
+    1. The empty initializer list is written as `{}` which is exactly an empty
+       JSON object.
+    2. C++ has now way of describing mapped types other than to list a list of
+       pairs. As JSON requires that keys must be of type string, rule 2 is the
+       weakest constraint one can pose on initializer lists to interpret them
+       as an object.
+    3. In all other cases, the initializer list could not be interpreted as
+       JSON object type, so interpreting it as JSON array type is safe.
+
+    With the rules described above, the following JSON values cannot be
+    expressed by an initializer list:
+
+    - the empty array (`[]`): use @ref array(std::initializer_list<basic_json>)
+      with an empty initializer list in this case
+    - arrays whose elements satisfy rule 2: use @ref
+      array(std::initializer_list<basic_json>) with the same initializer list
+      in this case
+
+    @note When used without parentheses around an empty initializer list, @ref
+    basic_json() is called instead of this function, yielding the JSON null
+    value.
+
+    @param[in] init  initializer list with JSON values
+
+    @param[in] type_deduction internal parameter; when set to `true`, the type
+    of the JSON value is deducted from the initializer list @a init; when set
+    to `false`, the type provided via @a manual_type is forced. This mode is
+    used by the functions @ref array(std::initializer_list<basic_json>) and
+    @ref object(std::initializer_list<basic_json>).
+
+    @param[in] manual_type internal parameter; when @a type_deduction is set
+    to `false`, the created JSON value will use the provided type (only @ref
+    value_t::array and @ref value_t::object are valid); when @a type_deduction
+    is set to `true`, this parameter has no effect
+
+    @throw type_error.301 if @a type_deduction is `false`, @a manual_type is
+    `value_t::object`, but @a init contains an element which is not a pair
+    whose first element is a string. In this case, the constructor could not
+    create an object. If @a type_deduction would have be `true`, an array
+    would have been created. See @ref object(std::initializer_list<basic_json>)
+    for an example.
+
+    @complexity Linear in the size of the initializer list @a init.
+
+    @liveexample{The example below shows how JSON values are created from
+    initializer lists.,basic_json__list_init_t}
+
+    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
+    value from an initializer list
+    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
+    value from an initializer list
+
+    @since version 1.0.0
+    */
+    basic_json(std::initializer_list<basic_json> init,
+               bool type_deduction = true,
+               value_t manual_type = value_t::array)
+    {
+        // check if each element is an array with two elements whose first
+        // element is a string
+        bool is_an_object = std::all_of(init.begin(), init.end(),
+                                        [](const basic_json & element)
+        {
+            return element.is_array() and element.size() == 2 and element[0].is_string();
+        });
+
+        // adjust type if type deduction is not wanted
+        if (not type_deduction)
+        {
+            // if array is wanted, do not create an object though possible
+            if (manual_type == value_t::array)
+            {
+                is_an_object = false;
+            }
+
+            // if object is wanted but impossible, throw an exception
+            if (manual_type == value_t::object and not is_an_object)
+            {
+                JSON_THROW(type_error::create(301, "cannot create object from initializer list"));
+            }
+        }
+
+        if (is_an_object)
+        {
+            // the initializer list is a list of pairs -> create object
+            m_type = value_t::object;
+            m_value = value_t::object;
+
+            std::for_each(init.begin(), init.end(), [this](const basic_json & element)
+            {
+                m_value.object->emplace(*(element[0].m_value.string), element[1]);
+            });
+        }
+        else
+        {
+            // the initializer list describes an array -> create array
+            m_type = value_t::array;
+            m_value.array = create<array_t>(init);
+        }
+
+        assert_invariant();
+    }
+
+    /*!
+    @brief explicitly create an array from an initializer list
+
+    Creates a JSON array value from a given initializer list. That is, given a
+    list of values `a, b, c`, creates the JSON value `[a, b, c]`. If the
+    initializer list is empty, the empty array `[]` is created.
+
+    @note This function is only needed to express two edge cases that cannot
+    be realized with the initializer list constructor (@ref
+    basic_json(std::initializer_list<basic_json>, bool, value_t)). These cases
+    are:
+    1. creating an array whose elements are all pairs whose first element is a
+    string -- in this case, the initializer list constructor would create an
+    object, taking the first elements as keys
+    2. creating an empty array -- passing the empty initializer list to the
+    initializer list constructor yields an empty object
+
+    @param[in] init  initializer list with JSON values to create an array from
+    (optional)
+
+    @return JSON array value
+
+    @complexity Linear in the size of @a init.
+
+    @liveexample{The following code shows an example for the `array`
+    function.,array}
+
+    @sa @ref basic_json(std::initializer_list<basic_json>, bool, value_t) --
+    create a JSON value from an initializer list
+    @sa @ref object(std::initializer_list<basic_json>) -- create a JSON object
+    value from an initializer list
+
+    @since version 1.0.0
+    */
+    static basic_json array(std::initializer_list<basic_json> init =
+                                std::initializer_list<basic_json>())
+    {
+        return basic_json(init, false, value_t::array);
+    }
+
+    /*!
+    @brief explicitly create an object from an initializer list
+
+    Creates a JSON object value from a given initializer list. The initializer
+    lists elements must be pairs, and their first elements must be strings. If
+    the initializer list is empty, the empty object `{}` is created.
+
+    @note This function is only added for symmetry reasons. In contrast to the
+    related function @ref array(std::initializer_list<basic_json>), there are
+    no cases which can only be expressed by this function. That is, any
+    initializer list @a init can also be passed to the initializer list
+    constructor @ref basic_json(std::initializer_list<basic_json>, bool, value_t).
+
+    @param[in] init  initializer list to create an object from (optional)
+
+    @return JSON object value
+
+    @throw type_error.301 if @a init is not a list of pairs whose first
+    elements are strings. In this case, no object can be created. When such a
+    value is passed to @ref basic_json(std::initializer_list<basic_json>, bool, value_t),
+    an array would have been created from the passed initializer list @a init.
+    See example below.
+
+    @complexity Linear in the size of @a init.
+
+    @liveexample{The following code shows an example for the `object`
+    function.,object}
+
+    @sa @ref basic_json(std::initializer_list<basic_json>, bool, value_t) --
+    create a JSON value from an initializer list
+    @sa @ref array(std::initializer_list<basic_json>) -- create a JSON array
+    value from an initializer list
+
+    @since version 1.0.0
+    */
+    static basic_json object(std::initializer_list<basic_json> init =
+                                 std::initializer_list<basic_json>())
+    {
+        return basic_json(init, false, value_t::object);
+    }
+
+    /*!
+    @brief construct an array with count copies of given value
+
+    Constructs a JSON array value by creating @a cnt copies of a passed value.
+    In case @a cnt is `0`, an empty array is created. As postcondition,
+    `std::distance(begin(),end()) == cnt` holds.
+
+    @param[in] cnt  the number of JSON copies of @a val to create
+    @param[in] val  the JSON value to copy
+
+    @complexity Linear in @a cnt.
+
+    @liveexample{The following code shows examples for the @ref
+    basic_json(size_type\, const basic_json&)
+    constructor.,basic_json__size_type_basic_json}
+
+    @since version 1.0.0
+    */
+    basic_json(size_type cnt, const basic_json& val)
+        : m_type(value_t::array)
+    {
+        m_value.array = create<array_t>(cnt, val);
+        assert_invariant();
+    }
+
+    /*!
+    @brief construct a JSON container given an iterator range
+
+    Constructs the JSON value with the contents of the range `[first, last)`.
+    The semantics depends on the different types a JSON value can have:
+    - In case of primitive types (number, boolean, or string), @a first must
+      be `begin()` and @a last must be `end()`. In this case, the value is
+      copied. Otherwise, invalid_iterator.204 is thrown.
+    - In case of structured types (array, object), the constructor behaves as
+      similar versions for `std::vector`.
+    - In case of a null type, invalid_iterator.206 is thrown.
+
+    @tparam InputIT an input iterator type (@ref iterator or @ref
+    const_iterator)
+
+    @param[in] first begin of the range to copy from (included)
+    @param[in] last end of the range to copy from (excluded)
+
+    @pre Iterators @a first and @a last must be initialized. **This
+         precondition is enforced with an assertion.**
+
+    @pre Range `[first, last)` is valid. Usually, this precondition cannot be
+         checked efficiently. Only certain edge cases are detected; see the
+         description of the exceptions below.
+
+    @throw invalid_iterator.201 if iterators @a first and @a last are not
+    compatible (i.e., do not belong to the same JSON value). In this case,
+    the range `[first, last)` is undefined.
+    @throw invalid_iterator.204 if iterators @a first and @a last belong to a
+    primitive type (number, boolean, or string), but @a first does not point
+    to the first element any more. In this case, the range `[first, last)` is
+    undefined. See example code below.
+    @throw invalid_iterator.206 if iterators @a first and @a last belong to a
+    null value. In this case, the range `[first, last)` is undefined.
+
+    @complexity Linear in distance between @a first and @a last.
+
+    @liveexample{The example below shows several ways to create JSON values by
+    specifying a subrange with iterators.,basic_json__InputIt_InputIt}
+
+    @since version 1.0.0
+    */
+    template<class InputIT, typename std::enable_if<
+                 std::is_same<InputIT, typename basic_json_t::iterator>::value or
+                 std::is_same<InputIT, typename basic_json_t::const_iterator>::value, int>::type = 0>
+    basic_json(InputIT first, InputIT last)
+    {
+        assert(first.m_object != nullptr);
+        assert(last.m_object != nullptr);
+
+        // make sure iterator fits the current value
+        if (first.m_object != last.m_object)
+        {
+            JSON_THROW(invalid_iterator::create(201, "iterators are not compatible"));
+        }
+
+        // copy type from first iterator
+        m_type = first.m_object->m_type;
+
+        // check if iterator range is complete for primitive values
+        switch (m_type)
+        {
+            case value_t::boolean:
+            case value_t::number_float:
+            case value_t::number_integer:
+            case value_t::number_unsigned:
+            case value_t::string:
+            {
+                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
+                {
+                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
+                }
+                break;
+            }
+
+            default:
+            {
+                break;
+            }
+        }
+
+        switch (m_type)
+        {
+            case value_t::number_integer:
+            {
+                m_value.number_integer = first.m_object->m_value.number_integer;
+                break;
+            }
+
+            case value_t::number_unsigned:
+            {
+                m_value.number_unsigned = first.m_object->m_value.number_unsigned;
+                break;
+            }
+
+            case value_t::number_float:
+            {
+                m_value.number_float = first.m_object->m_value.number_float;
+                break;
+            }
+
+            case value_t::boolean:
+            {
+                m_value.boolean = first.m_object->m_value.boolean;
+                break;
+            }
+
+            case value_t::string:
+            {
+                m_value = *first.m_object->m_value.string;
+                break;
+            }
+
+            case value_t::object:
+            {
+                m_value.object = create<object_t>(first.m_it.object_iterator,
+                                                  last.m_it.object_iterator);
+                break;
+            }
+
+            case value_t::array:
+            {
+                m_value.array = create<array_t>(first.m_it.array_iterator,
+                                                last.m_it.array_iterator);
+                break;
+            }
+
+            default:
+            {
+                JSON_THROW(invalid_iterator::create(206, "cannot construct with iterators from " +
+                                                    first.m_object->type_name()));
+            }
+        }
+
+        assert_invariant();
+    }
+
+
+    ///////////////////////////////////////
+    // other constructors and destructor //
+    ///////////////////////////////////////
+
+    /*!
+    @brief copy constructor
+
+    Creates a copy of a given JSON value.
+
+    @param[in] other  the JSON value to copy
+
+    @complexity Linear in the size of @a other.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is linear.
+    - As postcondition, it holds: `other == basic_json(other)`.
+
+    @liveexample{The following code shows an example for the copy
+    constructor.,basic_json__basic_json}
+
+    @since version 1.0.0
+    */
+    basic_json(const basic_json& other)
+        : m_type(other.m_type)
+    {
+        // check of passed value is valid
+        other.assert_invariant();
+
+        switch (m_type)
+        {
+            case value_t::object:
+            {
+                m_value = *other.m_value.object;
+                break;
+            }
+
+            case value_t::array:
+            {
+                m_value = *other.m_value.array;
+                break;
+            }
+
+            case value_t::string:
+            {
+                m_value = *other.m_value.string;
+                break;
+            }
+
+            case value_t::boolean:
+            {
+                m_value = other.m_value.boolean;
+                break;
+            }
+
+            case value_t::number_integer:
+            {
+                m_value = other.m_value.number_integer;
+                break;
+            }
+
+            case value_t::number_unsigned:
+            {
+                m_value = other.m_value.number_unsigned;
+                break;
+            }
+
+            case value_t::number_float:
+            {
+                m_value = other.m_value.number_float;
+                break;
+            }
+
+            default:
+            {
+                break;
+            }
+        }
+
+        assert_invariant();
+    }
+
+    /*!
+    @brief move constructor
+
+    Move constructor. Constructs a JSON value with the contents of the given
+    value @a other using move semantics. It "steals" the resources from @a
+    other and leaves it as JSON null value.
+
+    @param[in,out] other  value to move to this object
+
+    @post @a other is a JSON null value
+
+    @complexity Constant.
+
+    @liveexample{The code below shows the move constructor explicitly called
+    via std::move.,basic_json__moveconstructor}
+
+    @since version 1.0.0
+    */
+    basic_json(basic_json&& other) noexcept
+        : m_type(std::move(other.m_type)),
+          m_value(std::move(other.m_value))
+    {
+        // check that passed value is valid
+        other.assert_invariant();
+
+        // invalidate payload
+        other.m_type = value_t::null;
+        other.m_value = {};
+
+        assert_invariant();
+    }
+
+    /*!
+    @brief copy assignment
+
+    Copy assignment operator. Copies a JSON value via the "copy and swap"
+    strategy: It is expressed in terms of the copy constructor, destructor,
+    and the swap() member function.
+
+    @param[in] other  value to copy from
+
+    @complexity Linear.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is linear.
+
+    @liveexample{The code below shows and example for the copy assignment. It
+    creates a copy of value `a` which is then swapped with `b`. Finally\, the
+    copy of `a` (which is the null value after the swap) is
+    destroyed.,basic_json__copyassignment}
+
+    @since version 1.0.0
+    */
+    reference& operator=(basic_json other) noexcept (
+        std::is_nothrow_move_constructible<value_t>::value and
+        std::is_nothrow_move_assignable<value_t>::value and
+        std::is_nothrow_move_constructible<json_value>::value and
+        std::is_nothrow_move_assignable<json_value>::value
+    )
+    {
+        // check that passed value is valid
+        other.assert_invariant();
+
+        using std::swap;
+        swap(m_type, other.m_type);
+        swap(m_value, other.m_value);
+
+        assert_invariant();
+        return *this;
+    }
+
+    /*!
+    @brief destructor
+
+    Destroys the JSON value and frees all allocated memory.
+
+    @complexity Linear.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is linear.
+    - All stored elements are destroyed and all memory is freed.
+
+    @since version 1.0.0
+    */
+    ~basic_json()
+    {
+        assert_invariant();
+
+        switch (m_type)
+        {
+            case value_t::object:
+            {
+                AllocatorType<object_t> alloc;
+                alloc.destroy(m_value.object);
+                alloc.deallocate(m_value.object, 1);
+                break;
+            }
+
+            case value_t::array:
+            {
+                AllocatorType<array_t> alloc;
+                alloc.destroy(m_value.array);
+                alloc.deallocate(m_value.array, 1);
+                break;
+            }
+
+            case value_t::string:
+            {
+                AllocatorType<string_t> alloc;
+                alloc.destroy(m_value.string);
+                alloc.deallocate(m_value.string, 1);
+                break;
+            }
+
+            default:
+            {
+                // all other types need no specific destructor
+                break;
+            }
+        }
+    }
+
+    /// @}
+
+  public:
+    ///////////////////////
+    // object inspection //
+    ///////////////////////
+
+    /// @name object inspection
+    /// Functions to inspect the type of a JSON value.
+    /// @{
+
+    /*!
+    @brief serialization
+
+    Serialization function for JSON values. The function tries to mimic
+    Python's `json.dumps()` function, and currently supports its @a indent
+    parameter.
+
+    @param[in] indent If indent is nonnegative, then array elements and object
+    members will be pretty-printed with that indent level. An indent level of
+    `0` will only insert newlines. `-1` (the default) selects the most compact
+    representation.
+
+    @return string containing the serialization of the JSON value
+
+    @complexity Linear.
+
+    @liveexample{The following example shows the effect of different @a indent
+    parameters to the result of the serialization.,dump}
+
+    @see https://docs.python.org/2/library/json.html#json.dump
+
+    @since version 1.0.0
+    */
+    string_t dump(const int indent = -1) const
+    {
+        std::stringstream ss;
+        serializer s(ss);
+
+        if (indent >= 0)
+        {
+            s.dump(*this, true, static_cast<unsigned int>(indent));
+        }
+        else
+        {
+            s.dump(*this, false, 0);
+        }
+
+        return ss.str();
+    }
+
+    /*!
+    @brief return the type of the JSON value (explicit)
+
+    Return the type of the JSON value as a value from the @ref value_t
+    enumeration.
+
+    @return the type of the JSON value
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `type()` for all JSON
+    types.,type}
+
+    @since version 1.0.0
+    */
+    constexpr value_t type() const noexcept
+    {
+        return m_type;
+    }
+
+    /*!
+    @brief return whether type is primitive
+
+    This function returns true iff the JSON type is primitive (string, number,
+    boolean, or null).
+
+    @return `true` if type is primitive (string, number, boolean, or null),
+    `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_primitive()` for all JSON
+    types.,is_primitive}
+
+    @sa @ref is_structured() -- returns whether JSON value is structured
+    @sa @ref is_null() -- returns whether JSON value is `null`
+    @sa @ref is_string() -- returns whether JSON value is a string
+    @sa @ref is_boolean() -- returns whether JSON value is a boolean
+    @sa @ref is_number() -- returns whether JSON value is a number
+
+    @since version 1.0.0
+    */
+    constexpr bool is_primitive() const noexcept
+    {
+        return is_null() or is_string() or is_boolean() or is_number();
+    }
+
+    /*!
+    @brief return whether type is structured
+
+    This function returns true iff the JSON type is structured (array or
+    object).
+
+    @return `true` if type is structured (array or object), `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_structured()` for all JSON
+    types.,is_structured}
+
+    @sa @ref is_primitive() -- returns whether value is primitive
+    @sa @ref is_array() -- returns whether value is an array
+    @sa @ref is_object() -- returns whether value is an object
+
+    @since version 1.0.0
+    */
+    constexpr bool is_structured() const noexcept
+    {
+        return is_array() or is_object();
+    }
+
+    /*!
+    @brief return whether value is null
+
+    This function returns true iff the JSON value is null.
+
+    @return `true` if type is null, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_null()` for all JSON
+    types.,is_null}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_null() const noexcept
+    {
+        return m_type == value_t::null;
+    }
+
+    /*!
+    @brief return whether value is a boolean
+
+    This function returns true iff the JSON value is a boolean.
+
+    @return `true` if type is boolean, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_boolean()` for all JSON
+    types.,is_boolean}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_boolean() const noexcept
+    {
+        return m_type == value_t::boolean;
+    }
+
+    /*!
+    @brief return whether value is a number
+
+    This function returns true iff the JSON value is a number. This includes
+    both integer and floating-point values.
+
+    @return `true` if type is number (regardless whether integer, unsigned
+    integer or floating-type), `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_number()` for all JSON
+    types.,is_number}
+
+    @sa @ref is_number_integer() -- check if value is an integer or unsigned
+    integer number
+    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
+    number
+    @sa @ref is_number_float() -- check if value is a floating-point number
+
+    @since version 1.0.0
+    */
+    constexpr bool is_number() const noexcept
+    {
+        return is_number_integer() or is_number_float();
+    }
+
+    /*!
+    @brief return whether value is an integer number
+
+    This function returns true iff the JSON value is an integer or unsigned
+    integer number. This excludes floating-point values.
+
+    @return `true` if type is an integer or unsigned integer number, `false`
+    otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_number_integer()` for all
+    JSON types.,is_number_integer}
+
+    @sa @ref is_number() -- check if value is a number
+    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
+    number
+    @sa @ref is_number_float() -- check if value is a floating-point number
+
+    @since version 1.0.0
+    */
+    constexpr bool is_number_integer() const noexcept
+    {
+        return m_type == value_t::number_integer or m_type == value_t::number_unsigned;
+    }
+
+    /*!
+    @brief return whether value is an unsigned integer number
+
+    This function returns true iff the JSON value is an unsigned integer
+    number. This excludes floating-point and (signed) integer values.
+
+    @return `true` if type is an unsigned integer number, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_number_unsigned()` for all
+    JSON types.,is_number_unsigned}
+
+    @sa @ref is_number() -- check if value is a number
+    @sa @ref is_number_integer() -- check if value is an integer or unsigned
+    integer number
+    @sa @ref is_number_float() -- check if value is a floating-point number
+
+    @since version 2.0.0
+    */
+    constexpr bool is_number_unsigned() const noexcept
+    {
+        return m_type == value_t::number_unsigned;
+    }
+
+    /*!
+    @brief return whether value is a floating-point number
+
+    This function returns true iff the JSON value is a floating-point number.
+    This excludes integer and unsigned integer values.
+
+    @return `true` if type is a floating-point number, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_number_float()` for all
+    JSON types.,is_number_float}
+
+    @sa @ref is_number() -- check if value is number
+    @sa @ref is_number_integer() -- check if value is an integer number
+    @sa @ref is_number_unsigned() -- check if value is an unsigned integer
+    number
+
+    @since version 1.0.0
+    */
+    constexpr bool is_number_float() const noexcept
+    {
+        return m_type == value_t::number_float;
+    }
+
+    /*!
+    @brief return whether value is an object
+
+    This function returns true iff the JSON value is an object.
+
+    @return `true` if type is object, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_object()` for all JSON
+    types.,is_object}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_object() const noexcept
+    {
+        return m_type == value_t::object;
+    }
+
+    /*!
+    @brief return whether value is an array
+
+    This function returns true iff the JSON value is an array.
+
+    @return `true` if type is array, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_array()` for all JSON
+    types.,is_array}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_array() const noexcept
+    {
+        return m_type == value_t::array;
+    }
+
+    /*!
+    @brief return whether value is a string
+
+    This function returns true iff the JSON value is a string.
+
+    @return `true` if type is string, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_string()` for all JSON
+    types.,is_string}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_string() const noexcept
+    {
+        return m_type == value_t::string;
+    }
+
+    /*!
+    @brief return whether value is discarded
+
+    This function returns true iff the JSON value was discarded during parsing
+    with a callback function (see @ref parser_callback_t).
+
+    @note This function will always be `false` for JSON values after parsing.
+    That is, discarded values can only occur during parsing, but will be
+    removed when inside a structured value or replaced by null in other cases.
+
+    @return `true` if type is discarded, `false` otherwise.
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies `is_discarded()` for all JSON
+    types.,is_discarded}
+
+    @since version 1.0.0
+    */
+    constexpr bool is_discarded() const noexcept
+    {
+        return m_type == value_t::discarded;
+    }
+
+    /*!
+    @brief return the type of the JSON value (implicit)
+
+    Implicitly return the type of the JSON value as a value from the @ref
+    value_t enumeration.
+
+    @return the type of the JSON value
+
+    @complexity Constant.
+
+    @exceptionsafety No-throw guarantee: this member function never throws
+    exceptions.
+
+    @liveexample{The following code exemplifies the @ref value_t operator for
+    all JSON types.,operator__value_t}
+
+    @since version 1.0.0
+    */
+    constexpr operator value_t() const noexcept
+    {
+        return m_type;
+    }
+
+    /// @}
+
+  private:
+    //////////////////
+    // value access //
+    //////////////////
+
+    /// get a boolean (explicit)
+    boolean_t get_impl(boolean_t* /*unused*/) const
+    {
+        if (is_boolean())
+        {
+            return m_value.boolean;
+        }
+
+        JSON_THROW(type_error::create(302, "type must be boolean, but is " + type_name()));
+    }
+
+    /// get a pointer to the value (object)
+    object_t* get_impl_ptr(object_t* /*unused*/) noexcept
+    {
+        return is_object() ? m_value.object : nullptr;
+    }
+
+    /// get a pointer to the value (object)
+    constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const noexcept
+    {
+        return is_object() ? m_value.object : nullptr;
+    }
+
+    /// get a pointer to the value (array)
+    array_t* get_impl_ptr(array_t* /*unused*/) noexcept
+    {
+        return is_array() ? m_value.array : nullptr;
+    }
+
+    /// get a pointer to the value (array)
+    constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const noexcept
+    {
+        return is_array() ? m_value.array : nullptr;
+    }
+
+    /// get a pointer to the value (string)
+    string_t* get_impl_ptr(string_t* /*unused*/) noexcept
+    {
+        return is_string() ? m_value.string : nullptr;
+    }
+
+    /// get a pointer to the value (string)
+    constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const noexcept
+    {
+        return is_string() ? m_value.string : nullptr;
+    }
+
+    /// get a pointer to the value (boolean)
+    boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
+    {
+        return is_boolean() ? &m_value.boolean : nullptr;
+    }
+
+    /// get a pointer to the value (boolean)
+    constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) const noexcept
+    {
+        return is_boolean() ? &m_value.boolean : nullptr;
+    }
+
+    /// get a pointer to the value (integer number)
+    number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
+    {
+        return is_number_integer() ? &m_value.number_integer : nullptr;
+    }
+
+    /// get a pointer to the value (integer number)
+    constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /*unused*/) const noexcept
+    {
+        return is_number_integer() ? &m_value.number_integer : nullptr;
+    }
+
+    /// get a pointer to the value (unsigned number)
+    number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
+    {
+        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
+    }
+
+    /// get a pointer to the value (unsigned number)
+    constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t* /*unused*/) const noexcept
+    {
+        return is_number_unsigned() ? &m_value.number_unsigned : nullptr;
+    }
+
+    /// get a pointer to the value (floating-point number)
+    number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
+    {
+        return is_number_float() ? &m_value.number_float : nullptr;
+    }
+
+    /// get a pointer to the value (floating-point number)
+    constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unused*/) const noexcept
+    {
+        return is_number_float() ? &m_value.number_float : nullptr;
+    }
+
+    /*!
+    @brief helper function to implement get_ref()
+
+    This funcion helps to implement get_ref() without code duplication for
+    const and non-const overloads
+
+    @tparam ThisType will be deduced as `basic_json` or `const basic_json`
+
+    @throw type_error.303 if ReferenceType does not match underlying value
+    type of the current JSON
+    */
+    template<typename ReferenceType, typename ThisType>
+    static ReferenceType get_ref_impl(ThisType& obj)
+    {
+        // helper type
+        using PointerType = typename std::add_pointer<ReferenceType>::type;
+
+        // delegate the call to get_ptr<>()
+        auto ptr = obj.template get_ptr<PointerType>();
+
+        if (ptr != nullptr)
+        {
+            return *ptr;
+        }
+
+        JSON_THROW(type_error::create(303, "incompatible ReferenceType for get_ref, actual type is " + obj.type_name()));
+    }
+
+  public:
+    /// @name value access
+    /// Direct access to the stored value of a JSON value.
+    /// @{
+
+    /*!
+    @brief get special-case overload
+
+    This overloads avoids a lot of template boilerplate, it can be seen as the
+    identity method
+
+    @tparam BasicJsonType == @ref basic_json
+
+    @return a copy of *this
+
+    @complexity Constant.
+
+    @since version 2.1.0
+    */
+    template <
+        typename BasicJsonType,
+        detail::enable_if_t<std::is_same<typename std::remove_const<BasicJsonType>::type,
+                                         basic_json_t>::value,
+                            int> = 0 >
+    basic_json get() const
+    {
+        return *this;
+    }
+
+    /*!
+    @brief get a value (explicit)
+
+    Explicit type conversion between the JSON value and a compatible value
+    which is [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
+    and [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
+    The value is converted by calling the @ref json_serializer<ValueType>
+    `from_json()` method.
+
+    The function is equivalent to executing
+    @code {.cpp}
+    ValueType ret;
+    JSONSerializer<ValueType>::from_json(*this, ret);
+    return ret;
+    @endcode
+
+    This overloads is chosen if:
+    - @a ValueType is not @ref basic_json,
+    - @ref json_serializer<ValueType> has a `from_json()` method of the form
+      `void from_json(const @ref basic_json&, ValueType&)`, and
+    - @ref json_serializer<ValueType> does not have a `from_json()` method of
+      the form `ValueType from_json(const @ref basic_json&)`
+
+    @tparam ValueTypeCV the provided value type
+    @tparam ValueType the returned value type
+
+    @return copy of the JSON value, converted to @a ValueType
+
+    @throw what @ref json_serializer<ValueType> `from_json()` method throws
+
+    @liveexample{The example below shows several conversions from JSON values
+    to other types. There a few things to note: (1) Floating-point numbers can
+    be converted to integers\, (2) A JSON array can be converted to a standard
+    `std::vector<short>`\, (3) A JSON object can be converted to C++
+    associative containers such as `std::unordered_map<std::string\,
+    json>`.,get__ValueType_const}
+
+    @since version 2.1.0
+    */
+    template <
+        typename ValueTypeCV,
+        typename ValueType = detail::uncvref_t<ValueTypeCV>,
+        detail::enable_if_t <
+            not std::is_same<basic_json_t, ValueType>::value and
+            detail::has_from_json<basic_json_t, ValueType>::value and
+            not detail::has_non_default_from_json<basic_json_t, ValueType>::value,
+            int > = 0 >
+    ValueType get() const noexcept(noexcept(
+                                       JSONSerializer<ValueType>::from_json(std::declval<const basic_json_t&>(), std::declval<ValueType&>())))
+    {
+        // we cannot static_assert on ValueTypeCV being non-const, because
+        // there is support for get<const basic_json_t>(), which is why we
+        // still need the uncvref
+        static_assert(not std::is_reference<ValueTypeCV>::value,
+                      "get() cannot be used with reference types, you might want to use get_ref()");
+        static_assert(std::is_default_constructible<ValueType>::value,
+                      "types must be DefaultConstructible when used with get()");
+
+        ValueType ret;
+        JSONSerializer<ValueType>::from_json(*this, ret);
+        return ret;
+    }
+
+    /*!
+    @brief get a value (explicit); special case
+
+    Explicit type conversion between the JSON value and a compatible value
+    which is **not** [CopyConstructible](http://en.cppreference.com/w/cpp/concept/CopyConstructible)
+    and **not** [DefaultConstructible](http://en.cppreference.com/w/cpp/concept/DefaultConstructible).
+    The value is converted by calling the @ref json_serializer<ValueType>
+    `from_json()` method.
+
+    The function is equivalent to executing
+    @code {.cpp}
+    return JSONSerializer<ValueTypeCV>::from_json(*this);
+    @endcode
+
+    This overloads is chosen if:
+    - @a ValueType is not @ref basic_json and
+    - @ref json_serializer<ValueType> has a `from_json()` method of the form
+      `ValueType from_json(const @ref basic_json&)`
+
+    @note If @ref json_serializer<ValueType> has both overloads of
+    `from_json()`, this one is chosen.
+
+    @tparam ValueTypeCV the provided value type
+    @tparam ValueType the returned value type
+
+    @return copy of the JSON value, converted to @a ValueType
+
+    @throw what @ref json_serializer<ValueType> `from_json()` method throws
+
+    @since version 2.1.0
+    */
+    template <
+        typename ValueTypeCV,
+        typename ValueType = detail::uncvref_t<ValueTypeCV>,
+        detail::enable_if_t<not std::is_same<basic_json_t, ValueType>::value and
+                            detail::has_non_default_from_json<basic_json_t,
+                                    ValueType>::value, int> = 0 >
+    ValueType get() const noexcept(noexcept(
+                                       JSONSerializer<ValueTypeCV>::from_json(std::declval<const basic_json_t&>())))
+    {
+        static_assert(not std::is_reference<ValueTypeCV>::value,
+                      "get() cannot be used with reference types, you might want to use get_ref()");
+        return JSONSerializer<ValueTypeCV>::from_json(*this);
+    }
+
+    /*!
+    @brief get a pointer value (explicit)
+
+    Explicit pointer access to the internally stored JSON value. No copies are
+    made.
+
+    @warning The pointer becomes invalid if the underlying JSON object
+    changes.
+
+    @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref
+    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
+    @ref number_unsigned_t, or @ref number_float_t.
+
+    @return pointer to the internally stored JSON value if the requested
+    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how pointers to internal values of a
+    JSON value can be requested. Note that no type conversions are made and a
+    `nullptr` is returned if the value and the requested pointer type does not
+    match.,get__PointerType}
+
+    @sa @ref get_ptr() for explicit pointer-member access
+
+    @since version 1.0.0
+    */
+    template<typename PointerType, typename std::enable_if<
+                 std::is_pointer<PointerType>::value, int>::type = 0>
+    PointerType get() noexcept
+    {
+        // delegate the call to get_ptr
+        return get_ptr<PointerType>();
+    }
+
+    /*!
+    @brief get a pointer value (explicit)
+    @copydoc get()
+    */
+    template<typename PointerType, typename std::enable_if<
+                 std::is_pointer<PointerType>::value, int>::type = 0>
+    constexpr const PointerType get() const noexcept
+    {
+        // delegate the call to get_ptr
+        return get_ptr<PointerType>();
+    }
+
+    /*!
+    @brief get a pointer value (implicit)
+
+    Implicit pointer access to the internally stored JSON value. No copies are
+    made.
+
+    @warning Writing data to the pointee of the result yields an undefined
+    state.
+
+    @tparam PointerType pointer type; must be a pointer to @ref array_t, @ref
+    object_t, @ref string_t, @ref boolean_t, @ref number_integer_t,
+    @ref number_unsigned_t, or @ref number_float_t. Enforced by a static
+    assertion.
+
+    @return pointer to the internally stored JSON value if the requested
+    pointer type @a PointerType fits to the JSON value; `nullptr` otherwise
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how pointers to internal values of a
+    JSON value can be requested. Note that no type conversions are made and a
+    `nullptr` is returned if the value and the requested pointer type does not
+    match.,get_ptr}
+
+    @since version 1.0.0
+    */
+    template<typename PointerType, typename std::enable_if<
+                 std::is_pointer<PointerType>::value, int>::type = 0>
+    PointerType get_ptr() noexcept
+    {
+        // get the type of the PointerType (remove pointer and const)
+        using pointee_t = typename std::remove_const<typename
+                          std::remove_pointer<typename
+                          std::remove_const<PointerType>::type>::type>::type;
+        // make sure the type matches the allowed types
+        static_assert(
+            std::is_same<object_t, pointee_t>::value
+            or std::is_same<array_t, pointee_t>::value
+            or std::is_same<string_t, pointee_t>::value
+            or std::is_same<boolean_t, pointee_t>::value
+            or std::is_same<number_integer_t, pointee_t>::value
+            or std::is_same<number_unsigned_t, pointee_t>::value
+            or std::is_same<number_float_t, pointee_t>::value
+            , "incompatible pointer type");
+
+        // delegate the call to get_impl_ptr<>()
+        return get_impl_ptr(static_cast<PointerType>(nullptr));
+    }
+
+    /*!
+    @brief get a pointer value (implicit)
+    @copydoc get_ptr()
+    */
+    template<typename PointerType, typename std::enable_if<
+                 std::is_pointer<PointerType>::value and
+                 std::is_const<typename std::remove_pointer<PointerType>::type>::value, int>::type = 0>
+    constexpr const PointerType get_ptr() const noexcept
+    {
+        // get the type of the PointerType (remove pointer and const)
+        using pointee_t = typename std::remove_const<typename
+                          std::remove_pointer<typename
+                          std::remove_const<PointerType>::type>::type>::type;
+        // make sure the type matches the allowed types
+        static_assert(
+            std::is_same<object_t, pointee_t>::value
+            or std::is_same<array_t, pointee_t>::value
+            or std::is_same<string_t, pointee_t>::value
+            or std::is_same<boolean_t, pointee_t>::value
+            or std::is_same<number_integer_t, pointee_t>::value
+            or std::is_same<number_unsigned_t, pointee_t>::value
+            or std::is_same<number_float_t, pointee_t>::value
+            , "incompatible pointer type");
+
+        // delegate the call to get_impl_ptr<>() const
+        return get_impl_ptr(static_cast<const PointerType>(nullptr));
+    }
+
+    /*!
+    @brief get a reference value (implicit)
+
+    Implicit reference access to the internally stored JSON value. No copies
+    are made.
+
+    @warning Writing data to the referee of the result yields an undefined
+    state.
+
+    @tparam ReferenceType reference type; must be a reference to @ref array_t,
+    @ref object_t, @ref string_t, @ref boolean_t, @ref number_integer_t, or
+    @ref number_float_t. Enforced by static assertion.
+
+    @return reference to the internally stored JSON value if the requested
+    reference type @a ReferenceType fits to the JSON value; throws
+    type_error.303 otherwise
+
+    @throw type_error.303 in case passed type @a ReferenceType is incompatible
+    with the stored JSON value; see example below
+
+    @complexity Constant.
+
+    @liveexample{The example shows several calls to `get_ref()`.,get_ref}
+
+    @since version 1.1.0
+    */
+    template<typename ReferenceType, typename std::enable_if<
+                 std::is_reference<ReferenceType>::value, int>::type = 0>
+    ReferenceType get_ref()
+    {
+        // delegate call to get_ref_impl
+        return get_ref_impl<ReferenceType>(*this);
+    }
+
+    /*!
+    @brief get a reference value (implicit)
+    @copydoc get_ref()
+    */
+    template<typename ReferenceType, typename std::enable_if<
+                 std::is_reference<ReferenceType>::value and
+                 std::is_const<typename std::remove_reference<ReferenceType>::type>::value, int>::type = 0>
+    ReferenceType get_ref() const
+    {
+        // delegate call to get_ref_impl
+        return get_ref_impl<ReferenceType>(*this);
+    }
+
+    /*!
+    @brief get a value (implicit)
+
+    Implicit type conversion between the JSON value and a compatible value.
+    The call is realized by calling @ref get() const.
+
+    @tparam ValueType non-pointer type compatible to the JSON value, for
+    instance `int` for JSON integer numbers, `bool` for JSON booleans, or
+    `std::vector` types for JSON arrays. The character type of @ref string_t
+    as well as an initializer list of this type is excluded to avoid
+    ambiguities as these types implicitly convert to `std::string`.
+
+    @return copy of the JSON value, converted to type @a ValueType
+
+    @throw type_error.302 in case passed type @a ValueType is incompatible
+    to the JSON value type (e.g., the JSON value is of type boolean, but a
+    string is requested); see example below
+
+    @complexity Linear in the size of the JSON value.
+
+    @liveexample{The example below shows several conversions from JSON values
+    to other types. There a few things to note: (1) Floating-point numbers can
+    be converted to integers\, (2) A JSON array can be converted to a standard
+    `std::vector<short>`\, (3) A JSON object can be converted to C++
+    associative containers such as `std::unordered_map<std::string\,
+    json>`.,operator__ValueType}
+
+    @since version 1.0.0
+    */
+    template < typename ValueType, typename std::enable_if <
+                   not std::is_pointer<ValueType>::value and
+                   not std::is_same<ValueType, typename string_t::value_type>::value
+#ifndef _MSC_VER  // fix for issue #167 operator<< ambiguity under VS2015
+                   and not std::is_same<ValueType, std::initializer_list<typename string_t::value_type>>::value
+#endif
+#if defined(_MSC_VER) && defined(_HAS_CXX17) && _HAS_CXX17 == 1 // fix for issue #464
+                   and not std::is_same<ValueType, typename std::string_view>::value
+#endif
+                   , int >::type = 0 >
+    operator ValueType() const
+    {
+        // delegate the call to get<>() const
+        return get<ValueType>();
+    }
+
+    /// @}
+
+
+    ////////////////////
+    // element access //
+    ////////////////////
+
+    /// @name element access
+    /// Access to the JSON value.
+    /// @{
+
+    /*!
+    @brief access specified array element with bounds checking
+
+    Returns a reference to the element at specified location @a idx, with
+    bounds checking.
+
+    @param[in] idx  index of the element to access
+
+    @return reference to the element at index @a idx
+
+    @throw type_error.304 if the JSON value is not an array; in this case,
+    calling `at` with an index makes no sense. See example below.
+    @throw out_of_range.401 if the index @a idx is out of range of the array;
+    that is, `idx >= size()`. See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Constant.
+
+    @since version 1.0.0
+
+    @liveexample{The example below shows how array elements can be read and
+    written using `at()`. It also demonstrates the different exceptions that
+    can be thrown.,at__size_type}
+    */
+    reference at(size_type idx)
+    {
+        // at only works for arrays
+        if (is_array())
+        {
+            JSON_TRY
+            {
+                return m_value.array->at(idx);
+            }
+            JSON_CATCH (std::out_of_range&)
+            {
+                // create better exception explanation
+                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
+            }
+        }
+        else
+        {
+            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief access specified array element with bounds checking
+
+    Returns a const reference to the element at specified location @a idx,
+    with bounds checking.
+
+    @param[in] idx  index of the element to access
+
+    @return const reference to the element at index @a idx
+
+    @throw type_error.304 if the JSON value is not an array; in this case,
+    calling `at` with an index makes no sense. See example below.
+    @throw out_of_range.401 if the index @a idx is out of range of the array;
+    that is, `idx >= size()`. See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Constant.
+
+    @since version 1.0.0
+
+    @liveexample{The example below shows how array elements can be read using
+    `at()`. It also demonstrates the different exceptions that can be thrown.,
+    at__size_type_const}
+    */
+    const_reference at(size_type idx) const
+    {
+        // at only works for arrays
+        if (is_array())
+        {
+            JSON_TRY
+            {
+                return m_value.array->at(idx);
+            }
+            JSON_CATCH (std::out_of_range&)
+            {
+                // create better exception explanation
+                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
+            }
+        }
+        else
+        {
+            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief access specified object element with bounds checking
+
+    Returns a reference to the element at with specified key @a key, with
+    bounds checking.
+
+    @param[in] key  key of the element to access
+
+    @return reference to the element at key @a key
+
+    @throw type_error.304 if the JSON value is not an object; in this case,
+    calling `at` with a key makes no sense. See example below.
+    @throw out_of_range.403 if the key @a key is is not stored in the object;
+    that is, `find(key) == end()`. See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Logarithmic in the size of the container.
+
+    @sa @ref operator[](const typename object_t::key_type&) for unchecked
+    access by reference
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+
+    @liveexample{The example below shows how object elements can be read and
+    written using `at()`. It also demonstrates the different exceptions that
+    can be thrown.,at__object_t_key_type}
+    */
+    reference at(const typename object_t::key_type& key)
+    {
+        // at only works for objects
+        if (is_object())
+        {
+            JSON_TRY
+            {
+                return m_value.object->at(key);
+            }
+            JSON_CATCH (std::out_of_range&)
+            {
+                // create better exception explanation
+                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
+            }
+        }
+        else
+        {
+            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief access specified object element with bounds checking
+
+    Returns a const reference to the element at with specified key @a key,
+    with bounds checking.
+
+    @param[in] key  key of the element to access
+
+    @return const reference to the element at key @a key
+
+    @throw type_error.304 if the JSON value is not an object; in this case,
+    calling `at` with a key makes no sense. See example below.
+    @throw out_of_range.403 if the key @a key is is not stored in the object;
+    that is, `find(key) == end()`. See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Logarithmic in the size of the container.
+
+    @sa @ref operator[](const typename object_t::key_type&) for unchecked
+    access by reference
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+
+    @liveexample{The example below shows how object elements can be read using
+    `at()`. It also demonstrates the different exceptions that can be thrown.,
+    at__object_t_key_type_const}
+    */
+    const_reference at(const typename object_t::key_type& key) const
+    {
+        // at only works for objects
+        if (is_object())
+        {
+            JSON_TRY
+            {
+                return m_value.object->at(key);
+            }
+            JSON_CATCH (std::out_of_range&)
+            {
+                // create better exception explanation
+                JSON_THROW(out_of_range::create(403, "key '" + key + "' not found"));
+            }
+        }
+        else
+        {
+            JSON_THROW(type_error::create(304, "cannot use at() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief access specified array element
+
+    Returns a reference to the element at specified location @a idx.
+
+    @note If @a idx is beyond the range of the array (i.e., `idx >= size()`),
+    then the array is silently filled up with `null` values to make `idx` a
+    valid reference to the last stored element.
+
+    @param[in] idx  index of the element to access
+
+    @return reference to the element at index @a idx
+
+    @throw type_error.305 if the JSON value is not an array or null; in that
+    cases, using the [] operator with an index makes no sense.
+
+    @complexity Constant if @a idx is in the range of the array. Otherwise
+    linear in `idx - size()`.
+
+    @liveexample{The example below shows how array elements can be read and
+    written using `[]` operator. Note the addition of `null`
+    values.,operatorarray__size_type}
+
+    @since version 1.0.0
+    */
+    reference operator[](size_type idx)
+    {
+        // implicitly convert null value to an empty array
+        if (is_null())
+        {
+            m_type = value_t::array;
+            m_value.array = create<array_t>();
+            assert_invariant();
+        }
+
+        // operator[] only works for arrays
+        if (is_array())
+        {
+            // fill up array with null values if given idx is outside range
+            if (idx >= m_value.array->size())
+            {
+                m_value.array->insert(m_value.array->end(),
+                                      idx - m_value.array->size() + 1,
+                                      basic_json());
+            }
+
+            return m_value.array->operator[](idx);
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief access specified array element
+
+    Returns a const reference to the element at specified location @a idx.
+
+    @param[in] idx  index of the element to access
+
+    @return const reference to the element at index @a idx
+
+    @throw type_error.305 if the JSON value is not an array; in that cases,
+    using the [] operator with an index makes no sense.
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how array elements can be read using
+    the `[]` operator.,operatorarray__size_type_const}
+
+    @since version 1.0.0
+    */
+    const_reference operator[](size_type idx) const
+    {
+        // const operator[] only works for arrays
+        if (is_array())
+        {
+            return m_value.array->operator[](idx);
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief access specified object element
+
+    Returns a reference to the element at with specified key @a key.
+
+    @note If @a key is not found in the object, then it is silently added to
+    the object and filled with a `null` value to make `key` a valid reference.
+    In case the value was `null` before, it is converted to an object.
+
+    @param[in] key  key of the element to access
+
+    @return reference to the element at key @a key
+
+    @throw type_error.305 if the JSON value is not an object or null; in that
+    cases, using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read and
+    written using the `[]` operator.,operatorarray__key_type}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+    */
+    reference operator[](const typename object_t::key_type& key)
+    {
+        // implicitly convert null value to an empty object
+        if (is_null())
+        {
+            m_type = value_t::object;
+            m_value.object = create<object_t>();
+            assert_invariant();
+        }
+
+        // operator[] only works for objects
+        if (is_object())
+        {
+            return m_value.object->operator[](key);
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief read-only access specified object element
+
+    Returns a const reference to the element at with specified key @a key. No
+    bounds checking is performed.
+
+    @warning If the element with key @a key does not exist, the behavior is
+    undefined.
+
+    @param[in] key  key of the element to access
+
+    @return const reference to the element at key @a key
+
+    @pre The element with key @a key must exist. **This precondition is
+         enforced with an assertion.**
+
+    @throw type_error.305 if the JSON value is not an object; in that cases,
+    using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read using
+    the `[]` operator.,operatorarray__key_type_const}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+    */
+    const_reference operator[](const typename object_t::key_type& key) const
+    {
+        // const operator[] only works for objects
+        if (is_object())
+        {
+            assert(m_value.object->find(key) != m_value.object->end());
+            return m_value.object->find(key)->second;
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief access specified object element
+
+    Returns a reference to the element at with specified key @a key.
+
+    @note If @a key is not found in the object, then it is silently added to
+    the object and filled with a `null` value to make `key` a valid reference.
+    In case the value was `null` before, it is converted to an object.
+
+    @param[in] key  key of the element to access
+
+    @return reference to the element at key @a key
+
+    @throw type_error.305 if the JSON value is not an object or null; in that
+    cases, using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read and
+    written using the `[]` operator.,operatorarray__key_type}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+    */
+    template<typename T, std::size_t n>
+    reference operator[](T * (&key)[n])
+    {
+        return operator[](static_cast<const T>(key));
+    }
+
+    /*!
+    @brief read-only access specified object element
+
+    Returns a const reference to the element at with specified key @a key. No
+    bounds checking is performed.
+
+    @warning If the element with key @a key does not exist, the behavior is
+    undefined.
+
+    @note This function is required for compatibility reasons with Clang.
+
+    @param[in] key  key of the element to access
+
+    @return const reference to the element at key @a key
+
+    @throw type_error.305 if the JSON value is not an object; in that cases,
+    using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read using
+    the `[]` operator.,operatorarray__key_type_const}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.0.0
+    */
+    template<typename T, std::size_t n>
+    const_reference operator[](T * (&key)[n]) const
+    {
+        return operator[](static_cast<const T>(key));
+    }
+
+    /*!
+    @brief access specified object element
+
+    Returns a reference to the element at with specified key @a key.
+
+    @note If @a key is not found in the object, then it is silently added to
+    the object and filled with a `null` value to make `key` a valid reference.
+    In case the value was `null` before, it is converted to an object.
+
+    @param[in] key  key of the element to access
+
+    @return reference to the element at key @a key
+
+    @throw type_error.305 if the JSON value is not an object or null; in that
+    cases, using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read and
+    written using the `[]` operator.,operatorarray__key_type}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.1.0
+    */
+    template<typename T>
+    reference operator[](T* key)
+    {
+        // implicitly convert null to object
+        if (is_null())
+        {
+            m_type = value_t::object;
+            m_value = value_t::object;
+            assert_invariant();
+        }
+
+        // at only works for objects
+        if (is_object())
+        {
+            return m_value.object->operator[](key);
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief read-only access specified object element
+
+    Returns a const reference to the element at with specified key @a key. No
+    bounds checking is performed.
+
+    @warning If the element with key @a key does not exist, the behavior is
+    undefined.
+
+    @param[in] key  key of the element to access
+
+    @return const reference to the element at key @a key
+
+    @pre The element with key @a key must exist. **This precondition is
+         enforced with an assertion.**
+
+    @throw type_error.305 if the JSON value is not an object; in that cases,
+    using the [] operator with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be read using
+    the `[]` operator.,operatorarray__key_type_const}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref value() for access by value with a default value
+
+    @since version 1.1.0
+    */
+    template<typename T>
+    const_reference operator[](T* key) const
+    {
+        // at only works for objects
+        if (is_object())
+        {
+            assert(m_value.object->find(key) != m_value.object->end());
+            return m_value.object->find(key)->second;
+        }
+
+        JSON_THROW(type_error::create(305, "cannot use operator[] with " + type_name()));
+    }
+
+    /*!
+    @brief access specified object element with default value
+
+    Returns either a copy of an object's element at the specified key @a key
+    or a given default value if no element with key @a key exists.
+
+    The function is basically equivalent to executing
+    @code {.cpp}
+    try {
+        return at(key);
+    } catch(out_of_range) {
+        return default_value;
+    }
+    @endcode
+
+    @note Unlike @ref at(const typename object_t::key_type&), this function
+    does not throw if the given key @a key was not found.
+
+    @note Unlike @ref operator[](const typename object_t::key_type& key), this
+    function does not implicitly add an element to the position defined by @a
+    key. This function is furthermore also applicable to const objects.
+
+    @param[in] key  key of the element to access
+    @param[in] default_value  the value to return if @a key is not found
+
+    @tparam ValueType type compatible to JSON values, for instance `int` for
+    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
+    JSON arrays. Note the type of the expected value at @a key and the default
+    value @a default_value must be compatible.
+
+    @return copy of the element at key @a key or @a default_value if @a key
+    is not found
+
+    @throw type_error.306 if the JSON value is not an objec; in that cases,
+    using `value()` with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be queried
+    with a default value.,basic_json__value}
+
+    @sa @ref at(const typename object_t::key_type&) for access by reference
+    with range checking
+    @sa @ref operator[](const typename object_t::key_type&) for unchecked
+    access by reference
+
+    @since version 1.0.0
+    */
+    template<class ValueType, typename std::enable_if<
+                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
+    ValueType value(const typename object_t::key_type& key, ValueType default_value) const
+    {
+        // at only works for objects
+        if (is_object())
+        {
+            // if key is found, return value and given default value otherwise
+            const auto it = find(key);
+            if (it != end())
+            {
+                return *it;
+            }
+
+            return default_value;
+        }
+        else
+        {
+            JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief overload for a default value of type const char*
+    @copydoc basic_json::value(const typename object_t::key_type&, ValueType) const
+    */
+    string_t value(const typename object_t::key_type& key, const char* default_value) const
+    {
+        return value(key, string_t(default_value));
+    }
+
+    /*!
+    @brief access specified object element via JSON Pointer with default value
+
+    Returns either a copy of an object's element at the specified key @a key
+    or a given default value if no element with key @a key exists.
+
+    The function is basically equivalent to executing
+    @code {.cpp}
+    try {
+        return at(ptr);
+    } catch(out_of_range) {
+        return default_value;
+    }
+    @endcode
+
+    @note Unlike @ref at(const json_pointer&), this function does not throw
+    if the given key @a key was not found.
+
+    @param[in] ptr  a JSON pointer to the element to access
+    @param[in] default_value  the value to return if @a ptr found no value
+
+    @tparam ValueType type compatible to JSON values, for instance `int` for
+    JSON integer numbers, `bool` for JSON booleans, or `std::vector` types for
+    JSON arrays. Note the type of the expected value at @a key and the default
+    value @a default_value must be compatible.
+
+    @return copy of the element at key @a key or @a default_value if @a key
+    is not found
+
+    @throw type_error.306 if the JSON value is not an objec; in that cases,
+    using `value()` with a key makes no sense.
+
+    @complexity Logarithmic in the size of the container.
+
+    @liveexample{The example below shows how object elements can be queried
+    with a default value.,basic_json__value_ptr}
+
+    @sa @ref operator[](const json_pointer&) for unchecked access by reference
+
+    @since version 2.0.2
+    */
+    template<class ValueType, typename std::enable_if<
+                 std::is_convertible<basic_json_t, ValueType>::value, int>::type = 0>
+    ValueType value(const json_pointer& ptr, ValueType default_value) const
+    {
+        // at only works for objects
+        if (is_object())
+        {
+            // if pointer resolves a value, return it or use default value
+            JSON_TRY
+            {
+                return ptr.get_checked(this);
+            }
+            JSON_CATCH (out_of_range&)
+            {
+                return default_value;
+            }
+        }
+
+        JSON_THROW(type_error::create(306, "cannot use value() with " + type_name()));
+    }
+
+    /*!
+    @brief overload for a default value of type const char*
+    @copydoc basic_json::value(const json_pointer&, ValueType) const
+    */
+    string_t value(const json_pointer& ptr, const char* default_value) const
+    {
+        return value(ptr, string_t(default_value));
+    }
+
+    /*!
+    @brief access the first element
+
+    Returns a reference to the first element in the container. For a JSON
+    container `c`, the expression `c.front()` is equivalent to `*c.begin()`.
+
+    @return In case of a structured type (array or object), a reference to the
+    first element is returned. In case of number, string, or boolean values, a
+    reference to the value is returned.
+
+    @complexity Constant.
+
+    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
+    or an empty array or object (undefined behavior, **guarded by
+    assertions**).
+    @post The JSON value remains unchanged.
+
+    @throw invalid_iterator.214 when called on `null` value
+
+    @liveexample{The following code shows an example for `front()`.,front}
+
+    @sa @ref back() -- access the last element
+
+    @since version 1.0.0
+    */
+    reference front()
+    {
+        return *begin();
+    }
+
+    /*!
+    @copydoc basic_json::front()
+    */
+    const_reference front() const
+    {
+        return *cbegin();
+    }
+
+    /*!
+    @brief access the last element
+
+    Returns a reference to the last element in the container. For a JSON
+    container `c`, the expression `c.back()` is equivalent to
+    @code {.cpp}
+    auto tmp = c.end();
+    --tmp;
+    return *tmp;
+    @endcode
+
+    @return In case of a structured type (array or object), a reference to the
+    last element is returned. In case of number, string, or boolean values, a
+    reference to the value is returned.
+
+    @complexity Constant.
+
+    @pre The JSON value must not be `null` (would throw `std::out_of_range`)
+    or an empty array or object (undefined behavior, **guarded by
+    assertions**).
+    @post The JSON value remains unchanged.
+
+    @throw invalid_iterator.214 when called on a `null` value. See example
+    below.
+
+    @liveexample{The following code shows an example for `back()`.,back}
+
+    @sa @ref front() -- access the first element
+
+    @since version 1.0.0
+    */
+    reference back()
+    {
+        auto tmp = end();
+        --tmp;
+        return *tmp;
+    }
+
+    /*!
+    @copydoc basic_json::back()
+    */
+    const_reference back() const
+    {
+        auto tmp = cend();
+        --tmp;
+        return *tmp;
+    }
+
+    /*!
+    @brief remove element given an iterator
+
+    Removes the element specified by iterator @a pos. The iterator @a pos must
+    be valid and dereferenceable. Thus the `end()` iterator (which is valid,
+    but is not dereferenceable) cannot be used as a value for @a pos.
+
+    If called on a primitive type other than `null`, the resulting JSON value
+    will be `null`.
+
+    @param[in] pos iterator to the element to remove
+    @return Iterator following the last removed element. If the iterator @a
+    pos refers to the last element, the `end()` iterator is returned.
+
+    @tparam IteratorType an @ref iterator or @ref const_iterator
+
+    @post Invalidates iterators and references at or after the point of the
+    erase, including the `end()` iterator.
+
+    @throw type_error.307 if called on a `null` value; example: `"cannot use
+    erase() with null"`
+    @throw invalid_iterator.202 if called on an iterator which does not belong
+    to the current JSON value; example: `"iterator does not fit current
+    value"`
+    @throw invalid_iterator.205 if called on a primitive type with invalid
+    iterator (i.e., any iterator which is not `begin()`); example: `"iterator
+    out of range"`
+
+    @complexity The complexity depends on the type:
+    - objects: amortized constant
+    - arrays: linear in distance between @a pos and the end of the container
+    - strings: linear in the length of the string
+    - other types: constant
+
+    @liveexample{The example shows the result of `erase()` for different JSON
+    types.,erase__IteratorType}
+
+    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
+    the given range
+    @sa @ref erase(const typename object_t::key_type&) -- removes the element
+    from an object at the given key
+    @sa @ref erase(const size_type) -- removes the element from an array at
+    the given index
+
+    @since version 1.0.0
+    */
+    template<class IteratorType, typename std::enable_if<
+                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
+                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
+             = 0>
+    IteratorType erase(IteratorType pos)
+    {
+        // make sure iterator fits the current value
+        if (this != pos.m_object)
+        {
+            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
+        }
+
+        IteratorType result = end();
+
+        switch (m_type)
+        {
+            case value_t::boolean:
+            case value_t::number_float:
+            case value_t::number_integer:
+            case value_t::number_unsigned:
+            case value_t::string:
+            {
+                if (not pos.m_it.primitive_iterator.is_begin())
+                {
+                    JSON_THROW(invalid_iterator::create(205, "iterator out of range"));
+                }
+
+                if (is_string())
+                {
+                    AllocatorType<string_t> alloc;
+                    alloc.destroy(m_value.string);
+                    alloc.deallocate(m_value.string, 1);
+                    m_value.string = nullptr;
+                }
+
+                m_type = value_t::null;
+                assert_invariant();
+                break;
+            }
+
+            case value_t::object:
+            {
+                result.m_it.object_iterator = m_value.object->erase(pos.m_it.object_iterator);
+                break;
+            }
+
+            case value_t::array:
+            {
+                result.m_it.array_iterator = m_value.array->erase(pos.m_it.array_iterator);
+                break;
+            }
+
+            default:
+            {
+                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
+            }
+        }
+
+        return result;
+    }
+
+    /*!
+    @brief remove elements given an iterator range
+
+    Removes the element specified by the range `[first; last)`. The iterator
+    @a first does not need to be dereferenceable if `first == last`: erasing
+    an empty range is a no-op.
+
+    If called on a primitive type other than `null`, the resulting JSON value
+    will be `null`.
+
+    @param[in] first iterator to the beginning of the range to remove
+    @param[in] last iterator past the end of the range to remove
+    @return Iterator following the last removed element. If the iterator @a
+    second refers to the last element, the `end()` iterator is returned.
+
+    @tparam IteratorType an @ref iterator or @ref const_iterator
+
+    @post Invalidates iterators and references at or after the point of the
+    erase, including the `end()` iterator.
+
+    @throw type_error.307 if called on a `null` value; example: `"cannot use
+    erase() with null"`
+    @throw invalid_iterator.203 if called on iterators which does not belong
+    to the current JSON value; example: `"iterators do not fit current value"`
+    @throw invalid_iterator.204 if called on a primitive type with invalid
+    iterators (i.e., if `first != begin()` and `last != end()`); example:
+    `"iterators out of range"`
+
+    @complexity The complexity depends on the type:
+    - objects: `log(size()) + std::distance(first, last)`
+    - arrays: linear in the distance between @a first and @a last, plus linear
+      in the distance between @a last and end of the container
+    - strings: linear in the length of the string
+    - other types: constant
+
+    @liveexample{The example shows the result of `erase()` for different JSON
+    types.,erase__IteratorType_IteratorType}
+
+    @sa @ref erase(IteratorType) -- removes the element at a given position
+    @sa @ref erase(const typename object_t::key_type&) -- removes the element
+    from an object at the given key
+    @sa @ref erase(const size_type) -- removes the element from an array at
+    the given index
+
+    @since version 1.0.0
+    */
+    template<class IteratorType, typename std::enable_if<
+                 std::is_same<IteratorType, typename basic_json_t::iterator>::value or
+                 std::is_same<IteratorType, typename basic_json_t::const_iterator>::value, int>::type
+             = 0>
+    IteratorType erase(IteratorType first, IteratorType last)
+    {
+        // make sure iterator fits the current value
+        if (this != first.m_object or this != last.m_object)
+        {
+            JSON_THROW(invalid_iterator::create(203, "iterators do not fit current value"));
+        }
+
+        IteratorType result = end();
+
+        switch (m_type)
+        {
+            case value_t::boolean:
+            case value_t::number_float:
+            case value_t::number_integer:
+            case value_t::number_unsigned:
+            case value_t::string:
+            {
+                if (not first.m_it.primitive_iterator.is_begin() or not last.m_it.primitive_iterator.is_end())
+                {
+                    JSON_THROW(invalid_iterator::create(204, "iterators out of range"));
+                }
+
+                if (is_string())
+                {
+                    AllocatorType<string_t> alloc;
+                    alloc.destroy(m_value.string);
+                    alloc.deallocate(m_value.string, 1);
+                    m_value.string = nullptr;
+                }
+
+                m_type = value_t::null;
+                assert_invariant();
+                break;
+            }
+
+            case value_t::object:
+            {
+                result.m_it.object_iterator = m_value.object->erase(first.m_it.object_iterator,
+                                              last.m_it.object_iterator);
+                break;
+            }
+
+            case value_t::array:
+            {
+                result.m_it.array_iterator = m_value.array->erase(first.m_it.array_iterator,
+                                             last.m_it.array_iterator);
+                break;
+            }
+
+            default:
+            {
+                JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
+            }
+        }
+
+        return result;
+    }
+
+    /*!
+    @brief remove element from a JSON object given a key
+
+    Removes elements from a JSON object with the key value @a key.
+
+    @param[in] key value of the elements to remove
+
+    @return Number of elements removed. If @a ObjectType is the default
+    `std::map` type, the return value will always be `0` (@a key was not
+    found) or `1` (@a key was found).
+
+    @post References and iterators to the erased elements are invalidated.
+    Other references and iterators are not affected.
+
+    @throw type_error.307 when called on a type other than JSON object;
+    example: `"cannot use erase() with null"`
+
+    @complexity `log(size()) + count(key)`
+
+    @liveexample{The example shows the effect of `erase()`.,erase__key_type}
+
+    @sa @ref erase(IteratorType) -- removes the element at a given position
+    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
+    the given range
+    @sa @ref erase(const size_type) -- removes the element from an array at
+    the given index
+
+    @since version 1.0.0
+    */
+    size_type erase(const typename object_t::key_type& key)
+    {
+        // this erase only works for objects
+        if (is_object())
+        {
+            return m_value.object->erase(key);
+        }
+
+        JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
+    }
+
+    /*!
+    @brief remove element from a JSON array given an index
+
+    Removes element from a JSON array at the index @a idx.
+
+    @param[in] idx index of the element to remove
+
+    @throw type_error.307 when called on a type other than JSON object;
+    example: `"cannot use erase() with null"`
+    @throw out_of_range.401 when `idx >= size()`; example: `"array index 17
+    is out of range"`
+
+    @complexity Linear in distance between @a idx and the end of the container.
+
+    @liveexample{The example shows the effect of `erase()`.,erase__size_type}
+
+    @sa @ref erase(IteratorType) -- removes the element at a given position
+    @sa @ref erase(IteratorType, IteratorType) -- removes the elements in
+    the given range
+    @sa @ref erase(const typename object_t::key_type&) -- removes the element
+    from an object at the given key
+
+    @since version 1.0.0
+    */
+    void erase(const size_type idx)
+    {
+        // this erase only works for arrays
+        if (is_array())
+        {
+            if (idx >= size())
+            {
+                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
+            }
+
+            m_value.array->erase(m_value.array->begin() + static_cast<difference_type>(idx));
+        }
+        else
+        {
+            JSON_THROW(type_error::create(307, "cannot use erase() with " + type_name()));
+        }
+    }
+
+    /// @}
+
+
+    ////////////
+    // lookup //
+    ////////////
+
+    /// @name lookup
+    /// @{
+
+    /*!
+    @brief find an element in a JSON object
+
+    Finds an element in a JSON object with key equivalent to @a key. If the
+    element is not found or the JSON value is not an object, end() is
+    returned.
+
+    @note This method always returns @ref end() when executed on a JSON type
+          that is not an object.
+
+    @param[in] key key value of the element to search for
+
+    @return Iterator to an element with key equivalent to @a key. If no such
+    element is found or the JSON value is not an object, past-the-end (see
+    @ref end()) iterator is returned.
+
+    @complexity Logarithmic in the size of the JSON object.
+
+    @liveexample{The example shows how `find()` is used.,find__key_type}
+
+    @since version 1.0.0
+    */
+    iterator find(typename object_t::key_type key)
+    {
+        auto result = end();
+
+        if (is_object())
+        {
+            result.m_it.object_iterator = m_value.object->find(key);
+        }
+
+        return result;
+    }
+
+    /*!
+    @brief find an element in a JSON object
+    @copydoc find(typename object_t::key_type)
+    */
+    const_iterator find(typename object_t::key_type key) const
+    {
+        auto result = cend();
+
+        if (is_object())
+        {
+            result.m_it.object_iterator = m_value.object->find(key);
+        }
+
+        return result;
+    }
+
+    /*!
+    @brief returns the number of occurrences of a key in a JSON object
+
+    Returns the number of elements with key @a key. If ObjectType is the
+    default `std::map` type, the return value will always be `0` (@a key was
+    not found) or `1` (@a key was found).
+
+    @note This method always returns `0` when executed on a JSON type that is
+          not an object.
+
+    @param[in] key key value of the element to count
+
+    @return Number of elements with key @a key. If the JSON value is not an
+    object, the return value will be `0`.
+
+    @complexity Logarithmic in the size of the JSON object.
+
+    @liveexample{The example shows how `count()` is used.,count}
+
+    @since version 1.0.0
+    */
+    size_type count(typename object_t::key_type key) const
+    {
+        // return 0 for all nonobject types
+        return is_object() ? m_value.object->count(key) : 0;
+    }
+
+    /// @}
+
+
+    ///////////////
+    // iterators //
+    ///////////////
+
+    /// @name iterators
+    /// @{
+
+    /*!
+    @brief returns an iterator to the first element
+
+    Returns an iterator to the first element.
+
+    @image html range-begin-end.svg "Illustration from cppreference.com"
+
+    @return iterator to the first element
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+
+    @liveexample{The following code shows an example for `begin()`.,begin}
+
+    @sa @ref cbegin() -- returns a const iterator to the beginning
+    @sa @ref end() -- returns an iterator to the end
+    @sa @ref cend() -- returns a const iterator to the end
+
+    @since version 1.0.0
+    */
+    iterator begin() noexcept
+    {
+        iterator result(this);
+        result.set_begin();
+        return result;
+    }
+
+    /*!
+    @copydoc basic_json::cbegin()
+    */
+    const_iterator begin() const noexcept
+    {
+        return cbegin();
+    }
+
+    /*!
+    @brief returns a const iterator to the first element
+
+    Returns a const iterator to the first element.
+
+    @image html range-begin-end.svg "Illustration from cppreference.com"
+
+    @return const iterator to the first element
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `const_cast<const basic_json&>(*this).begin()`.
+
+    @liveexample{The following code shows an example for `cbegin()`.,cbegin}
+
+    @sa @ref begin() -- returns an iterator to the beginning
+    @sa @ref end() -- returns an iterator to the end
+    @sa @ref cend() -- returns a const iterator to the end
+
+    @since version 1.0.0
+    */
+    const_iterator cbegin() const noexcept
+    {
+        const_iterator result(this);
+        result.set_begin();
+        return result;
+    }
+
+    /*!
+    @brief returns an iterator to one past the last element
+
+    Returns an iterator to one past the last element.
+
+    @image html range-begin-end.svg "Illustration from cppreference.com"
+
+    @return iterator one past the last element
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+
+    @liveexample{The following code shows an example for `end()`.,end}
+
+    @sa @ref cend() -- returns a const iterator to the end
+    @sa @ref begin() -- returns an iterator to the beginning
+    @sa @ref cbegin() -- returns a const iterator to the beginning
+
+    @since version 1.0.0
+    */
+    iterator end() noexcept
+    {
+        iterator result(this);
+        result.set_end();
+        return result;
+    }
+
+    /*!
+    @copydoc basic_json::cend()
+    */
+    const_iterator end() const noexcept
+    {
+        return cend();
+    }
+
+    /*!
+    @brief returns a const iterator to one past the last element
+
+    Returns a const iterator to one past the last element.
+
+    @image html range-begin-end.svg "Illustration from cppreference.com"
+
+    @return const iterator one past the last element
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `const_cast<const basic_json&>(*this).end()`.
+
+    @liveexample{The following code shows an example for `cend()`.,cend}
+
+    @sa @ref end() -- returns an iterator to the end
+    @sa @ref begin() -- returns an iterator to the beginning
+    @sa @ref cbegin() -- returns a const iterator to the beginning
+
+    @since version 1.0.0
+    */
+    const_iterator cend() const noexcept
+    {
+        const_iterator result(this);
+        result.set_end();
+        return result;
+    }
+
+    /*!
+    @brief returns an iterator to the reverse-beginning
+
+    Returns an iterator to the reverse-beginning; that is, the last element.
+
+    @image html range-rbegin-rend.svg "Illustration from cppreference.com"
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `reverse_iterator(end())`.
+
+    @liveexample{The following code shows an example for `rbegin()`.,rbegin}
+
+    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
+    @sa @ref rend() -- returns a reverse iterator to the end
+    @sa @ref crend() -- returns a const reverse iterator to the end
+
+    @since version 1.0.0
+    */
+    reverse_iterator rbegin() noexcept
+    {
+        return reverse_iterator(end());
+    }
+
+    /*!
+    @copydoc basic_json::crbegin()
+    */
+    const_reverse_iterator rbegin() const noexcept
+    {
+        return crbegin();
+    }
+
+    /*!
+    @brief returns an iterator to the reverse-end
+
+    Returns an iterator to the reverse-end; that is, one before the first
+    element.
+
+    @image html range-rbegin-rend.svg "Illustration from cppreference.com"
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `reverse_iterator(begin())`.
+
+    @liveexample{The following code shows an example for `rend()`.,rend}
+
+    @sa @ref crend() -- returns a const reverse iterator to the end
+    @sa @ref rbegin() -- returns a reverse iterator to the beginning
+    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
+
+    @since version 1.0.0
+    */
+    reverse_iterator rend() noexcept
+    {
+        return reverse_iterator(begin());
+    }
+
+    /*!
+    @copydoc basic_json::crend()
+    */
+    const_reverse_iterator rend() const noexcept
+    {
+        return crend();
+    }
+
+    /*!
+    @brief returns a const reverse iterator to the last element
+
+    Returns a const iterator to the reverse-beginning; that is, the last
+    element.
+
+    @image html range-rbegin-rend.svg "Illustration from cppreference.com"
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `const_cast<const basic_json&>(*this).rbegin()`.
+
+    @liveexample{The following code shows an example for `crbegin()`.,crbegin}
+
+    @sa @ref rbegin() -- returns a reverse iterator to the beginning
+    @sa @ref rend() -- returns a reverse iterator to the end
+    @sa @ref crend() -- returns a const reverse iterator to the end
+
+    @since version 1.0.0
+    */
+    const_reverse_iterator crbegin() const noexcept
+    {
+        return const_reverse_iterator(cend());
+    }
+
+    /*!
+    @brief returns a const reverse iterator to one before the first
+
+    Returns a const reverse iterator to the reverse-end; that is, one before
+    the first element.
+
+    @image html range-rbegin-rend.svg "Illustration from cppreference.com"
+
+    @complexity Constant.
+
+    @requirement This function helps `basic_json` satisfying the
+    [ReversibleContainer](http://en.cppreference.com/w/cpp/concept/ReversibleContainer)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `const_cast<const basic_json&>(*this).rend()`.
+
+    @liveexample{The following code shows an example for `crend()`.,crend}
+
+    @sa @ref rend() -- returns a reverse iterator to the end
+    @sa @ref rbegin() -- returns a reverse iterator to the beginning
+    @sa @ref crbegin() -- returns a const reverse iterator to the beginning
+
+    @since version 1.0.0
+    */
+    const_reverse_iterator crend() const noexcept
+    {
+        return const_reverse_iterator(cbegin());
+    }
+
+  private:
+    // forward declaration
+    template<typename IteratorType> class iteration_proxy;
+
+  public:
+    /*!
+    @brief wrapper to access iterator member functions in range-based for
+
+    This function allows to access @ref iterator::key() and @ref
+    iterator::value() during range-based for loops. In these loops, a
+    reference to the JSON values is returned, so there is no access to the
+    underlying iterator.
+
+    @note The name of this function is not yet final and may change in the
+    future.
+    */
+    static iteration_proxy<iterator> iterator_wrapper(reference cont)
+    {
+        return iteration_proxy<iterator>(cont);
+    }
+
+    /*!
+    @copydoc iterator_wrapper(reference)
+    */
+    static iteration_proxy<const_iterator> iterator_wrapper(const_reference cont)
+    {
+        return iteration_proxy<const_iterator>(cont);
+    }
+
+    /// @}
+
+
+    //////////////
+    // capacity //
+    //////////////
+
+    /// @name capacity
+    /// @{
+
+    /*!
+    @brief checks whether the container is empty
+
+    Checks if a JSON value has no elements.
+
+    @return The return value depends on the different types and is
+            defined as follows:
+            Value type  | return value
+            ----------- | -------------
+            null        | `true`
+            boolean     | `false`
+            string      | `false`
+            number      | `false`
+            object      | result of function `object_t::empty()`
+            array       | result of function `array_t::empty()`
+
+    @note This function does not return whether a string stored as JSON value
+    is empty - it returns whether the JSON container itself is empty which is
+    false in the case of a string.
+
+    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
+    the Container concept; that is, their `empty()` functions have constant
+    complexity.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `begin() == end()`.
+
+    @liveexample{The following code uses `empty()` to check if a JSON
+    object contains any elements.,empty}
+
+    @sa @ref size() -- returns the number of elements
+
+    @since version 1.0.0
+    */
+    bool empty() const noexcept
+    {
+        switch (m_type)
+        {
+            case value_t::null:
+            {
+                // null values are empty
+                return true;
+            }
+
+            case value_t::array:
+            {
+                // delegate call to array_t::empty()
+                return m_value.array->empty();
+            }
+
+            case value_t::object:
+            {
+                // delegate call to object_t::empty()
+                return m_value.object->empty();
+            }
+
+            default:
+            {
+                // all other types are nonempty
+                return false;
+            }
+        }
+    }
+
+    /*!
+    @brief returns the number of elements
+
+    Returns the number of elements in a JSON value.
+
+    @return The return value depends on the different types and is
+            defined as follows:
+            Value type  | return value
+            ----------- | -------------
+            null        | `0`
+            boolean     | `1`
+            string      | `1`
+            number      | `1`
+            object      | result of function object_t::size()
+            array       | result of function array_t::size()
+
+    @note This function does not return the length of a string stored as JSON
+    value - it returns the number of elements in the JSON value which is 1 in
+    the case of a string.
+
+    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
+    the Container concept; that is, their size() functions have constant
+    complexity.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of `std::distance(begin(), end())`.
+
+    @liveexample{The following code calls `size()` on the different value
+    types.,size}
+
+    @sa @ref empty() -- checks whether the container is empty
+    @sa @ref max_size() -- returns the maximal number of elements
+
+    @since version 1.0.0
+    */
+    size_type size() const noexcept
+    {
+        switch (m_type)
+        {
+            case value_t::null:
+            {
+                // null values are empty
+                return 0;
+            }
+
+            case value_t::array:
+            {
+                // delegate call to array_t::size()
+                return m_value.array->size();
+            }
+
+            case value_t::object:
+            {
+                // delegate call to object_t::size()
+                return m_value.object->size();
+            }
+
+            default:
+            {
+                // all other types have size 1
+                return 1;
+            }
+        }
+    }
+
+    /*!
+    @brief returns the maximum possible number of elements
+
+    Returns the maximum number of elements a JSON value is able to hold due to
+    system or library implementation limitations, i.e. `std::distance(begin(),
+    end())` for the JSON value.
+
+    @return The return value depends on the different types and is
+            defined as follows:
+            Value type  | return value
+            ----------- | -------------
+            null        | `0` (same as `size()`)
+            boolean     | `1` (same as `size()`)
+            string      | `1` (same as `size()`)
+            number      | `1` (same as `size()`)
+            object      | result of function `object_t::max_size()`
+            array       | result of function `array_t::max_size()`
+
+    @complexity Constant, as long as @ref array_t and @ref object_t satisfy
+    the Container concept; that is, their `max_size()` functions have constant
+    complexity.
+
+    @requirement This function helps `basic_json` satisfying the
+    [Container](http://en.cppreference.com/w/cpp/concept/Container)
+    requirements:
+    - The complexity is constant.
+    - Has the semantics of returning `b.size()` where `b` is the largest
+      possible JSON value.
+
+    @liveexample{The following code calls `max_size()` on the different value
+    types. Note the output is implementation specific.,max_size}
+
+    @sa @ref size() -- returns the number of elements
+
+    @since version 1.0.0
+    */
+    size_type max_size() const noexcept
+    {
+        switch (m_type)
+        {
+            case value_t::array:
+            {
+                // delegate call to array_t::max_size()
+                return m_value.array->max_size();
+            }
+
+            case value_t::object:
+            {
+                // delegate call to object_t::max_size()
+                return m_value.object->max_size();
+            }
+
+            default:
+            {
+                // all other types have max_size() == size()
+                return size();
+            }
+        }
+    }
+
+    /// @}
+
+
+    ///////////////
+    // modifiers //
+    ///////////////
+
+    /// @name modifiers
+    /// @{
+
+    /*!
+    @brief clears the contents
+
+    Clears the content of a JSON value and resets it to the default value as
+    if @ref basic_json(value_t) would have been called:
+
+    Value type  | initial value
+    ----------- | -------------
+    null        | `null`
+    boolean     | `false`
+    string      | `""`
+    number      | `0`
+    object      | `{}`
+    array       | `[]`
+
+    @complexity Linear in the size of the JSON value.
+
+    @liveexample{The example below shows the effect of `clear()` to different
+    JSON types.,clear}
+
+    @since version 1.0.0
+    */
+    void clear() noexcept
+    {
+        switch (m_type)
+        {
+            case value_t::number_integer:
+            {
+                m_value.number_integer = 0;
+                break;
+            }
+
+            case value_t::number_unsigned:
+            {
+                m_value.number_unsigned = 0;
+                break;
+            }
+
+            case value_t::number_float:
+            {
+                m_value.number_float = 0.0;
+                break;
+            }
+
+            case value_t::boolean:
+            {
+                m_value.boolean = false;
+                break;
+            }
+
+            case value_t::string:
+            {
+                m_value.string->clear();
+                break;
+            }
+
+            case value_t::array:
+            {
+                m_value.array->clear();
+                break;
+            }
+
+            case value_t::object:
+            {
+                m_value.object->clear();
+                break;
+            }
+
+            default:
+            {
+                break;
+            }
+        }
+    }
+
+    /*!
+    @brief add an object to an array
+
+    Appends the given element @a val to the end of the JSON value. If the
+    function is called on a JSON null value, an empty array is created before
+    appending @a val.
+
+    @param[in] val the value to add to the JSON array
+
+    @throw type_error.308 when called on a type other than JSON array or
+    null; example: `"cannot use push_back() with number"`
+
+    @complexity Amortized constant.
+
+    @liveexample{The example shows how `push_back()` and `+=` can be used to
+    add elements to a JSON array. Note how the `null` value was silently
+    converted to a JSON array.,push_back}
+
+    @since version 1.0.0
+    */
+    void push_back(basic_json&& val)
+    {
+        // push_back only works for null objects or arrays
+        if (not(is_null() or is_array()))
+        {
+            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
+        }
+
+        // transform null object into an array
+        if (is_null())
+        {
+            m_type = value_t::array;
+            m_value = value_t::array;
+            assert_invariant();
+        }
+
+        // add element to array (move semantics)
+        m_value.array->push_back(std::move(val));
+        // invalidate object
+        val.m_type = value_t::null;
+    }
+
+    /*!
+    @brief add an object to an array
+    @copydoc push_back(basic_json&&)
+    */
+    reference operator+=(basic_json&& val)
+    {
+        push_back(std::move(val));
+        return *this;
+    }
+
+    /*!
+    @brief add an object to an array
+    @copydoc push_back(basic_json&&)
+    */
+    void push_back(const basic_json& val)
+    {
+        // push_back only works for null objects or arrays
+        if (not(is_null() or is_array()))
+        {
+            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
+        }
+
+        // transform null object into an array
+        if (is_null())
+        {
+            m_type = value_t::array;
+            m_value = value_t::array;
+            assert_invariant();
+        }
+
+        // add element to array
+        m_value.array->push_back(val);
+    }
+
+    /*!
+    @brief add an object to an array
+    @copydoc push_back(basic_json&&)
+    */
+    reference operator+=(const basic_json& val)
+    {
+        push_back(val);
+        return *this;
+    }
+
+    /*!
+    @brief add an object to an object
+
+    Inserts the given element @a val to the JSON object. If the function is
+    called on a JSON null value, an empty object is created before inserting
+    @a val.
+
+    @param[in] val the value to add to the JSON object
+
+    @throw type_error.308 when called on a type other than JSON object or
+    null; example: `"cannot use push_back() with number"`
+
+    @complexity Logarithmic in the size of the container, O(log(`size()`)).
+
+    @liveexample{The example shows how `push_back()` and `+=` can be used to
+    add elements to a JSON object. Note how the `null` value was silently
+    converted to a JSON object.,push_back__object_t__value}
+
+    @since version 1.0.0
+    */
+    void push_back(const typename object_t::value_type& val)
+    {
+        // push_back only works for null objects or objects
+        if (not(is_null() or is_object()))
+        {
+            JSON_THROW(type_error::create(308, "cannot use push_back() with " + type_name()));
+        }
+
+        // transform null object into an object
+        if (is_null())
+        {
+            m_type = value_t::object;
+            m_value = value_t::object;
+            assert_invariant();
+        }
+
+        // add element to array
+        m_value.object->insert(val);
+    }
+
+    /*!
+    @brief add an object to an object
+    @copydoc push_back(const typename object_t::value_type&)
+    */
+    reference operator+=(const typename object_t::value_type& val)
+    {
+        push_back(val);
+        return *this;
+    }
+
+    /*!
+    @brief add an object to an object
+
+    This function allows to use `push_back` with an initializer list. In case
+
+    1. the current value is an object,
+    2. the initializer list @a init contains only two elements, and
+    3. the first element of @a init is a string,
+
+    @a init is converted into an object element and added using
+    @ref push_back(const typename object_t::value_type&). Otherwise, @a init
+    is converted to a JSON value and added using @ref push_back(basic_json&&).
+
+    @param[in] init  an initializer list
+
+    @complexity Linear in the size of the initializer list @a init.
+
+    @note This function is required to resolve an ambiguous overload error,
+          because pairs like `{"key", "value"}` can be both interpreted as
+          `object_t::value_type` or `std::initializer_list<basic_json>`, see
+          https://github.com/nlohmann/json/issues/235 for more information.
+
+    @liveexample{The example shows how initializer lists are treated as
+    objects when possible.,push_back__initializer_list}
+    */
+    void push_back(std::initializer_list<basic_json> init)
+    {
+        if (is_object() and init.size() == 2 and init.begin()->is_string())
+        {
+            const string_t key = *init.begin();
+            push_back(typename object_t::value_type(key, *(init.begin() + 1)));
+        }
+        else
+        {
+            push_back(basic_json(init));
+        }
+    }
+
+    /*!
+    @brief add an object to an object
+    @copydoc push_back(std::initializer_list<basic_json>)
+    */
+    reference operator+=(std::initializer_list<basic_json> init)
+    {
+        push_back(init);
+        return *this;
+    }
+
+    /*!
+    @brief add an object to an array
+
+    Creates a JSON value from the passed parameters @a args to the end of the
+    JSON value. If the function is called on a JSON null value, an empty array
+    is created before appending the value created from @a args.
+
+    @param[in] args arguments to forward to a constructor of @ref basic_json
+    @tparam Args compatible types to create a @ref basic_json object
+
+    @throw type_error.311 when called on a type other than JSON array or
+    null; example: `"cannot use emplace_back() with number"`
+
+    @complexity Amortized constant.
+
+    @liveexample{The example shows how `push_back()` can be used to add
+    elements to a JSON array. Note how the `null` value was silently converted
+    to a JSON array.,emplace_back}
+
+    @since version 2.0.8
+    */
+    template<class... Args>
+    void emplace_back(Args&& ... args)
+    {
+        // emplace_back only works for null objects or arrays
+        if (not(is_null() or is_array()))
+        {
+            JSON_THROW(type_error::create(311, "cannot use emplace_back() with " + type_name()));
+        }
+
+        // transform null object into an array
+        if (is_null())
+        {
+            m_type = value_t::array;
+            m_value = value_t::array;
+            assert_invariant();
+        }
+
+        // add element to array (perfect forwarding)
+        m_value.array->emplace_back(std::forward<Args>(args)...);
+    }
+
+    /*!
+    @brief add an object to an object if key does not exist
+
+    Inserts a new element into a JSON object constructed in-place with the
+    given @a args if there is no element with the key in the container. If the
+    function is called on a JSON null value, an empty object is created before
+    appending the value created from @a args.
+
+    @param[in] args arguments to forward to a constructor of @ref basic_json
+    @tparam Args compatible types to create a @ref basic_json object
+
+    @return a pair consisting of an iterator to the inserted element, or the
+            already-existing element if no insertion happened, and a bool
+            denoting whether the insertion took place.
+
+    @throw type_error.311 when called on a type other than JSON object or
+    null; example: `"cannot use emplace() with number"`
+
+    @complexity Logarithmic in the size of the container, O(log(`size()`)).
+
+    @liveexample{The example shows how `emplace()` can be used to add elements
+    to a JSON object. Note how the `null` value was silently converted to a
+    JSON object. Further note how no value is added if there was already one
+    value stored with the same key.,emplace}
+
+    @since version 2.0.8
+    */
+    template<class... Args>
+    std::pair<iterator, bool> emplace(Args&& ... args)
+    {
+        // emplace only works for null objects or arrays
+        if (not(is_null() or is_object()))
+        {
+            JSON_THROW(type_error::create(311, "cannot use emplace() with " + type_name()));
+        }
+
+        // transform null object into an object
+        if (is_null())
+        {
+            m_type = value_t::object;
+            m_value = value_t::object;
+            assert_invariant();
+        }
+
+        // add element to array (perfect forwarding)
+        auto res = m_value.object->emplace(std::forward<Args>(args)...);
+        // create result iterator and set iterator to the result of emplace
+        auto it = begin();
+        it.m_it.object_iterator = res.first;
+
+        // return pair of iterator and boolean
+        return {it, res.second};
+    }
+
+    /*!
+    @brief inserts element
+
+    Inserts element @a val before iterator @a pos.
+
+    @param[in] pos iterator before which the content will be inserted; may be
+    the end() iterator
+    @param[in] val element to insert
+    @return iterator pointing to the inserted @a val.
+
+    @throw type_error.309 if called on JSON values other than arrays;
+    example: `"cannot use insert() with string"`
+    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
+    example: `"iterator does not fit current value"`
+
+    @complexity Constant plus linear in the distance between @a pos and end of
+    the container.
+
+    @liveexample{The example shows how `insert()` is used.,insert}
+
+    @since version 1.0.0
+    */
+    iterator insert(const_iterator pos, const basic_json& val)
+    {
+        // insert only works for arrays
+        if (is_array())
+        {
+            // check if iterator pos fits to this JSON value
+            if (pos.m_object != this)
+            {
+                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
+            }
+
+            // insert to array and return iterator
+            iterator result(this);
+            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, val);
+            return result;
+        }
+
+        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
+    }
+
+    /*!
+    @brief inserts element
+    @copydoc insert(const_iterator, const basic_json&)
+    */
+    iterator insert(const_iterator pos, basic_json&& val)
+    {
+        return insert(pos, val);
+    }
+
+    /*!
+    @brief inserts elements
+
+    Inserts @a cnt copies of @a val before iterator @a pos.
+
+    @param[in] pos iterator before which the content will be inserted; may be
+    the end() iterator
+    @param[in] cnt number of copies of @a val to insert
+    @param[in] val element to insert
+    @return iterator pointing to the first element inserted, or @a pos if
+    `cnt==0`
+
+    @throw type_error.309 if called on JSON values other than arrays; example:
+    `"cannot use insert() with string"`
+    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
+    example: `"iterator does not fit current value"`
+
+    @complexity Linear in @a cnt plus linear in the distance between @a pos
+    and end of the container.
+
+    @liveexample{The example shows how `insert()` is used.,insert__count}
+
+    @since version 1.0.0
+    */
+    iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
+    {
+        // insert only works for arrays
+        if (is_array())
+        {
+            // check if iterator pos fits to this JSON value
+            if (pos.m_object != this)
+            {
+                JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
+            }
+
+            // insert to array and return iterator
+            iterator result(this);
+            result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, cnt, val);
+            return result;
+        }
+
+        JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
+    }
+
+    /*!
+    @brief inserts elements
+
+    Inserts elements from range `[first, last)` before iterator @a pos.
+
+    @param[in] pos iterator before which the content will be inserted; may be
+    the end() iterator
+    @param[in] first begin of the range of elements to insert
+    @param[in] last end of the range of elements to insert
+
+    @throw type_error.309 if called on JSON values other than arrays; example:
+    `"cannot use insert() with string"`
+    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
+    example: `"iterator does not fit current value"`
+    @throw invalid_iterator.210 if @a first and @a last do not belong to the
+    same JSON value; example: `"iterators do not fit"`
+    @throw invalid_iterator.211 if @a first or @a last are iterators into
+    container for which insert is called; example: `"passed iterators may not
+    belong to container"`
+
+    @return iterator pointing to the first element inserted, or @a pos if
+    `first==last`
+
+    @complexity Linear in `std::distance(first, last)` plus linear in the
+    distance between @a pos and end of the container.
+
+    @liveexample{The example shows how `insert()` is used.,insert__range}
+
+    @since version 1.0.0
+    */
+    iterator insert(const_iterator pos, const_iterator first, const_iterator last)
+    {
+        // insert only works for arrays
+        if (not is_array())
+        {
+            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
+        }
+
+        // check if iterator pos fits to this JSON value
+        if (pos.m_object != this)
+        {
+            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
+        }
+
+        // check if range iterators belong to the same JSON object
+        if (first.m_object != last.m_object)
+        {
+            JSON_THROW(invalid_iterator::create(210, "iterators do not fit"));
+        }
+
+        if (first.m_object == this or last.m_object == this)
+        {
+            JSON_THROW(invalid_iterator::create(211, "passed iterators may not belong to container"));
+        }
+
+        // insert to array and return iterator
+        iterator result(this);
+        result.m_it.array_iterator = m_value.array->insert(
+                                         pos.m_it.array_iterator,
+                                         first.m_it.array_iterator,
+                                         last.m_it.array_iterator);
+        return result;
+    }
+
+    /*!
+    @brief inserts elements
+
+    Inserts elements from initializer list @a ilist before iterator @a pos.
+
+    @param[in] pos iterator before which the content will be inserted; may be
+    the end() iterator
+    @param[in] ilist initializer list to insert the values from
+
+    @throw type_error.309 if called on JSON values other than arrays; example:
+    `"cannot use insert() with string"`
+    @throw invalid_iterator.202 if @a pos is not an iterator of *this;
+    example: `"iterator does not fit current value"`
+
+    @return iterator pointing to the first element inserted, or @a pos if
+    `ilist` is empty
+
+    @complexity Linear in `ilist.size()` plus linear in the distance between
+    @a pos and end of the container.
+
+    @liveexample{The example shows how `insert()` is used.,insert__ilist}
+
+    @since version 1.0.0
+    */
+    iterator insert(const_iterator pos, std::initializer_list<basic_json> ilist)
+    {
+        // insert only works for arrays
+        if (not is_array())
+        {
+            JSON_THROW(type_error::create(309, "cannot use insert() with " + type_name()));
+        }
+
+        // check if iterator pos fits to this JSON value
+        if (pos.m_object != this)
+        {
+            JSON_THROW(invalid_iterator::create(202, "iterator does not fit current value"));
+        }
+
+        // insert to array and return iterator
+        iterator result(this);
+        result.m_it.array_iterator = m_value.array->insert(pos.m_it.array_iterator, ilist);
+        return result;
+    }
+
+    /*!
+    @brief exchanges the values
+
+    Exchanges the contents of the JSON value with those of @a other. Does not
+    invoke any move, copy, or swap operations on individual elements. All
+    iterators and references remain valid. The past-the-end iterator is
+    invalidated.
+
+    @param[in,out] other JSON value to exchange the contents with
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how JSON values can be swapped with
+    `swap()`.,swap__reference}
+
+    @since version 1.0.0
+    */
+    void swap(reference other) noexcept (
+        std::is_nothrow_move_constructible<value_t>::value and
+        std::is_nothrow_move_assignable<value_t>::value and
+        std::is_nothrow_move_constructible<json_value>::value and
+        std::is_nothrow_move_assignable<json_value>::value
+    )
+    {
+        std::swap(m_type, other.m_type);
+        std::swap(m_value, other.m_value);
+        assert_invariant();
+    }
+
+    /*!
+    @brief exchanges the values
+
+    Exchanges the contents of a JSON array with those of @a other. Does not
+    invoke any move, copy, or swap operations on individual elements. All
+    iterators and references remain valid. The past-the-end iterator is
+    invalidated.
+
+    @param[in,out] other array to exchange the contents with
+
+    @throw type_error.310 when JSON value is not an array; example: `"cannot
+    use swap() with string"`
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how arrays can be swapped with
+    `swap()`.,swap__array_t}
+
+    @since version 1.0.0
+    */
+    void swap(array_t& other)
+    {
+        // swap only works for arrays
+        if (is_array())
+        {
+            std::swap(*(m_value.array), other);
+        }
+        else
+        {
+            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief exchanges the values
+
+    Exchanges the contents of a JSON object with those of @a other. Does not
+    invoke any move, copy, or swap operations on individual elements. All
+    iterators and references remain valid. The past-the-end iterator is
+    invalidated.
+
+    @param[in,out] other object to exchange the contents with
+
+    @throw type_error.310 when JSON value is not an object; example:
+    `"cannot use swap() with string"`
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how objects can be swapped with
+    `swap()`.,swap__object_t}
+
+    @since version 1.0.0
+    */
+    void swap(object_t& other)
+    {
+        // swap only works for objects
+        if (is_object())
+        {
+            std::swap(*(m_value.object), other);
+        }
+        else
+        {
+            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
+        }
+    }
+
+    /*!
+    @brief exchanges the values
+
+    Exchanges the contents of a JSON string with those of @a other. Does not
+    invoke any move, copy, or swap operations on individual elements. All
+    iterators and references remain valid. The past-the-end iterator is
+    invalidated.
+
+    @param[in,out] other string to exchange the contents with
+
+    @throw type_error.310 when JSON value is not a string; example: `"cannot
+    use swap() with boolean"`
+
+    @complexity Constant.
+
+    @liveexample{The example below shows how strings can be swapped with
+    `swap()`.,swap__string_t}
+
+    @since version 1.0.0
+    */
+    void swap(string_t& other)
+    {
+        // swap only works for strings
+        if (is_string())
+        {
+            std::swap(*(m_value.string), other);
+        }
+        else
+        {
+            JSON_THROW(type_error::create(310, "cannot use swap() with " + type_name()));
+        }
+    }
+
+    /// @}
+
+  public:
+    //////////////////////////////////////////
+    // lexicographical comparison operators //
+    //////////////////////////////////////////
+
+    /// @name lexicographical comparison operators
+    /// @{
+
+    /*!
+    @brief comparison: equal
+
+    Compares two JSON values for equality according to the following rules:
+    - Two JSON values are equal if (1) they are from the same type and (2)
+      their stored values are the same according to their respective
+      `operator==`.
+    - Integer and floating-point numbers are automatically converted before
+      comparison. Floating-point numbers are compared indirectly: two
+      floating-point numbers `f1` and `f2` are considered equal if neither
+      `f1 > f2` nor `f2 > f1` holds. Note than two NaN values are always
+      treated as unequal.
+    - Two JSON null values are equal.
+
+    @note NaN values never compare equal to themselves or to other NaN values.
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether the values @a lhs and @a rhs are equal
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__equal}
+
+    @since version 1.0.0
+    */
+    friend bool operator==(const_reference lhs, const_reference rhs) noexcept
+    {
+        const auto lhs_type = lhs.type();
+        const auto rhs_type = rhs.type();
+
+        if (lhs_type == rhs_type)
+        {
+            switch (lhs_type)
+            {
+                case value_t::array:
+                {
+                    return *lhs.m_value.array == *rhs.m_value.array;
+                }
+                case value_t::object:
+                {
+                    return *lhs.m_value.object == *rhs.m_value.object;
+                }
+                case value_t::null:
+                {
+                    return true;
+                }
+                case value_t::string:
+                {
+                    return *lhs.m_value.string == *rhs.m_value.string;
+                }
+                case value_t::boolean:
+                {
+                    return lhs.m_value.boolean == rhs.m_value.boolean;
+                }
+                case value_t::number_integer:
+                {
+                    return lhs.m_value.number_integer == rhs.m_value.number_integer;
+                }
+                case value_t::number_unsigned:
+                {
+                    return lhs.m_value.number_unsigned == rhs.m_value.number_unsigned;
+                }
+                case value_t::number_float:
+                {
+                    return lhs.m_value.number_float == rhs.m_value.number_float;
+                }
+                default:
+                {
+                    return false;
+                }
+            }
+        }
+        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
+        {
+            return static_cast<number_float_t>(lhs.m_value.number_integer) == rhs.m_value.number_float;
+        }
+        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
+        {
+            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_integer);
+        }
+        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
+        {
+            return static_cast<number_float_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_float;
+        }
+        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
+        {
+            return lhs.m_value.number_float == static_cast<number_float_t>(rhs.m_value.number_unsigned);
+        }
+        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
+        {
+            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) == rhs.m_value.number_integer;
+        }
+        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
+        {
+            return lhs.m_value.number_integer == static_cast<number_integer_t>(rhs.m_value.number_unsigned);
+        }
+
+        return false;
+    }
+
+    /*!
+    @brief comparison: equal
+    @copydoc operator==(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator==(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs == basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: equal
+    @copydoc operator==(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator==(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) == rhs);
+    }
+
+    /*!
+    @brief comparison: not equal
+
+    Compares two JSON values for inequality by calculating `not (lhs == rhs)`.
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether the values @a lhs and @a rhs are not equal
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__notequal}
+
+    @since version 1.0.0
+    */
+    friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
+    {
+        return not (lhs == rhs);
+    }
+
+    /*!
+    @brief comparison: not equal
+    @copydoc operator!=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator!=(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs != basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: not equal
+    @copydoc operator!=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator!=(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) != rhs);
+    }
+
+    /*!
+    @brief comparison: less than
+
+    Compares whether one JSON value @a lhs is less than another JSON value @a
+    rhs according to the following rules:
+    - If @a lhs and @a rhs have the same type, the values are compared using
+      the default `<` operator.
+    - Integer and floating-point numbers are automatically converted before
+      comparison
+    - In case @a lhs and @a rhs have different types, the values are ignored
+      and the order of the types is considered, see
+      @ref operator<(const value_t, const value_t).
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether @a lhs is less than @a rhs
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__less}
+
+    @since version 1.0.0
+    */
+    friend bool operator<(const_reference lhs, const_reference rhs) noexcept
+    {
+        const auto lhs_type = lhs.type();
+        const auto rhs_type = rhs.type();
+
+        if (lhs_type == rhs_type)
+        {
+            switch (lhs_type)
+            {
+                case value_t::array:
+                {
+                    return *lhs.m_value.array < *rhs.m_value.array;
+                }
+                case value_t::object:
+                {
+                    return *lhs.m_value.object < *rhs.m_value.object;
+                }
+                case value_t::null:
+                {
+                    return false;
+                }
+                case value_t::string:
+                {
+                    return *lhs.m_value.string < *rhs.m_value.string;
+                }
+                case value_t::boolean:
+                {
+                    return lhs.m_value.boolean < rhs.m_value.boolean;
+                }
+                case value_t::number_integer:
+                {
+                    return lhs.m_value.number_integer < rhs.m_value.number_integer;
+                }
+                case value_t::number_unsigned:
+                {
+                    return lhs.m_value.number_unsigned < rhs.m_value.number_unsigned;
+                }
+                case value_t::number_float:
+                {
+                    return lhs.m_value.number_float < rhs.m_value.number_float;
+                }
+                default:
+                {
+                    return false;
+                }
+            }
+        }
+        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_float)
+        {
+            return static_cast<number_float_t>(lhs.m_value.number_integer) < rhs.m_value.number_float;
+        }
+        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_integer)
+        {
+            return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_integer);
+        }
+        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_float)
+        {
+            return static_cast<number_float_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_float;
+        }
+        else if (lhs_type == value_t::number_float and rhs_type == value_t::number_unsigned)
+        {
+            return lhs.m_value.number_float < static_cast<number_float_t>(rhs.m_value.number_unsigned);
+        }
+        else if (lhs_type == value_t::number_integer and rhs_type == value_t::number_unsigned)
+        {
+            return lhs.m_value.number_integer < static_cast<number_integer_t>(rhs.m_value.number_unsigned);
+        }
+        else if (lhs_type == value_t::number_unsigned and rhs_type == value_t::number_integer)
+        {
+            return static_cast<number_integer_t>(lhs.m_value.number_unsigned) < rhs.m_value.number_integer;
+        }
+
+        // We only reach this line if we cannot compare values. In that case,
+        // we compare types. Note we have to call the operator explicitly,
+        // because MSVC has problems otherwise.
+        return operator<(lhs_type, rhs_type);
+    }
+
+    /*!
+    @brief comparison: less than
+    @copydoc operator<(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator<(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs < basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: less than
+    @copydoc operator<(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator<(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) < rhs);
+    }
+
+    /*!
+    @brief comparison: less than or equal
+
+    Compares whether one JSON value @a lhs is less than or equal to another
+    JSON value by calculating `not (rhs < lhs)`.
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether @a lhs is less than or equal to @a rhs
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__greater}
+
+    @since version 1.0.0
+    */
+    friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
+    {
+        return not (rhs < lhs);
+    }
+
+    /*!
+    @brief comparison: less than or equal
+    @copydoc operator<=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator<=(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs <= basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: less than or equal
+    @copydoc operator<=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator<=(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) <= rhs);
+    }
+
+    /*!
+    @brief comparison: greater than
+
+    Compares whether one JSON value @a lhs is greater than another
+    JSON value by calculating `not (lhs <= rhs)`.
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether @a lhs is greater than to @a rhs
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__lessequal}
+
+    @since version 1.0.0
+    */
+    friend bool operator>(const_reference lhs, const_reference rhs) noexcept
+    {
+        return not (lhs <= rhs);
+    }
+
+    /*!
+    @brief comparison: greater than
+    @copydoc operator>(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator>(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs > basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: greater than
+    @copydoc operator>(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator>(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) > rhs);
+    }
+
+    /*!
+    @brief comparison: greater than or equal
+
+    Compares whether one JSON value @a lhs is greater than or equal to another
+    JSON value by calculating `not (lhs < rhs)`.
+
+    @param[in] lhs  first JSON value to consider
+    @param[in] rhs  second JSON value to consider
+    @return whether @a lhs is greater than or equal to @a rhs
+
+    @complexity Linear.
+
+    @liveexample{The example demonstrates comparing several JSON
+    types.,operator__greaterequal}
+
+    @since version 1.0.0
+    */
+    friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
+    {
+        return not (lhs < rhs);
+    }
+
+    /*!
+    @brief comparison: greater than or equal
+    @copydoc operator>=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator>=(const_reference lhs, const ScalarType rhs) noexcept
+    {
+        return (lhs >= basic_json(rhs));
+    }
+
+    /*!
+    @brief comparison: greater than or equal
+    @copydoc operator>=(const_reference, const_reference)
+    */
+    template<typename ScalarType, typename std::enable_if<
+                 std::is_scalar<ScalarType>::value, int>::type = 0>
+    friend bool operator>=(const ScalarType lhs, const_reference rhs) noexcept
+    {
+        return (basic_json(lhs) >= rhs);
+    }
+
+    /// @}
+
+
+    ///////////////////
+    // serialization //
+    ///////////////////
+
+    /// @name serialization
+    /// @{
+
+  private:
+    /*!
+    @brief wrapper around the serialization functions
+    */
+    class serializer
+    {
+      private:
+        serializer(const serializer&) = delete;
+        serializer& operator=(const serializer&) = delete;
+
+      public:
+        /*!
+        @param[in] s  output stream to serialize to
+        */
+        serializer(std::ostream& s)
+            : o(s), loc(std::localeconv()),
+              thousands_sep(!loc->thousands_sep ? '\0' : loc->thousands_sep[0]),
+              decimal_point(!loc->decimal_point ? '\0' : loc->decimal_point[0])
+        {}
+
+        /*!
+        @brief internal implementation of the serialization function
+
+        This function is called by the public member function dump and
+        organizes the serialization internally. The indentation level is
+        propagated as additional parameter. In case of arrays and objects, the
+        function is called recursively.
+
+        - strings and object keys are escaped using `escape_string()`
+        - integer numbers are converted implicitly via `operator<<`
+        - floating-point numbers are converted to a string using `"%g"` format
+
+        @param[in] val             value to serialize
+        @param[in] pretty_print    whether the output shall be pretty-printed
+        @param[in] indent_step     the indent level
+        @param[in] current_indent  the current indent level (only used internally)
+        */
+        void dump(const basic_json& val,
+                  const bool pretty_print,
+                  const unsigned int indent_step,
+                  const unsigned int current_indent = 0)
+        {
+            switch (val.m_type)
+            {
+                case value_t::object:
+                {
+                    if (val.m_value.object->empty())
+                    {
+                        o.write("{}", 2);
+                        return;
+                    }
+
+                    if (pretty_print)
+                    {
+                        o.write("{\n", 2);
+
+                        // variable to hold indentation for recursive calls
+                        const auto new_indent = current_indent + indent_step;
+                        if (indent_string.size() < new_indent)
+                        {
+                            indent_string.resize(new_indent, ' ');
+                        }
+
+                        // first n-1 elements
+                        auto i = val.m_value.object->cbegin();
+                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
+                        {
+                            o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
+                            o.put('\"');
+                            dump_escaped(i->first);
+                            o.write("\": ", 3);
+                            dump(i->second, true, indent_step, new_indent);
+                            o.write(",\n", 2);
+                        }
+
+                        // last element
+                        assert(i != val.m_value.object->cend());
+                        o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
+                        o.put('\"');
+                        dump_escaped(i->first);
+                        o.write("\": ", 3);
+                        dump(i->second, true, indent_step, new_indent);
+
+                        o.put('\n');
+                        o.write(indent_string.c_str(), static_cast<std::streamsize>(current_indent));
+                        o.put('}');
+                    }
+                    else
+                    {
+                        o.put('{');
+
+                        // first n-1 elements
+                        auto i = val.m_value.object->cbegin();
+                        for (size_t cnt = 0; cnt < val.m_value.object->size() - 1; ++cnt, ++i)
+                        {
+                            o.put('\"');
+                            dump_escaped(i->first);
+                            o.write("\":", 2);
+                            dump(i->second, false, indent_step, current_indent);
+                            o.put(',');
+                        }
+
+                        // last element
+                        assert(i != val.m_value.object->cend());
+                        o.put('\"');
+                        dump_escaped(i->first);
+                        o.write("\":", 2);
+                        dump(i->second, false, indent_step, current_indent);
+
+                        o.put('}');
+                    }
+
+                    return;
+                }
+
+                case value_t::array:
+                {
+                    if (val.m_value.array->empty())
+                    {
+                        o.write("[]", 2);
+                        return;
+                    }
+
+                    if (pretty_print)
+                    {
+                        o.write("[\n", 2);
+
+                        // variable to hold indentation for recursive calls
+                        const auto new_indent = current_indent + indent_step;
+                        if (indent_string.size() < new_indent)
+                        {
+                            indent_string.resize(new_indent, ' ');
+                        }
+
+                        // first n-1 elements
+                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
+                        {
+                            o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
+                            dump(*i, true, indent_step, new_indent);
+                            o.write(",\n", 2);
+                        }
+
+                        // last element
+                        assert(not val.m_value.array->empty());
+                        o.write(indent_string.c_str(), static_cast<std::streamsize>(new_indent));
+                        dump(val.m_value.array->back(), true, indent_step, new_indent);
+
+                        o.put('\n');
+                        o.write(indent_string.c_str(), static_cast<std::streamsize>(current_indent));
+                        o.put(']');
+                    }
+                    else
+                    {
+                        o.put('[');
+
+                        // first n-1 elements
+                        for (auto i = val.m_value.array->cbegin(); i != val.m_value.array->cend() - 1; ++i)
+                        {
+                            dump(*i, false, indent_step, current_indent);
+                            o.put(',');
+                        }
+
+                        // last element
+                        assert(not val.m_value.array->empty());
+                        dump(val.m_value.array->back(), false, indent_step, current_indent);
+
+                        o.put(']');
+                    }
+
+                    return;
+                }
+
+                case value_t::string:
+                {
+                    o.put('\"');
+                    dump_escaped(*val.m_value.string);
+                    o.put('\"');
+                    return;
+                }
+
+                case value_t::boolean:
+                {
+                    if (val.m_value.boolean)
+                    {
+                        o.write("true", 4);
+                    }
+                    else
+                    {
+                        o.write("false", 5);
+                    }
+                    return;
+                }
+
+                case value_t::number_integer:
+                {
+                    dump_integer(val.m_value.number_integer);
+                    return;
+                }
+
+                case value_t::number_unsigned:
+                {
+                    dump_integer(val.m_value.number_unsigned);
+                    return;
+                }
+
+                case value_t::number_float:
+                {
+                    dump_float(val.m_value.number_float);
+                    return;
+                }
+
+                case value_t::discarded:
+                {
+                    o.write("<discarded>", 11);
+                    return;
+                }
+
+                case value_t::null:
+                {
+                    o.write("null", 4);
+                    return;
+                }
+            }
+        }
+
+      private:
+        /*!
+        @brief calculates the extra space to escape a JSON string
+
+        @param[in] s  the string to escape
+        @return the number of characters required to escape string @a s
+
+        @complexity Linear in the length of string @a s.
+        */
+        static std::size_t extra_space(const string_t& s) noexcept
+        {
+            return std::accumulate(s.begin(), s.end(), size_t{},
+                                   [](size_t res, typename string_t::value_type c)
+            {
+                switch (c)
+                {
+                    case '"':
+                    case '\\':
+                    case '\b':
+                    case '\f':
+                    case '\n':
+                    case '\r':
+                    case '\t':
+                    {
+                        // from c (1 byte) to \x (2 bytes)
+                        return res + 1;
+                    }
+
+                    case 0x00:
+                    case 0x01:
+                    case 0x02:
+                    case 0x03:
+                    case 0x04:
+                    case 0x05:
+                    case 0x06:
+                    case 0x07:
+                    case 0x0b:
+                    case 0x0e:
+                    case 0x0f:
+                    case 0x10:
+                    case 0x11:
+                    case 0x12:
+                    case 0x13:
+                    case 0x14:
+                    case 0x15:
+                    case 0x16:
+                    case 0x17:
+                    case 0x18:
+                    case 0x19:
+                    case 0x1a:
+                    case 0x1b:
+                    case 0x1c:
+                    case 0x1d:
+                    case 0x1e:
+                    case 0x1f:
+                    {
+                        // from c (1 byte) to \uxxxx (6 bytes)
+                        return res + 5;
+                    }
+
+                    default:
+                    {
+                        return res;
+                    }
+                }
+            });
+        }
+
+        /*!
+        @brief dump escaped string
+
+        Escape a string by replacing certain special characters by a sequence
+        of an escape character (backslash) and another character and other
+        control characters by a sequence of "\u" followed by a four-digit hex
+        representation. The escaped string is written to output stream @a o.
+
+        @param[in] s  the string to escape
+
+        @complexity Linear in the length of string @a s.
+        */
+        void dump_escaped(const string_t& s) const
+        {
+            const auto space = extra_space(s);
+            if (space == 0)
+            {
+                o.write(s.c_str(), static_cast<std::streamsize>(s.size()));
+                return;
+            }
+
+            // create a result string of necessary size
+            string_t result(s.size() + space, '\\');
+            std::size_t pos = 0;
+
+            for (const auto& c : s)
+            {
+                switch (c)
+                {
+                    // quotation mark (0x22)
+                    case '"':
+                    {
+                        result[pos + 1] = '"';
+                        pos += 2;
+                        break;
+                    }
+
+                    // reverse solidus (0x5c)
+                    case '\\':
+                    {
+                        // nothing to change
+                        pos += 2;
+                        break;
+                    }
+
+                    // backspace (0x08)
+                    case '\b':
+                    {
+                        result[pos + 1] = 'b';
+                        pos += 2;
+                        break;
+                    }
+
+                    // formfeed (0x0c)
+                    case '\f':
+                    {
+                        result[pos + 1] = 'f';
+                        pos += 2;
+                        break;
+                    }
+
+                    // newline (0x0a)
+                    case '\n':
+                    {
+                        result[pos + 1] = 'n';
+                        pos += 2;
+                        break;
+                    }
+
+                    // carriage return (0x0d)
+                    case '\r':
+                    {
+                        result[pos + 1] = 'r';
+                        pos += 2;
+                        break;
+                    }
+
+                    // horizontal tab (0x09)
+                    case '\t':
+                    {
+                        result[pos + 1] = 't';
+                        pos += 2;
+                        break;
+                    }
+
+                    case 0x00:
+                    case 0x01:
+                    case 0x02:
+                    case 0x03:
+                    case 0x04:
+                    case 0x05:
+                    case 0x06:
+                    case 0x07:
+                    case 0x0b:
+                    case 0x0e:
+                    case 0x0f:
+                    case 0x10:
+                    case 0x11:
+                    case 0x12:
+                    case 0x13:
+                    case 0x14:
+                    case 0x15:
+                    case 0x16:
+                    case 0x17:
+                    case 0x18:
+                    case 0x19:
+                    case 0x1a:
+                    case 0x1b:
+                    case 0x1c:
+                    case 0x1d:
+                    case 0x1e:
+                    case 0x1f:
+                    {
+                        // convert a number 0..15 to its hex representation
+                        // (0..f)
+                        static const char hexify[16] =
+                        {
+                            '0', '1', '2', '3', '4', '5', '6', '7',
+                            '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
+                        };
+
+                        // print character c as \uxxxx
+                        for (const char m :
+                    { 'u', '0', '0', hexify[c >> 4], hexify[c & 0x0f]
+                        })
+                        {
+                            result[++pos] = m;
+                        }
+
+                        ++pos;
+                        break;
+                    }
+
+                    default:
+                    {
+                        // all other characters are added as-is
+                        result[pos++] = c;
+                        break;
+                    }
+                }
+            }
+
+            assert(pos == s.size() + space);
+            o.write(result.c_str(), static_cast<std::streamsize>(result.size()));
+        }
+
+        /*!
+        @brief dump an integer
+
+        Dump a given integer to output stream @a o. Works internally with
+        @a number_buffer.
+
+        @param[in] x  integer number (signed or unsigned) to dump
+        @tparam NumberType either @a number_integer_t or @a number_unsigned_t
+        */
+        template<typename NumberType, detail::enable_if_t <
+                     std::is_same<NumberType, number_unsigned_t>::value or
+                     std::is_same<NumberType, number_integer_t>::value, int> = 0>
+        void dump_integer(NumberType x)
+        {
+            // special case for "0"
+            if (x == 0)
+            {
+                o.put('0');
+                return;
+            }
+
+            const bool is_negative = x < 0;
+            size_t i = 0;
+
+            // spare 1 byte for '\0'
+            while (x != 0 and i < number_buffer.size() - 1)
+            {
+                const auto digit = std::labs(static_cast<long>(x % 10));
+                number_buffer[i++] = static_cast<char>('0' + digit);
+                x /= 10;
+            }
+
+            // make sure the number has been processed completely
+            assert(x == 0);
+
+            if (is_negative)
+            {
+                // make sure there is capacity for the '-'
+                assert(i < number_buffer.size() - 2);
+                number_buffer[i++] = '-';
+            }
+
+            std::reverse(number_buffer.begin(), number_buffer.begin() + i);
+            o.write(number_buffer.data(), static_cast<std::streamsize>(i));
+        }
+
+        /*!
+        @brief dump a floating-point number
+
+        Dump a given floating-point number to output stream @a o. Works
+        internally with @a number_buffer.
+
+        @param[in] x  floating-point number to dump
+        */
+        void dump_float(number_float_t x)
+        {
+            // NaN / inf
+            if (not std::isfinite(x) or std::isnan(x))
+            {
+                o.write("null", 4);
+                return;
+            }
+
+            // special case for 0.0 and -0.0
+            if (x == 0)
+            {
+                if (std::signbit(x))
+                {
+                    o.write("-0.0", 4);
+                }
+                else
+                {
+                    o.write("0.0", 3);
+                }
+                return;
+            }
+
+            // get number of digits for a text -> float -> text round-trip
+            static constexpr auto d = std::numeric_limits<number_float_t>::digits10;
+
+            // the actual conversion
+            std::ptrdiff_t len = snprintf(number_buffer.data(), number_buffer.size(),
+                                          "%.*g", d, x);
+
+            // negative value indicates an error
+            assert(len > 0);
+            // check if buffer was large enough
+            assert(static_cast<size_t>(len) < number_buffer.size());
+
+            // erase thousands separator
+            if (thousands_sep != '\0')
+            {
+                const auto end = std::remove(number_buffer.begin(),
+                                             number_buffer.begin() + len,
+                                             thousands_sep);
+                std::fill(end, number_buffer.end(), '\0');
+                assert((end - number_buffer.begin()) <= len);
+                len = (end - number_buffer.begin());
+            }
+
+            // convert decimal point to '.'
+            if (decimal_point != '\0' and decimal_point != '.')
+            {
+                for (auto& c : number_buffer)
+                {
+                    if (c == decimal_point)
+                    {
+                        c = '.';
+                        break;
+                    }
+                }
+            }
+
+            o.write(number_buffer.data(), static_cast<std::streamsize>(len));
+
+            // determine if need to append ".0"
+            const bool value_is_int_like = std::none_of(number_buffer.begin(),
+                                           number_buffer.begin() + len + 1,
+                                           [](char c)
+            {
+                return c == '.' or c == 'e';
+            });
+
+            if (value_is_int_like)
+            {
+                o.write(".0", 2);
+            }
+        }
+
+      private:
+        /// the output of the serializer
+        std::ostream& o;
+
+        /// a (hopefully) large enough character buffer
+        std::array<char, 64> number_buffer{{}};
+
+        /// the locale
+        const std::lconv* loc = nullptr;
+        /// the locale's thousand separator character
+        const char thousands_sep = '\0';
+        /// the locale's decimal point character
+        const char decimal_point = '\0';
+
+        /// the indentation string
+        string_t indent_string = string_t(512, ' ');
+    };
+
+  public:
+    /*!
+    @brief serialize to stream
+
+    Serialize the given JSON value @a j to the output stream @a o. The JSON
+    value will be serialized using the @ref dump member function. The
+    indentation of the output can be controlled with the member variable
+    `width` of the output stream @a o. For instance, using the manipulator
+    `std::setw(4)` on @a o sets the indentation level to `4` and the
+    serialization result is the same as calling `dump(4)`.
+
+    @param[in,out] o  stream to serialize to
+    @param[in] j  JSON value to serialize
+
+    @return the stream @a o
+
+    @complexity Linear.
+
+    @liveexample{The example below shows the serialization with different
+    parameters to `width` to adjust the indentation level.,operator_serialize}
+
+    @since version 1.0.0
+    */
+    friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
+    {
+        // read width member and use it as indentation parameter if nonzero
+        const bool pretty_print = (o.width() > 0);
+        const auto indentation = (pretty_print ? o.width() : 0);
+
+        // reset width to 0 for subsequent calls to this stream
+        o.width(0);
+
+        // do the actual serialization
+        serializer s(o);
+        s.dump(j, pretty_print, static_cast<unsigned int>(indentation));
+        return o;
+    }
+
+    /*!
+    @brief serialize to stream
+    @deprecated This stream operator is deprecated and will be removed in a
+                future version of the library. Please use
+                @ref std::ostream& operator<<(std::ostream&, const basic_json&)
+                instead; that is, replace calls like `j >> o;` with `o << j;`.
+    */
+    JSON_DEPRECATED
+    friend std::ostream& operator>>(const basic_json& j, std::ostream& o)
+    {
+        return o << j;
+    }
+
+    /// @}
+
+
+    /////////////////////
+    // deserialization //
+    /////////////////////
+
+    /// @name deserialization
+    /// @{
+
+    /*!
+    @brief deserialize from an array
+
+    This function reads from an array of 1-byte values.
+
+    @pre Each element of the container has a size of 1 byte. Violating this
+    precondition yields undefined behavior. **This precondition is enforced
+    with a static assertion.**
+
+    @param[in] array  array to read from
+    @param[in] cb  a parser callback function of type @ref parser_callback_t
+    which is used to control the deserialization by filtering unwanted values
+    (optional)
+
+    @return result of the deserialization
+
+    @throw parse_error.101 if a parse error occurs; example: `""unexpected end
+    of input; expected string literal""`
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser. The complexity can be higher if the parser callback function
+    @a cb has a super-linear complexity.
+
+    @note A UTF-8 byte order mark is silently ignored.
+
+    @liveexample{The example below demonstrates the `parse()` function reading
+    from an array.,parse__array__parser_callback_t}
+
+    @since version 2.0.3
+    */
+    template<class T, std::size_t N>
+    static basic_json parse(T (&array)[N],
+                            const parser_callback_t cb = nullptr)
+    {
+        // delegate the call to the iterator-range parse overload
+        return parse(std::begin(array), std::end(array), cb);
+    }
+
+    /*!
+    @brief deserialize from string literal
+
+    @tparam CharT character/literal type with size of 1 byte
+    @param[in] s  string literal to read a serialized JSON value from
+    @param[in] cb a parser callback function of type @ref parser_callback_t
+    which is used to control the deserialization by filtering unwanted values
+    (optional)
+
+    @return result of the deserialization
+
+    @throw parse_error.101 in case of an unexpected token
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser. The complexity can be higher if the parser callback function
+    @a cb has a super-linear complexity.
+
+    @note A UTF-8 byte order mark is silently ignored.
+    @note String containers like `std::string` or @ref string_t can be parsed
+          with @ref parse(const ContiguousContainer&, const parser_callback_t)
+
+    @liveexample{The example below demonstrates the `parse()` function with
+    and without callback function.,parse__string__parser_callback_t}
+
+    @sa @ref parse(std::istream&, const parser_callback_t) for a version that
+    reads from an input stream
+
+    @since version 1.0.0 (originally for @ref string_t)
+    */
+    template<typename CharT, typename std::enable_if<
+                 std::is_pointer<CharT>::value and
+                 std::is_integral<typename std::remove_pointer<CharT>::type>::value and
+                 sizeof(typename std::remove_pointer<CharT>::type) == 1, int>::type = 0>
+    static basic_json parse(const CharT s,
+                            const parser_callback_t cb = nullptr)
+    {
+        return parser(reinterpret_cast<const char*>(s), cb).parse();
+    }
+
+    /*!
+    @brief deserialize from stream
+
+    @param[in,out] i  stream to read a serialized JSON value from
+    @param[in] cb a parser callback function of type @ref parser_callback_t
+    which is used to control the deserialization by filtering unwanted values
+    (optional)
+
+    @return result of the deserialization
+
+    @throw parse_error.101 in case of an unexpected token
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+    @throw parse_error.111 if input stream is in a bad state
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser. The complexity can be higher if the parser callback function
+    @a cb has a super-linear complexity.
+
+    @note A UTF-8 byte order mark is silently ignored.
+
+    @liveexample{The example below demonstrates the `parse()` function with
+    and without callback function.,parse__istream__parser_callback_t}
+
+    @sa @ref parse(const CharT, const parser_callback_t) for a version
+    that reads from a string
+
+    @since version 1.0.0
+    */
+    static basic_json parse(std::istream& i,
+                            const parser_callback_t cb = nullptr)
+    {
+        return parser(i, cb).parse();
+    }
+
+    /*!
+    @copydoc parse(std::istream&, const parser_callback_t)
+    */
+    static basic_json parse(std::istream&& i,
+                            const parser_callback_t cb = nullptr)
+    {
+        return parser(i, cb).parse();
+    }
+
+    /*!
+    @brief deserialize from an iterator range with contiguous storage
+
+    This function reads from an iterator range of a container with contiguous
+    storage of 1-byte values. Compatible container types include
+    `std::vector`, `std::string`, `std::array`, `std::valarray`, and
+    `std::initializer_list`. Furthermore, C-style arrays can be used with
+    `std::begin()`/`std::end()`. User-defined containers can be used as long
+    as they implement random-access iterators and a contiguous storage.
+
+    @pre The iterator range is contiguous. Violating this precondition yields
+    undefined behavior. **This precondition is enforced with an assertion.**
+    @pre Each element in the range has a size of 1 byte. Violating this
+    precondition yields undefined behavior. **This precondition is enforced
+    with a static assertion.**
+
+    @warning There is no way to enforce all preconditions at compile-time. If
+             the function is called with noncompliant iterators and with
+             assertions switched off, the behavior is undefined and will most
+             likely yield segmentation violation.
+
+    @tparam IteratorType iterator of container with contiguous storage
+    @param[in] first  begin of the range to parse (included)
+    @param[in] last  end of the range to parse (excluded)
+    @param[in] cb  a parser callback function of type @ref parser_callback_t
+    which is used to control the deserialization by filtering unwanted values
+    (optional)
+
+    @return result of the deserialization
+
+    @throw parse_error.101 in case of an unexpected token
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser. The complexity can be higher if the parser callback function
+    @a cb has a super-linear complexity.
+
+    @note A UTF-8 byte order mark is silently ignored.
+
+    @liveexample{The example below demonstrates the `parse()` function reading
+    from an iterator range.,parse__iteratortype__parser_callback_t}
+
+    @since version 2.0.3
+    */
+    template<class IteratorType, typename std::enable_if<
+                 std::is_base_of<
+                     std::random_access_iterator_tag,
+                     typename std::iterator_traits<IteratorType>::iterator_category>::value, int>::type = 0>
+    static basic_json parse(IteratorType first, IteratorType last,
+                            const parser_callback_t cb = nullptr)
+    {
+        // assertion to check that the iterator range is indeed contiguous,
+        // see http://stackoverflow.com/a/35008842/266378 for more discussion
+        assert(std::accumulate(first, last, std::pair<bool, int>(true, 0),
+                               [&first](std::pair<bool, int> res, decltype(*first) val)
+        {
+            res.first &= (val == *(std::next(std::addressof(*first), res.second++)));
+            return res;
+        }).first);
+
+        // assertion to check that each element is 1 byte long
+        static_assert(sizeof(typename std::iterator_traits<IteratorType>::value_type) == 1,
+                      "each element in the iterator range must have the size of 1 byte");
+
+        // if iterator range is empty, create a parser with an empty string
+        // to generate "unexpected EOF" error message
+        if (std::distance(first, last) <= 0)
+        {
+            return parser("").parse();
+        }
+
+        return parser(first, last, cb).parse();
+    }
+
+    /*!
+    @brief deserialize from a container with contiguous storage
+
+    This function reads from a container with contiguous storage of 1-byte
+    values. Compatible container types include `std::vector`, `std::string`,
+    `std::array`, and `std::initializer_list`. User-defined containers can be
+    used as long as they implement random-access iterators and a contiguous
+    storage.
+
+    @pre The container storage is contiguous. Violating this precondition
+    yields undefined behavior. **This precondition is enforced with an
+    assertion.**
+    @pre Each element of the container has a size of 1 byte. Violating this
+    precondition yields undefined behavior. **This precondition is enforced
+    with a static assertion.**
+
+    @warning There is no way to enforce all preconditions at compile-time. If
+             the function is called with a noncompliant container and with
+             assertions switched off, the behavior is undefined and will most
+             likely yield segmentation violation.
+
+    @tparam ContiguousContainer container type with contiguous storage
+    @param[in] c  container to read from
+    @param[in] cb  a parser callback function of type @ref parser_callback_t
+    which is used to control the deserialization by filtering unwanted values
+    (optional)
+
+    @return result of the deserialization
+
+    @throw parse_error.101 in case of an unexpected token
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser. The complexity can be higher if the parser callback function
+    @a cb has a super-linear complexity.
+
+    @note A UTF-8 byte order mark is silently ignored.
+
+    @liveexample{The example below demonstrates the `parse()` function reading
+    from a contiguous container.,parse__contiguouscontainer__parser_callback_t}
+
+    @since version 2.0.3
+    */
+    template<class ContiguousContainer, typename std::enable_if<
+                 not std::is_pointer<ContiguousContainer>::value and
+                 std::is_base_of<
+                     std::random_access_iterator_tag,
+                     typename std::iterator_traits<decltype(std::begin(std::declval<ContiguousContainer const>()))>::iterator_category>::value
+                 , int>::type = 0>
+    static basic_json parse(const ContiguousContainer& c,
+                            const parser_callback_t cb = nullptr)
+    {
+        // delegate the call to the iterator-range parse overload
+        return parse(std::begin(c), std::end(c), cb);
+    }
+
+    /*!
+    @brief deserialize from stream
+    @deprecated This stream operator is deprecated and will be removed in a
+                future version of the library. Please use
+                @ref std::istream& operator>>(std::istream&, basic_json&)
+                instead; that is, replace calls like `j << i;` with `i >> j;`.
+    */
+    JSON_DEPRECATED
+    friend std::istream& operator<<(basic_json& j, std::istream& i)
+    {
+        j = parser(i).parse();
+        return i;
+    }
+
+    /*!
+    @brief deserialize from stream
+
+    Deserializes an input stream to a JSON value.
+
+    @param[in,out] i  input stream to read a serialized JSON value from
+    @param[in,out] j  JSON value to write the deserialized input to
+
+    @throw parse_error.101 in case of an unexpected token
+    @throw parse_error.102 if to_unicode fails or surrogate error
+    @throw parse_error.103 if to_unicode fails
+    @throw parse_error.111 if input stream is in a bad state
+
+    @complexity Linear in the length of the input. The parser is a predictive
+    LL(1) parser.
+
+    @note A UTF-8 byte order mark is silently ignored.
+
+    @liveexample{The example below shows how a JSON value is constructed by
+    reading a serialization from a stream.,operator_deserialize}
+
+    @sa parse(std::istream&, const parser_callback_t) for a variant with a
+    parser callback function to filter values while parsing
+
+    @since version 1.0.0
+    */
+    friend std::istream& operator>>(std::istream& i, basic_json& j)
+    {
+        j = parser(i).parse();
+        return i;
+    }
+
+    /// @}
+
+    //////////////////////////////////////////
+    // binary serialization/deserialization //
+    //////////////////////////////////////////
+
+    /// @name binary serialization/deserialization support
+    /// @{
+
+  private:
+    /*!
+    @note Some code in the switch cases has been copied, because otherwise
+          copilers would complain about implicit fallthrough and there is no
+          portable attribute to mute such warnings.
+    */
+    template<typename T>
+    static void add_to_vector(std::vector<uint8_t>& vec, size_t bytes, const T number)
+    {
+        assert(bytes == 1 or bytes == 2 or bytes == 4 or bytes == 8);
+
+        switch (bytes)
+        {
+            case 8:
+            {
+                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 070) & 0xff));
+                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 060) & 0xff));
+                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 050) & 0xff));
+                vec.push_back(static_cast<uint8_t>((static_cast<uint64_t>(number) >> 040) & 0xff));
+                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
+                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
+                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
+                vec.push_back(static_cast<uint8_t>(number & 0xff));
+                break;
+            }
+
+            case 4:
+            {
+                vec.push_back(static_cast<uint8_t>((number >> 030) & 0xff));
+                vec.push_back(static_cast<uint8_t>((number >> 020) & 0xff));
+                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
+                vec.push_back(static_cast<uint8_t>(number & 0xff));
+                break;
+            }
+
+            case 2:
+            {
+                vec.push_back(static_cast<uint8_t>((number >> 010) & 0xff));
+                vec.push_back(static_cast<uint8_t>(number & 0xff));
+                break;
+            }
+
+            case 1:
+            {
+                vec.push_back(static_cast<uint8_t>(number & 0xff));
+                break;
+            }
+        }
+    }
+
+    /*!
+    @brief take sufficient bytes from a vector to fill an integer variable
+
+    In the context of binary serialization formats, we need to read several
+    bytes from a byte vector and combine them to multi-byte integral data
+    types.
+
+    @param[in] vec  byte vector to read from
+    @param[in] current_index  the position in the vector after which to read
+
+    @return the next sizeof(T) bytes from @a vec, in reverse order as T
+
+    @tparam T the integral return type
+
+    @throw parse_error.110 if there are less than sizeof(T)+1 bytes in the
+           vector @a vec to read
+
+    In the for loop, the bytes from the vector are copied in reverse order into
+    the return value. In the figures below, let sizeof(T)=4 and `i` be the loop
+    variable.
+
+    Precondition:
+
+    vec:   |   |   | a | b | c | d |      T: |   |   |   |   |
+                 ^               ^             ^                ^
+           current_index         i            ptr        sizeof(T)
+
+    Postcondition:
+
+    vec:   |   |   | a | b | c | d |      T: | d | c | b | a |
+                 ^   ^                                     ^
+                 |   i                                    ptr
+           current_index
+
+    @sa Code adapted from <http://stackoverflow.com/a/41031865/266378>.
+    */
+    template<typename T>
+    static T get_from_vector(const std::vector<uint8_t>& vec, const size_t current_index)
+    {
+        // check if we can read sizeof(T) bytes starting the next index
+        check_length(vec.size(), sizeof(T), current_index + 1);
+
+        T result;
+        auto* ptr = reinterpret_cast<uint8_t*>(&result);
+        for (size_t i = 0; i < sizeof(T); ++i)
+        {
+            *ptr++ = vec[current_index + sizeof(T) - i];
+        }
+        return result;
+    }
+
+    /*!
+    @brief create a MessagePack serialization of a given JSON value
+
+    This is a straightforward implementation of the MessagePack specification.
+
+    @param[in] j  JSON value to serialize
+    @param[in,out] v  byte vector to write the serialization to
+
+    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
+    */
+    static void to_msgpack_internal(const basic_json& j, std::vector<uint8_t>& v)
+    {
+        switch (j.type())
+        {
+            case value_t::null:
+            {
+                // nil
+                v.push_back(0xc0);
+                break;
+            }
+
+            case value_t::boolean:
+            {
+                // true and false
+                v.push_back(j.m_value.boolean ? 0xc3 : 0xc2);
+                break;
+            }
+
+            case value_t::number_integer:
+            {
+                if (j.m_value.number_integer >= 0)
+                {
+                    // MessagePack does not differentiate between positive
+                    // signed integers and unsigned integers. Therefore, we
+                    // used the code from the value_t::number_unsigned case
+                    // here.
+                    if (j.m_value.number_unsigned < 128)
+                    {
+                        // positive fixnum
+                        add_to_vector(v, 1, j.m_value.number_unsigned);
+                    }
+                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
+                    {
+                        // uint 8
+                        v.push_back(0xcc);
+                        add_to_vector(v, 1, j.m_value.number_unsigned);
+                    }
+                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
+                    {
+                        // uint 16
+                        v.push_back(0xcd);
+                        add_to_vector(v, 2, j.m_value.number_unsigned);
+                    }
+                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
+                    {
+                        // uint 32
+                        v.push_back(0xce);
+                        add_to_vector(v, 4, j.m_value.number_unsigned);
+                    }
+                    else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
+                    {
+                        // uint 64
+                        v.push_back(0xcf);
+                        add_to_vector(v, 8, j.m_value.number_unsigned);
+                    }
+                }
+                else
+                {
+                    if (j.m_value.number_integer >= -32)
+                    {
+                        // negative fixnum
+                        add_to_vector(v, 1, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer >= (std::numeric_limits<int8_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int8_t>::max)())
+                    {
+                        // int 8
+                        v.push_back(0xd0);
+                        add_to_vector(v, 1, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer >= (std::numeric_limits<int16_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int16_t>::max)())
+                    {
+                        // int 16
+                        v.push_back(0xd1);
+                        add_to_vector(v, 2, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer >= (std::numeric_limits<int32_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int32_t>::max)())
+                    {
+                        // int 32
+                        v.push_back(0xd2);
+                        add_to_vector(v, 4, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer >= (std::numeric_limits<int64_t>::min)() and j.m_value.number_integer <= (std::numeric_limits<int64_t>::max)())
+                    {
+                        // int 64
+                        v.push_back(0xd3);
+                        add_to_vector(v, 8, j.m_value.number_integer);
+                    }
+                }
+                break;
+            }
+
+            case value_t::number_unsigned:
+            {
+                if (j.m_value.number_unsigned < 128)
+                {
+                    // positive fixnum
+                    add_to_vector(v, 1, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint8_t>::max)())
+                {
+                    // uint 8
+                    v.push_back(0xcc);
+                    add_to_vector(v, 1, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint16_t>::max)())
+                {
+                    // uint 16
+                    v.push_back(0xcd);
+                    add_to_vector(v, 2, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint32_t>::max)())
+                {
+                    // uint 32
+                    v.push_back(0xce);
+                    add_to_vector(v, 4, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= (std::numeric_limits<uint64_t>::max)())
+                {
+                    // uint 64
+                    v.push_back(0xcf);
+                    add_to_vector(v, 8, j.m_value.number_unsigned);
+                }
+                break;
+            }
+
+            case value_t::number_float:
+            {
+                // float 64
+                v.push_back(0xcb);
+                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
+                for (size_t i = 0; i < 8; ++i)
+                {
+                    v.push_back(helper[7 - i]);
+                }
+                break;
+            }
+
+            case value_t::string:
+            {
+                const auto N = j.m_value.string->size();
+                if (N <= 31)
+                {
+                    // fixstr
+                    v.push_back(static_cast<uint8_t>(0xa0 | N));
+                }
+                else if (N <= 255)
+                {
+                    // str 8
+                    v.push_back(0xd9);
+                    add_to_vector(v, 1, N);
+                }
+                else if (N <= 65535)
+                {
+                    // str 16
+                    v.push_back(0xda);
+                    add_to_vector(v, 2, N);
+                }
+                else if (N <= 4294967295)
+                {
+                    // str 32
+                    v.push_back(0xdb);
+                    add_to_vector(v, 4, N);
+                }
+
+                // append string
+                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
+                          std::back_inserter(v));
+                break;
+            }
+
+            case value_t::array:
+            {
+                const auto N = j.m_value.array->size();
+                if (N <= 15)
+                {
+                    // fixarray
+                    v.push_back(static_cast<uint8_t>(0x90 | N));
+                }
+                else if (N <= 0xffff)
+                {
+                    // array 16
+                    v.push_back(0xdc);
+                    add_to_vector(v, 2, N);
+                }
+                else if (N <= 0xffffffff)
+                {
+                    // array 32
+                    v.push_back(0xdd);
+                    add_to_vector(v, 4, N);
+                }
+
+                // append each element
+                for (const auto& el : *j.m_value.array)
+                {
+                    to_msgpack_internal(el, v);
+                }
+                break;
+            }
+
+            case value_t::object:
+            {
+                const auto N = j.m_value.object->size();
+                if (N <= 15)
+                {
+                    // fixmap
+                    v.push_back(static_cast<uint8_t>(0x80 | (N & 0xf)));
+                }
+                else if (N <= 65535)
+                {
+                    // map 16
+                    v.push_back(0xde);
+                    add_to_vector(v, 2, N);
+                }
+                else if (N <= 4294967295)
+                {
+                    // map 32
+                    v.push_back(0xdf);
+                    add_to_vector(v, 4, N);
+                }
+
+                // append each element
+                for (const auto& el : *j.m_value.object)
+                {
+                    to_msgpack_internal(el.first, v);
+                    to_msgpack_internal(el.second, v);
+                }
+                break;
+            }
+
+            default:
+            {
+                break;
+            }
+        }
+    }
+
+    /*!
+    @brief create a CBOR serialization of a given JSON value
+
+    This is a straightforward implementation of the CBOR specification.
+
+    @param[in] j  JSON value to serialize
+    @param[in,out] v  byte vector to write the serialization to
+
+    @sa https://tools.ietf.org/html/rfc7049
+    */
+    static void to_cbor_internal(const basic_json& j, std::vector<uint8_t>& v)
+    {
+        switch (j.type())
+        {
+            case value_t::null:
+            {
+                v.push_back(0xf6);
+                break;
+            }
+
+            case value_t::boolean:
+            {
+                v.push_back(j.m_value.boolean ? 0xf5 : 0xf4);
+                break;
+            }
+
+            case value_t::number_integer:
+            {
+                if (j.m_value.number_integer >= 0)
+                {
+                    // CBOR does not differentiate between positive signed
+                    // integers and unsigned integers. Therefore, we used the
+                    // code from the value_t::number_unsigned case here.
+                    if (j.m_value.number_integer <= 0x17)
+                    {
+                        add_to_vector(v, 1, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer <= (std::numeric_limits<uint8_t>::max)())
+                    {
+                        v.push_back(0x18);
+                        // one-byte uint8_t
+                        add_to_vector(v, 1, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer <= (std::numeric_limits<uint16_t>::max)())
+                    {
+                        v.push_back(0x19);
+                        // two-byte uint16_t
+                        add_to_vector(v, 2, j.m_value.number_integer);
+                    }
+                    else if (j.m_value.number_integer <= (std::numeric_limits<uint32_t>::max)())
+                    {
+                        v.push_back(0x1a);
+                        // four-byte uint32_t
+                        add_to_vector(v, 4, j.m_value.number_integer);
+                    }
+                    else
+                    {
+                        v.push_back(0x1b);
+                        // eight-byte uint64_t
+                        add_to_vector(v, 8, j.m_value.number_integer);
+                    }
+                }
+                else
+                {
+                    // The conversions below encode the sign in the first
+                    // byte, and the value is converted to a positive number.
+                    const auto positive_number = -1 - j.m_value.number_integer;
+                    if (j.m_value.number_integer >= -24)
+                    {
+                        v.push_back(static_cast<uint8_t>(0x20 + positive_number));
+                    }
+                    else if (positive_number <= (std::numeric_limits<uint8_t>::max)())
+                    {
+                        // int 8
+                        v.push_back(0x38);
+                        add_to_vector(v, 1, positive_number);
+                    }
+                    else if (positive_number <= (std::numeric_limits<uint16_t>::max)())
+                    {
+                        // int 16
+                        v.push_back(0x39);
+                        add_to_vector(v, 2, positive_number);
+                    }
+                    else if (positive_number <= (std::numeric_limits<uint32_t>::max)())
+                    {
+                        // int 32
+                        v.push_back(0x3a);
+                        add_to_vector(v, 4, positive_number);
+                    }
+                    else
+                    {
+                        // int 64
+                        v.push_back(0x3b);
+                        add_to_vector(v, 8, positive_number);
+                    }
+                }
+                break;
+            }
+
+            case value_t::number_unsigned:
+            {
+                if (j.m_value.number_unsigned <= 0x17)
+                {
+                    v.push_back(static_cast<uint8_t>(j.m_value.number_unsigned));
+                }
+                else if (j.m_value.number_unsigned <= 0xff)
+                {
+                    v.push_back(0x18);
+                    // one-byte uint8_t
+                    add_to_vector(v, 1, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= 0xffff)
+                {
+                    v.push_back(0x19);
+                    // two-byte uint16_t
+                    add_to_vector(v, 2, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= 0xffffffff)
+                {
+                    v.push_back(0x1a);
+                    // four-byte uint32_t
+                    add_to_vector(v, 4, j.m_value.number_unsigned);
+                }
+                else if (j.m_value.number_unsigned <= 0xffffffffffffffff)
+                {
+                    v.push_back(0x1b);
+                    // eight-byte uint64_t
+                    add_to_vector(v, 8, j.m_value.number_unsigned);
+                }
+                break;
+            }
+
+            case value_t::number_float:
+            {
+                // Double-Precision Float
+                v.push_back(0xfb);
+                const auto* helper = reinterpret_cast<const uint8_t*>(&(j.m_value.number_float));
+                for (size_t i = 0; i < 8; ++i)
+                {
+                    v.push_back(helper[7 - i]);
+                }
+                break;
+            }
+
+            case value_t::string:
+            {
+                const auto N = j.m_value.string->size();
+                if (N <= 0x17)
+                {
+                    v.push_back(static_cast<uint8_t>(0x60 + N));  // 1 byte for string + size
+                }
+                else if (N <= 0xff)
+                {
+                    v.push_back(0x78);  // one-byte uint8_t for N
+                    add_to_vector(v, 1, N);
+                }
+                else if (N <= 0xffff)
+                {
+                    v.push_back(0x79);  // two-byte uint16_t for N
+                    add_to_vector(v, 2, N);
+                }
+                else if (N <= 0xffffffff)
+                {
+                    v.push_back(0x7a); // four-byte uint32_t for N
+                    add_to_vector(v, 4, N);
+                }
+                // LCOV_EXCL_START
+                else if (N <= 0xffffffffffffffff)
+                {
+                    v.push_back(0x7b);  // eight-byte uint64_t for N
+                    add_to_vector(v, 8, N);
+                }
+                // LCOV_EXCL_STOP
+
+                // append string
+                std::copy(j.m_value.string->begin(), j.m_value.string->end(),
+                          std::back_inserter(v));
+                break;
+            }
+
+            case value_t::array:
+            {
+                const auto N = j.m_value.array->size();
+                if (N <= 0x17)
+                {
+                    v.push_back(static_cast<uint8_t>(0x80 + N));  // 1 byte for array + size
+                }
+                else if (N <= 0xff)
+                {
+                    v.push_back(0x98);  // one-byte uint8_t for N
+                    add_to_vector(v, 1, N);
+                }
+                else if (N <= 0xffff)
+                {
+                    v.push_back(0x99);  // two-byte uint16_t for N
+                    add_to_vector(v, 2, N);
+                }
+                else if (N <= 0xffffffff)
+                {
+                    v.push_back(0x9a);  // four-byte uint32_t for N
+                    add_to_vector(v, 4, N);
+                }
+                // LCOV_EXCL_START
+                else if (N <= 0xffffffffffffffff)
+                {
+                    v.push_back(0x9b);  // eight-byte uint64_t for N
+                    add_to_vector(v, 8, N);
+                }
+                // LCOV_EXCL_STOP
+
+                // append each element
+                for (const auto& el : *j.m_value.array)
+                {
+                    to_cbor_internal(el, v);
+                }
+                break;
+            }
+
+            case value_t::object:
+            {
+                const auto N = j.m_value.object->size();
+                if (N <= 0x17)
+                {
+                    v.push_back(static_cast<uint8_t>(0xa0 + N));  // 1 byte for object + size
+                }
+                else if (N <= 0xff)
+                {
+                    v.push_back(0xb8);
+                    add_to_vector(v, 1, N);  // one-byte uint8_t for N
+                }
+                else if (N <= 0xffff)
+                {
+                    v.push_back(0xb9);
+                    add_to_vector(v, 2, N);  // two-byte uint16_t for N
+                }
+                else if (N <= 0xffffffff)
+                {
+                    v.push_back(0xba);
+                    add_to_vector(v, 4, N);  // four-byte uint32_t for N
+                }
+                // LCOV_EXCL_START
+                else if (N <= 0xffffffffffffffff)
+                {
+                    v.push_back(0xbb);
+                    add_to_vector(v, 8, N);  // eight-byte uint64_t for N
+                }
+                // LCOV_EXCL_STOP
+
+                // append each element
+                for (const auto& el : *j.m_value.object)
+                {
+                    to_cbor_internal(el.first, v);
+                    to_cbor_internal(el.second, v);
+                }
+                break;
+            }
+
+            default:
+            {
+                break;
+            }
+        }
+    }
+
+
+    /*
+    @brief checks if given lengths do not exceed the size of a given vector
+
+    To secure the access to the byte vector during CBOR/MessagePack
+    deserialization, bytes are copied from the vector into buffers. This
+    function checks if the number of bytes to copy (@a len) does not exceed
+    the size @s size of the vector. Additionally, an @a offset is given from
+    where to start reading the bytes.
+
+    This function checks whether reading the bytes is safe; that is, offset is
+    a valid index in the vector, offset+len
+
+    @param[in] size    size of the byte vector
+    @param[in] len     number of bytes to read
+    @param[in] offset  offset where to start reading
+
+    vec:  x x x x x X X X X X
+          ^         ^         ^
+          0         offset    len
+
+    @throws out_of_range if `len > v.size()`
+    */
+    static void check_length(const size_t size, const size_t len, const size_t offset)
+    {
+        // simple case: requested length is greater than the vector's length
+        if (len > size or offset > size)
+        {
+            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
+        }
+
+        // second case: adding offset would result in overflow
+        if ((size > ((std::numeric_limits<size_t>::max)() - offset)))
+        {
+            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
+        }
+
+        // last case: reading past the end of the vector
+        if (len + offset > size)
+        {
+            JSON_THROW(parse_error::create(110, offset + 1, "cannot read " + std::to_string(len) + " bytes from vector"));
+        }
+    }
+
+    /*!
+    @brief check if the next byte belongs to a string
+
+    While parsing a map, the keys must be strings. This function checks if the
+    current byte is one of the start bytes for a string in MessagePack:
+
+    - 0xa0 - 0xbf: fixstr
+    - 0xd9: str 8
+    - 0xda: str 16
+    - 0xdb: str 32
+
+    @param[in] v  MessagePack serialization
+    @param[in] idx  byte index in @a v to check for a string
+
+    @throw parse_error.113 if `v[idx]` does not belong to a string
+    */
+    static void msgpack_expect_string(const std::vector<uint8_t>& v, size_t idx)
+    {
+        check_length(v.size(), 1, idx);
+
+        const auto byte = v[idx];
+        if ((byte >= 0xa0 and byte <= 0xbf) or (byte >= 0xd9 and byte <= 0xdb))
+        {
+            return;
+        }
+
+        std::stringstream ss;
+        ss << std::hex << static_cast<int>(v[idx]);
+        JSON_THROW(parse_error::create(113, idx + 1, "expected a MessagePack string; last byte: 0x" + ss.str()));
+    }
+
+    /*!
+    @brief check if the next byte belongs to a string
+
+    While parsing a map, the keys must be strings. This function checks if the
+    current byte is one of the start bytes for a string in CBOR:
+
+    - 0x60 - 0x77: fixed length
+    - 0x78 - 0x7b: variable length
+    - 0x7f: indefinity length
+
+    @param[in] v  CBOR serialization
+    @param[in] idx  byte index in @a v to check for a string
+
+    @throw parse_error.113 if `v[idx]` does not belong to a string
+    */
+    static void cbor_expect_string(const std::vector<uint8_t>& v, size_t idx)
+    {
+        check_length(v.size(), 1, idx);
+
+        const auto byte = v[idx];
+        if ((byte >= 0x60 and byte <= 0x7b) or byte == 0x7f)
+        {
+            return;
+        }
+
+        std::stringstream ss;
+        ss << std::hex << static_cast<int>(v[idx]);
+        JSON_THROW(parse_error::create(113, idx + 1, "expected a CBOR string; last byte: 0x" + ss.str()));
+    }
+
+    /*!
+    @brief create a JSON value from a given MessagePack vector
+
+    @param[in] v  MessagePack serialization
+    @param[in] idx  byte index to start reading from @a v
+
+    @return deserialized JSON value
+
+    @throw parse_error.110 if the given vector ends prematurely
+    @throw parse_error.112 if unsupported features from MessagePack were
+    used in the given vector @a v or if the input is not valid MessagePack
+    @throw parse_error.113 if a string was expected as map key, but not found
+
+    @sa https://github.com/msgpack/msgpack/blob/master/spec.md
+    */
+    static basic_json from_msgpack_internal(const std::vector<uint8_t>& v, size_t& idx)
+    {
+        // store and increment index
+        const size_t current_idx = idx++;
+
+        // make sure reading 1 byte is safe
+        check_length(v.size(), 1, current_idx);
+
+        if (v[current_idx] <= 0xbf)
+        {
+            if (v[current_idx] <= 0x7f) // positive fixint
+            {
+                return v[current_idx];
+            }
+            if (v[current_idx] <= 0x8f) // fixmap
+            {
+                basic_json result = value_t::object;
+                const size_t len = v[current_idx] & 0x0f;
+                for (size_t i = 0; i < len; ++i)
+                {
+                    msgpack_expect_string(v, idx);
+                    std::string key = from_msgpack_internal(v, idx);
+                    result[key] = from_msgpack_internal(v, idx);
+                }
+                return result;
+            }
+            else if (v[current_idx] <= 0x9f) // fixarray
+            {
+                basic_json result = value_t::array;
+                const size_t len = v[current_idx] & 0x0f;
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_msgpack_internal(v, idx));
+                }
+                return result;
+            }
+            else // fixstr
+            {
+                const size_t len = v[current_idx] & 0x1f;
+                const size_t offset = current_idx + 1;
+                idx += len; // skip content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+        }
+        else if (v[current_idx] >= 0xe0) // negative fixint
+        {
+            return static_cast<int8_t>(v[current_idx]);
+        }
+        else
+        {
+            switch (v[current_idx])
+            {
+                case 0xc0: // nil
+                {
+                    return value_t::null;
+                }
+
+                case 0xc2: // false
+                {
+                    return false;
+                }
+
+                case 0xc3: // true
+                {
+                    return true;
+                }
+
+                case 0xca: // float 32
+                {
+                    // copy bytes in reverse order into the double variable
+                    float res;
+                    check_length(v.size(), sizeof(float), current_idx + 1);
+                    for (size_t byte = 0; byte < sizeof(float); ++byte)
+                    {
+                        reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
+                    }
+                    idx += sizeof(float); // skip content bytes
+                    return res;
+                }
+
+                case 0xcb: // float 64
+                {
+                    // copy bytes in reverse order into the double variable
+                    double res;
+                    check_length(v.size(), sizeof(double), current_idx + 1);
+                    for (size_t byte = 0; byte < sizeof(double); ++byte)
+                    {
+                        reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
+                    }
+                    idx += sizeof(double); // skip content bytes
+                    return res;
+                }
+
+                case 0xcc: // uint 8
+                {
+                    idx += 1; // skip content byte
+                    return get_from_vector<uint8_t>(v, current_idx);
+                }
+
+                case 0xcd: // uint 16
+                {
+                    idx += 2; // skip 2 content bytes
+                    return get_from_vector<uint16_t>(v, current_idx);
+                }
+
+                case 0xce: // uint 32
+                {
+                    idx += 4; // skip 4 content bytes
+                    return get_from_vector<uint32_t>(v, current_idx);
+                }
+
+                case 0xcf: // uint 64
+                {
+                    idx += 8; // skip 8 content bytes
+                    return get_from_vector<uint64_t>(v, current_idx);
+                }
+
+                case 0xd0: // int 8
+                {
+                    idx += 1; // skip content byte
+                    return get_from_vector<int8_t>(v, current_idx);
+                }
+
+                case 0xd1: // int 16
+                {
+                    idx += 2; // skip 2 content bytes
+                    return get_from_vector<int16_t>(v, current_idx);
+                }
+
+                case 0xd2: // int 32
+                {
+                    idx += 4; // skip 4 content bytes
+                    return get_from_vector<int32_t>(v, current_idx);
+                }
+
+                case 0xd3: // int 64
+                {
+                    idx += 8; // skip 8 content bytes
+                    return get_from_vector<int64_t>(v, current_idx);
+                }
+
+                case 0xd9: // str 8
+                {
+                    const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
+                    const size_t offset = current_idx + 2;
+                    idx += len + 1; // skip size byte + content bytes
+                    check_length(v.size(), len, offset);
+                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+                }
+
+                case 0xda: // str 16
+                {
+                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                    const size_t offset = current_idx + 3;
+                    idx += len + 2; // skip 2 size bytes + content bytes
+                    check_length(v.size(), len, offset);
+                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+                }
+
+                case 0xdb: // str 32
+                {
+                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                    const size_t offset = current_idx + 5;
+                    idx += len + 4; // skip 4 size bytes + content bytes
+                    check_length(v.size(), len, offset);
+                    return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+                }
+
+                case 0xdc: // array 16
+                {
+                    basic_json result = value_t::array;
+                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                    idx += 2; // skip 2 size bytes
+                    for (size_t i = 0; i < len; ++i)
+                    {
+                        result.push_back(from_msgpack_internal(v, idx));
+                    }
+                    return result;
+                }
+
+                case 0xdd: // array 32
+                {
+                    basic_json result = value_t::array;
+                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                    idx += 4; // skip 4 size bytes
+                    for (size_t i = 0; i < len; ++i)
+                    {
+                        result.push_back(from_msgpack_internal(v, idx));
+                    }
+                    return result;
+                }
+
+                case 0xde: // map 16
+                {
+                    basic_json result = value_t::object;
+                    const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                    idx += 2; // skip 2 size bytes
+                    for (size_t i = 0; i < len; ++i)
+                    {
+                        msgpack_expect_string(v, idx);
+                        std::string key = from_msgpack_internal(v, idx);
+                        result[key] = from_msgpack_internal(v, idx);
+                    }
+                    return result;
+                }
+
+                case 0xdf: // map 32
+                {
+                    basic_json result = value_t::object;
+                    const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                    idx += 4; // skip 4 size bytes
+                    for (size_t i = 0; i < len; ++i)
+                    {
+                        msgpack_expect_string(v, idx);
+                        std::string key = from_msgpack_internal(v, idx);
+                        result[key] = from_msgpack_internal(v, idx);
+                    }
+                    return result;
+                }
+
+                default:
+                {
+                    std::stringstream ss;
+                    ss << std::hex << static_cast<int>(v[current_idx]);
+                    JSON_THROW(parse_error::create(112, current_idx + 1, "error reading MessagePack; last byte: 0x" + ss.str()));
+                }
+            }
+        }
+    }
+
+    /*!
+    @brief create a JSON value from a given CBOR vector
+
+    @param[in] v  CBOR serialization
+    @param[in] idx  byte index to start reading from @a v
+
+    @return deserialized JSON value
+
+    @throw parse_error.110 if the given vector ends prematurely
+    @throw parse_error.112 if unsupported features from CBOR were
+    used in the given vector @a v or if the input is not valid CBOR
+    @throw parse_error.113 if a string was expected as map key, but not found
+
+    @sa https://tools.ietf.org/html/rfc7049
+    */
+    static basic_json from_cbor_internal(const std::vector<uint8_t>& v, size_t& idx)
+    {
+        // store and increment index
+        const size_t current_idx = idx++;
+
+        // make sure reading 1 byte is safe
+        check_length(v.size(), 1, current_idx);
+
+        switch (v[current_idx])
+        {
+            // Integer 0x00..0x17 (0..23)
+            case 0x00:
+            case 0x01:
+            case 0x02:
+            case 0x03:
+            case 0x04:
+            case 0x05:
+            case 0x06:
+            case 0x07:
+            case 0x08:
+            case 0x09:
+            case 0x0a:
+            case 0x0b:
+            case 0x0c:
+            case 0x0d:
+            case 0x0e:
+            case 0x0f:
+            case 0x10:
+            case 0x11:
+            case 0x12:
+            case 0x13:
+            case 0x14:
+            case 0x15:
+            case 0x16:
+            case 0x17:
+            {
+                return v[current_idx];
+            }
+
+            case 0x18: // Unsigned integer (one-byte uint8_t follows)
+            {
+                idx += 1; // skip content byte
+                return get_from_vector<uint8_t>(v, current_idx);
+            }
+
+            case 0x19: // Unsigned integer (two-byte uint16_t follows)
+            {
+                idx += 2; // skip 2 content bytes
+                return get_from_vector<uint16_t>(v, current_idx);
+            }
+
+            case 0x1a: // Unsigned integer (four-byte uint32_t follows)
+            {
+                idx += 4; // skip 4 content bytes
+                return get_from_vector<uint32_t>(v, current_idx);
+            }
+
+            case 0x1b: // Unsigned integer (eight-byte uint64_t follows)
+            {
+                idx += 8; // skip 8 content bytes
+                return get_from_vector<uint64_t>(v, current_idx);
+            }
+
+            // Negative integer -1-0x00..-1-0x17 (-1..-24)
+            case 0x20:
+            case 0x21:
+            case 0x22:
+            case 0x23:
+            case 0x24:
+            case 0x25:
+            case 0x26:
+            case 0x27:
+            case 0x28:
+            case 0x29:
+            case 0x2a:
+            case 0x2b:
+            case 0x2c:
+            case 0x2d:
+            case 0x2e:
+            case 0x2f:
+            case 0x30:
+            case 0x31:
+            case 0x32:
+            case 0x33:
+            case 0x34:
+            case 0x35:
+            case 0x36:
+            case 0x37:
+            {
+                return static_cast<int8_t>(0x20 - 1 - v[current_idx]);
+            }
+
+            case 0x38: // Negative integer (one-byte uint8_t follows)
+            {
+                idx += 1; // skip content byte
+                // must be uint8_t !
+                return static_cast<number_integer_t>(-1) - get_from_vector<uint8_t>(v, current_idx);
+            }
+
+            case 0x39: // Negative integer -1-n (two-byte uint16_t follows)
+            {
+                idx += 2; // skip 2 content bytes
+                return static_cast<number_integer_t>(-1) - get_from_vector<uint16_t>(v, current_idx);
+            }
+
+            case 0x3a: // Negative integer -1-n (four-byte uint32_t follows)
+            {
+                idx += 4; // skip 4 content bytes
+                return static_cast<number_integer_t>(-1) - get_from_vector<uint32_t>(v, current_idx);
+            }
+
+            case 0x3b: // Negative integer -1-n (eight-byte uint64_t follows)
+            {
+                idx += 8; // skip 8 content bytes
+                return static_cast<number_integer_t>(-1) - static_cast<number_integer_t>(get_from_vector<uint64_t>(v, current_idx));
+            }
+
+            // UTF-8 string (0x00..0x17 bytes follow)
+            case 0x60:
+            case 0x61:
+            case 0x62:
+            case 0x63:
+            case 0x64:
+            case 0x65:
+            case 0x66:
+            case 0x67:
+            case 0x68:
+            case 0x69:
+            case 0x6a:
+            case 0x6b:
+            case 0x6c:
+            case 0x6d:
+            case 0x6e:
+            case 0x6f:
+            case 0x70:
+            case 0x71:
+            case 0x72:
+            case 0x73:
+            case 0x74:
+            case 0x75:
+            case 0x76:
+            case 0x77:
+            {
+                const auto len = static_cast<size_t>(v[current_idx] - 0x60);
+                const size_t offset = current_idx + 1;
+                idx += len; // skip content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+
+            case 0x78: // UTF-8 string (one-byte uint8_t for n follows)
+            {
+                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
+                const size_t offset = current_idx + 2;
+                idx += len + 1; // skip size byte + content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+
+            case 0x79: // UTF-8 string (two-byte uint16_t for n follow)
+            {
+                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                const size_t offset = current_idx + 3;
+                idx += len + 2; // skip 2 size bytes + content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+
+            case 0x7a: // UTF-8 string (four-byte uint32_t for n follow)
+            {
+                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                const size_t offset = current_idx + 5;
+                idx += len + 4; // skip 4 size bytes + content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+
+            case 0x7b: // UTF-8 string (eight-byte uint64_t for n follow)
+            {
+                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
+                const size_t offset = current_idx + 9;
+                idx += len + 8; // skip 8 size bytes + content bytes
+                check_length(v.size(), len, offset);
+                return std::string(reinterpret_cast<const char*>(v.data()) + offset, len);
+            }
+
+            case 0x7f: // UTF-8 string (indefinite length)
+            {
+                std::string result;
+                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
+                {
+                    string_t s = from_cbor_internal(v, idx);
+                    result += s;
+                }
+                // skip break byte (0xFF)
+                idx += 1;
+                return result;
+            }
+
+            // array (0x00..0x17 data items follow)
+            case 0x80:
+            case 0x81:
+            case 0x82:
+            case 0x83:
+            case 0x84:
+            case 0x85:
+            case 0x86:
+            case 0x87:
+            case 0x88:
+            case 0x89:
+            case 0x8a:
+            case 0x8b:
+            case 0x8c:
+            case 0x8d:
+            case 0x8e:
+            case 0x8f:
+            case 0x90:
+            case 0x91:
+            case 0x92:
+            case 0x93:
+            case 0x94:
+            case 0x95:
+            case 0x96:
+            case 0x97:
+            {
+                basic_json result = value_t::array;
+                const auto len = static_cast<size_t>(v[current_idx] - 0x80);
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                return result;
+            }
+
+            case 0x98: // array (one-byte uint8_t for n follows)
+            {
+                basic_json result = value_t::array;
+                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
+                idx += 1; // skip 1 size byte
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                return result;
+            }
+
+            case 0x99: // array (two-byte uint16_t for n follow)
+            {
+                basic_json result = value_t::array;
+                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                idx += 2; // skip 4 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                return result;
+            }
+
+            case 0x9a: // array (four-byte uint32_t for n follow)
+            {
+                basic_json result = value_t::array;
+                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                idx += 4; // skip 4 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                return result;
+            }
+
+            case 0x9b: // array (eight-byte uint64_t for n follow)
+            {
+                basic_json result = value_t::array;
+                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
+                idx += 8; // skip 8 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                return result;
+            }
+
+            case 0x9f: // array (indefinite length)
+            {
+                basic_json result = value_t::array;
+                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
+                {
+                    result.push_back(from_cbor_internal(v, idx));
+                }
+                // skip break byte (0xFF)
+                idx += 1;
+                return result;
+            }
+
+            // map (0x00..0x17 pairs of data items follow)
+            case 0xa0:
+            case 0xa1:
+            case 0xa2:
+            case 0xa3:
+            case 0xa4:
+            case 0xa5:
+            case 0xa6:
+            case 0xa7:
+            case 0xa8:
+            case 0xa9:
+            case 0xaa:
+            case 0xab:
+            case 0xac:
+            case 0xad:
+            case 0xae:
+            case 0xaf:
+            case 0xb0:
+            case 0xb1:
+            case 0xb2:
+            case 0xb3:
+            case 0xb4:
+            case 0xb5:
+            case 0xb6:
+            case 0xb7:
+            {
+                basic_json result = value_t::object;
+                const auto len = static_cast<size_t>(v[current_idx] - 0xa0);
+                for (size_t i = 0; i < len; ++i)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                return result;
+            }
+
+            case 0xb8: // map (one-byte uint8_t for n follows)
+            {
+                basic_json result = value_t::object;
+                const auto len = static_cast<size_t>(get_from_vector<uint8_t>(v, current_idx));
+                idx += 1; // skip 1 size byte
+                for (size_t i = 0; i < len; ++i)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                return result;
+            }
+
+            case 0xb9: // map (two-byte uint16_t for n follow)
+            {
+                basic_json result = value_t::object;
+                const auto len = static_cast<size_t>(get_from_vector<uint16_t>(v, current_idx));
+                idx += 2; // skip 2 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                return result;
+            }
+
+            case 0xba: // map (four-byte uint32_t for n follow)
+            {
+                basic_json result = value_t::object;
+                const auto len = static_cast<size_t>(get_from_vector<uint32_t>(v, current_idx));
+                idx += 4; // skip 4 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                return result;
+            }
+
+            case 0xbb: // map (eight-byte uint64_t for n follow)
+            {
+                basic_json result = value_t::object;
+                const auto len = static_cast<size_t>(get_from_vector<uint64_t>(v, current_idx));
+                idx += 8; // skip 8 size bytes
+                for (size_t i = 0; i < len; ++i)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                return result;
+            }
+
+            case 0xbf: // map (indefinite length)
+            {
+                basic_json result = value_t::object;
+                while (static_cast<void>(check_length(v.size(), 1, idx)), v[idx] != 0xff)
+                {
+                    cbor_expect_string(v, idx);
+                    std::string key = from_cbor_internal(v, idx);
+                    result[key] = from_cbor_internal(v, idx);
+                }
+                // skip break byte (0xFF)
+                idx += 1;
+                return result;
+            }
+
+            case 0xf4: // false
+            {
+                return false;
+            }
+
+            case 0xf5: // true
+            {
+                return true;
+            }
+
+            case 0xf6: // null
+            {
+                return value_t::null;
+            }
+
+            case 0xf9: // Half-Precision Float (two-byte IEEE 754)
+            {
+                idx += 2; // skip two content bytes
+
+                // code from RFC 7049, Appendix D, Figure 3:
+                // As half-precision floating-point numbers were only added to
+                // IEEE 754 in 2008, today's programming platforms often still
+                // only have limited support for them. It is very easy to
+                // include at least decoding support for them even without such
+                // support. An example of a small decoder for half-precision
+                // floating-point numbers in the C language is shown in Fig. 3.
+                check_length(v.size(), 2, current_idx + 1);
+                const int half = (v[current_idx + 1] << 8) + v[current_idx + 2];
+                const int exp = (half >> 10) & 0x1f;
+                const int mant = half & 0x3ff;
+                double val;
+                if (exp == 0)
+                {
+                    val = std::ldexp(mant, -24);
+                }
+                else if (exp != 31)
+                {
+                    val = std::ldexp(mant + 1024, exp - 25);
+                }
+                else
+                {
+                    val = mant == 0
+                          ? std::numeric_limits<double>::infinity()
+                          : std::numeric_limits<double>::quiet_NaN();
+                }
+                return (half & 0x8000) != 0 ? -val : val;
+            }
+
+            case 0xfa: // Single-Precision Float (four-byte IEEE 754)
+            {
+                // copy bytes in reverse order into the float variable
+                float res;
+                check_length(v.size(), sizeof(float), current_idx + 1);
+                for (size_t byte = 0; byte < sizeof(float); ++byte)
+                {
+                    reinterpret_cast<uint8_t*>(&res)[sizeof(float) - byte - 1] = v[current_idx + 1 + byte];
+                }
+                idx += sizeof(float); // skip content bytes
+                return res;
+            }
+
+            case 0xfb: // Double-Precision Float (eight-byte IEEE 754)
+            {
+                // copy bytes in reverse order into the double variable
+                double res;
+                check_length(v.size(), sizeof(double), current_idx + 1);
+                for (size_t byte = 0; byte < sizeof(double); ++byte)
+                {
+                    reinterpret_cast<uint8_t*>(&res)[sizeof(double) - byte - 1] = v[current_idx + 1 + byte];
+                }
+                idx += sizeof(double); // skip content bytes
+                return res;
+            }
+
+            default: // anything else (0xFF is handled inside the other types)
+            {
+                std::stringstream ss;
+                ss << std::hex << static_cast<int>(v[current_idx]);
+                JSON_THROW(parse_error::create(112, current_idx + 1, "error reading CBOR; last byte: 0x" + ss.str()));
+            }
+        }
+    }
+
+  public:
+    /*!
+    @brief create a MessagePack serialization of a given JSON value
+
+    Serializes a given JSON value @a j to a byte vector using the MessagePack
+    serialization format. MessagePack is a binary serialization format which
+    aims to be more compact than JSON itself, yet more efficient to parse.
+
+    The library uses the following mapping from JSON values types to
+    MessagePack types according to the MessagePack specification:
+
+    JSON value type | value/range                       | MessagePack type | first byte
+    --------------- | --------------------------------- | ---------------- | ----------
+    null            | `null`                            | nil              | 0xc0
+    boolean         | `true`                            | true             | 0xc3
+    boolean         | `false`                           | false            | 0xc2
+    number_integer  | -9223372036854775808..-2147483649 | int64            | 0xd3
+    number_integer  | -2147483648..-32769               | int32            | 0xd2
+    number_integer  | -32768..-129                      | int16            | 0xd1
+    number_integer  | -128..-33                         | int8             | 0xd0
+    number_integer  | -32..-1                           | negative fixint  | 0xe0..0xff
+    number_integer  | 0..127                            | positive fixint  | 0x00..0x7f
+    number_integer  | 128..255                          | uint 8           | 0xcc
+    number_integer  | 256..65535                        | uint 16          | 0xcd
+    number_integer  | 65536..4294967295                 | uint 32          | 0xce
+    number_integer  | 4294967296..18446744073709551615  | uint 64          | 0xcf
+    number_unsigned | 0..127                            | positive fixint  | 0x00..0x7f
+    number_unsigned | 128..255                          | uint 8           | 0xcc
+    number_unsigned | 256..65535                        | uint 16          | 0xcd
+    number_unsigned | 65536..4294967295                 | uint 32          | 0xce
+    number_unsigned | 4294967296..18446744073709551615  | uint 64          | 0xcf
+    number_float    | *any value*                       | float 64         | 0xcb
+    string          | *length*: 0..31                   | fixstr           | 0xa0..0xbf
+    string          | *length*: 32..255                 | str 8            | 0xd9
+    string          | *length*: 256..65535              | str 16           | 0xda
+    string          | *length*: 65536..4294967295       | str 32           | 0xdb
+    array           | *size*: 0..15                     | fixarray         | 0x90..0x9f
+    array           | *size*: 16..65535                 | array 16         | 0xdc
+    array           | *size*: 65536..4294967295         | array 32         | 0xdd
+    object          | *size*: 0..15                     | fix map          | 0x80..0x8f
+    object          | *size*: 16..65535                 | map 16           | 0xde
+    object          | *size*: 65536..4294967295         | map 32           | 0xdf
+
+    @note The mapping is **complete** in the sense that any JSON value type
+          can be converted to a MessagePack value.
+
+    @note The following values can **not** be converted to a MessagePack value:
+          - strings with more than 4294967295 bytes
+          - arrays with more than 4294967295 elements
+          - objects with more than 4294967295 elements
+
+    @note The following MessagePack types are not used in the conversion:
+          - bin 8 - bin 32 (0xc4..0xc6)
+          - ext 8 - ext 32 (0xc7..0xc9)
+          - float 32 (0xca)
+          - fixext 1 - fixext 16 (0xd4..0xd8)
+
+    @note Any MessagePack output created @ref to_msgpack can be successfully
+          parsed by @ref from_msgpack.
+
+    @param[in] j  JSON value to serialize
+    @return MessagePack serialization as byte vector
+
+    @complexity Linear in the size of the JSON value @a j.
+
+    @liveexample{The example shows the serialization of a JSON value to a byte
+    vector in MessagePack format.,to_msgpack}
+
+    @sa http://msgpack.org
+    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
+        analogous deserialization
+    @sa @ref to_cbor(const basic_json& for the related CBOR format
+
+    @since version 2.0.9
+    */
+    static std::vector<uint8_t> to_msgpack(const basic_json& j)
+    {
+        std::vector<uint8_t> result;
+        to_msgpack_internal(j, result);
+        return result;
+    }
+
+    /*!
+    @brief create a JSON value from a byte vector in MessagePack format
+
+    Deserializes a given byte vector @a v to a JSON value using the MessagePack
+    serialization format.
+
+    The library maps MessagePack types to JSON value types as follows:
+
+    MessagePack type | JSON value type | first byte
+    ---------------- | --------------- | ----------
+    positive fixint  | number_unsigned | 0x00..0x7f
+    fixmap           | object          | 0x80..0x8f
+    fixarray         | array           | 0x90..0x9f
+    fixstr           | string          | 0xa0..0xbf
+    nil              | `null`          | 0xc0
+    false            | `false`         | 0xc2
+    true             | `true`          | 0xc3
+    float 32         | number_float    | 0xca
+    float 64         | number_float    | 0xcb
+    uint 8           | number_unsigned | 0xcc
+    uint 16          | number_unsigned | 0xcd
+    uint 32          | number_unsigned | 0xce
+    uint 64          | number_unsigned | 0xcf
+    int 8            | number_integer  | 0xd0
+    int 16           | number_integer  | 0xd1
+    int 32           | number_integer  | 0xd2
+    int 64           | number_integer  | 0xd3
+    str 8            | string          | 0xd9
+    str 16           | string          | 0xda
+    str 32           | string          | 0xdb
+    array 16         | array           | 0xdc
+    array 32         | array           | 0xdd
+    map 16           | object          | 0xde
+    map 32           | object          | 0xdf
+    negative fixint  | number_integer  | 0xe0-0xff
+
+    @warning The mapping is **incomplete** in the sense that not all
+             MessagePack types can be converted to a JSON value. The following
+             MessagePack types are not supported and will yield parse errors:
+              - bin 8 - bin 32 (0xc4..0xc6)
+              - ext 8 - ext 32 (0xc7..0xc9)
+              - fixext 1 - fixext 16 (0xd4..0xd8)
+
+    @note Any MessagePack output created @ref to_msgpack can be successfully
+          parsed by @ref from_msgpack.
+
+    @param[in] v  a byte vector in MessagePack format
+    @param[in] start_index the index to start reading from @a v (0 by default)
+    @return deserialized JSON value
+
+    @throw parse_error.110 if the given vector ends prematurely
+    @throw parse_error.112 if unsupported features from MessagePack were
+    used in the given vector @a v or if the input is not valid MessagePack
+    @throw parse_error.113 if a string was expected as map key, but not found
+
+    @complexity Linear in the size of the byte vector @a v.
+
+    @liveexample{The example shows the deserialization of a byte vector in
+    MessagePack format to a JSON value.,from_msgpack}
+
+    @sa http://msgpack.org
+    @sa @ref to_msgpack(const basic_json&) for the analogous serialization
+    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
+        related CBOR format
+
+    @since version 2.0.9, parameter @a start_index since 2.1.1
+    */
+    static basic_json from_msgpack(const std::vector<uint8_t>& v,
+                                   const size_t start_index = 0)
+    {
+        size_t i = start_index;
+        return from_msgpack_internal(v, i);
+    }
+
+    /*!
+    @brief create a MessagePack serialization of a given JSON value
+
+    Serializes a given JSON value @a j to a byte vector using the CBOR (Concise
+    Binary Object Representation) serialization format. CBOR is a binary
+    serialization format which aims to be more compact than JSON itself, yet
+    more efficient to parse.
+
+    The library uses the following mapping from JSON values types to
+    CBOR types according to the CBOR specification (RFC 7049):
+
+    JSON value type | value/range                                | CBOR type                          | first byte
+    --------------- | ------------------------------------------ | ---------------------------------- | ---------------
+    null            | `null`                                     | Null                               | 0xf6
+    boolean         | `true`                                     | True                               | 0xf5
+    boolean         | `false`                                    | False                              | 0xf4
+    number_integer  | -9223372036854775808..-2147483649          | Negative integer (8 bytes follow)  | 0x3b
+    number_integer  | -2147483648..-32769                        | Negative integer (4 bytes follow)  | 0x3a
+    number_integer  | -32768..-129                               | Negative integer (2 bytes follow)  | 0x39
+    number_integer  | -128..-25                                  | Negative integer (1 byte follow)   | 0x38
+    number_integer  | -24..-1                                    | Negative integer                   | 0x20..0x37
+    number_integer  | 0..23                                      | Integer                            | 0x00..0x17
+    number_integer  | 24..255                                    | Unsigned integer (1 byte follow)   | 0x18
+    number_integer  | 256..65535                                 | Unsigned integer (2 bytes follow)  | 0x19
+    number_integer  | 65536..4294967295                          | Unsigned integer (4 bytes follow)  | 0x1a
+    number_integer  | 4294967296..18446744073709551615           | Unsigned integer (8 bytes follow)  | 0x1b
+    number_unsigned | 0..23                                      | Integer                            | 0x00..0x17
+    number_unsigned | 24..255                                    | Unsigned integer (1 byte follow)   | 0x18
+    number_unsigned | 256..65535                                 | Unsigned integer (2 bytes follow)  | 0x19
+    number_unsigned | 65536..4294967295                          | Unsigned integer (4 bytes follow)  | 0x1a
+    number_unsigned | 4294967296..18446744073709551615           | Unsigned integer (8 bytes follow)  | 0x1b
+    number_float    | *any value*                                | Double-Precision Float             | 0xfb
+    string          | *length*: 0..23                            | UTF-8 string                       | 0x60..0x77
+    string          | *length*: 23..255                          | UTF-8 string (1 byte follow)       | 0x78
+    string          | *length*: 256..65535                       | UTF-8 string (2 bytes follow)      | 0x79
+    string          | *length*: 65536..4294967295                | UTF-8 string (4 bytes follow)      | 0x7a
+    string          | *length*: 4294967296..18446744073709551615 | UTF-8 string (8 bytes follow)      | 0x7b
+    array           | *size*: 0..23                              | array                              | 0x80..0x97
+    array           | *size*: 23..255                            | array (1 byte follow)              | 0x98
+    array           | *size*: 256..65535                         | array (2 bytes follow)             | 0x99
+    array           | *size*: 65536..4294967295                  | array (4 bytes follow)             | 0x9a
+    array           | *size*: 4294967296..18446744073709551615   | array (8 bytes follow)             | 0x9b
+    object          | *size*: 0..23                              | map                                | 0xa0..0xb7
+    object          | *size*: 23..255                            | map (1 byte follow)                | 0xb8
+    object          | *size*: 256..65535                         | map (2 bytes follow)               | 0xb9
+    object          | *size*: 65536..4294967295                  | map (4 bytes follow)               | 0xba
+    object          | *size*: 4294967296..18446744073709551615   | map (8 bytes follow)               | 0xbb
+
+    @note The mapping is **complete** in the sense that any JSON value type
+          can be converted to a CBOR value.
+
+    @note The following CBOR types are not used in the conversion:
+          - byte strings (0x40..0x5f)
+          - UTF-8 strings terminated by "break" (0x7f)
+          - arrays terminated by "break" (0x9f)
+          - maps terminated by "break" (0xbf)
+          - date/time (0xc0..0xc1)
+          - bignum (0xc2..0xc3)
+          - decimal fraction (0xc4)
+          - bigfloat (0xc5)
+          - tagged items (0xc6..0xd4, 0xd8..0xdb)
+          - expected conversions (0xd5..0xd7)
+          - simple values (0xe0..0xf3, 0xf8)
+          - undefined (0xf7)
+          - half and single-precision floats (0xf9-0xfa)
+          - break (0xff)
+
+    @param[in] j  JSON value to serialize
+    @return MessagePack serialization as byte vector
+
+    @complexity Linear in the size of the JSON value @a j.
+
+    @liveexample{The example shows the serialization of a JSON value to a byte
+    vector in CBOR format.,to_cbor}
+
+    @sa http://cbor.io
+    @sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
+        analogous deserialization
+    @sa @ref to_msgpack(const basic_json& for the related MessagePack format
+
+    @since version 2.0.9
+    */
+    static std::vector<uint8_t> to_cbor(const basic_json& j)
+    {
+        std::vector<uint8_t> result;
+        to_cbor_internal(j, result);
+        return result;
+    }
+
+    /*!
+    @brief create a JSON value from a byte vector in CBOR format
+
+    Deserializes a given byte vector @a v to a JSON value using the CBOR
+    (Concise Binary Object Representation) serialization format.
+
+    The library maps CBOR types to JSON value types as follows:
+
+    CBOR type              | JSON value type | first byte
+    ---------------------- | --------------- | ----------
+    Integer                | number_unsigned | 0x00..0x17
+    Unsigned integer       | number_unsigned | 0x18
+    Unsigned integer       | number_unsigned | 0x19
+    Unsigned integer       | number_unsigned | 0x1a
+    Unsigned integer       | number_unsigned | 0x1b
+    Negative integer       | number_integer  | 0x20..0x37
+    Negative integer       | number_integer  | 0x38
+    Negative integer       | number_integer  | 0x39
+    Negative integer       | number_integer  | 0x3a
+    Negative integer       | number_integer  | 0x3b
+    Negative integer       | number_integer  | 0x40..0x57
+    UTF-8 string           | string          | 0x60..0x77
+    UTF-8 string           | string          | 0x78
+    UTF-8 string           | string          | 0x79
+    UTF-8 string           | string          | 0x7a
+    UTF-8 string           | string          | 0x7b
+    UTF-8 string           | string          | 0x7f
+    array                  | array           | 0x80..0x97
+    array                  | array           | 0x98
+    array                  | array           | 0x99
+    array                  | array           | 0x9a
+    array                  | array           | 0x9b
+    array                  | array           | 0x9f
+    map                    | object          | 0xa0..0xb7
+    map                    | object          | 0xb8
+    map                    | object          | 0xb9
+    map                    | object          | 0xba
+    map                    | object          | 0xbb
+    map                    | object          | 0xbf
+    False                  | `false`         | 0xf4
+    True                   | `true`          | 0xf5
+    Nill                   | `null`          | 0xf6
+    Half-Precision Float   | number_float    | 0xf9
+    Single-Precision Float | number_float    | 0xfa
+    Double-Precision Float | number_float    | 0xfb
+
+    @warning The mapping is **incomplete** in the sense that not all CBOR
+             types can be converted to a JSON value. The following CBOR types
+             are not supported and will yield parse errors (parse_error.112):
+             - byte strings (0x40..0x5f)
+             - date/time (0xc0..0xc1)
+             - bignum (0xc2..0xc3)
+             - decimal fraction (0xc4)
+             - bigfloat (0xc5)
+             - tagged items (0xc6..0xd4, 0xd8..0xdb)
+             - expected conversions (0xd5..0xd7)
+             - simple values (0xe0..0xf3, 0xf8)
+             - undefined (0xf7)
+
+    @warning CBOR allows map keys of any type, whereas JSON only allows
+             strings as keys in object values. Therefore, CBOR maps with keys
+             other than UTF-8 strings are rejected (parse_error.113).
+
+    @note Any CBOR output created @ref to_cbor can be successfully parsed by
+          @ref from_cbor.
+
+    @param[in] v  a byte vector in CBOR format
+    @param[in] start_index the index to start reading from @a v (0 by default)
+    @return deserialized JSON value
+
+    @throw parse_error.110 if the given vector ends prematurely
+    @throw parse_error.112 if unsupported features from CBOR were
+    used in the given vector @a v or if the input is not valid CBOR
+    @throw parse_error.113 if a string was expected as map key, but not found
+
+    @complexity Linear in the size of the byte vector @a v.
+
+    @liveexample{The example shows the deserialization of a byte vector in CBOR
+    format to a JSON value.,from_cbor}
+
+    @sa http://cbor.io
+    @sa @ref to_cbor(const basic_json&) for the analogous serialization
+    @sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
+        related MessagePack format
+
+    @since version 2.0.9, parameter @a start_index since 2.1.1
+    */
+    static basic_json from_cbor(const std::vector<uint8_t>& v,
+                                const size_t start_index = 0)
+    {
+        size_t i = start_index;
+        return from_cbor_internal(v, i);
+    }
+
+    /// @}
+
+    ///////////////////////////
+    // convenience functions //
+    ///////////////////////////
+
+    /*!
+    @brief return the type as string
+
+    Returns the type name as string to be used in error messages - usually to
+    indicate that a function was called on a wrong JSON type.
+
+    @return basically a string representation of a the @a m_type member
+
+    @complexity Constant.
+
+    @liveexample{The following code exemplifies `type_name()` for all JSON
+    types.,type_name}
+
+    @since version 1.0.0, public since 2.1.0
+    */
+    std::string type_name() const
+    {
+        {
+            switch (m_type)
+            {
+                case value_t::null:
+                    return "null";
+                case value_t::object:
+                    return "object";
+                case value_t::array:
+                    return "array";
+                case value_t::string:
+                    return "string";
+                case value_t::boolean:
+                    return "boolean";
+                case value_t::discarded:
+                    return "discarded";
+                default:
+                    return "number";
+            }
+        }
+    }
+
+
+  private:
+    //////////////////////
+    // member variables //
+    //////////////////////
+
+    /// the type of the current element
+    value_t m_type = value_t::null;
+
+    /// the value of the current element
+    json_value m_value = {};
+
+
+  private:
+    ///////////////
+    // iterators //
+    ///////////////
+
+    /*!
+    @brief an iterator for primitive JSON types
+
+    This class models an iterator for primitive JSON types (boolean, number,
+    string). It's only purpose is to allow the iterator/const_iterator classes
+    to "iterate" over primitive values. Internally, the iterator is modeled by
+    a `difference_type` variable. Value begin_value (`0`) models the begin,
+    end_value (`1`) models past the end.
+    */
+    class primitive_iterator_t
+    {
+      public:
+
+        difference_type get_value() const noexcept
+        {
+            return m_it;
+        }
+        /// set iterator to a defined beginning
+        void set_begin() noexcept
+        {
+            m_it = begin_value;
+        }
+
+        /// set iterator to a defined past the end
+        void set_end() noexcept
+        {
+            m_it = end_value;
+        }
+
+        /// return whether the iterator can be dereferenced
+        constexpr bool is_begin() const noexcept
+        {
+            return (m_it == begin_value);
+        }
+
+        /// return whether the iterator is at end
+        constexpr bool is_end() const noexcept
+        {
+            return (m_it == end_value);
+        }
+
+        friend constexpr bool operator==(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it == rhs.m_it;
+        }
+
+        friend constexpr bool operator!=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return !(lhs == rhs);
+        }
+
+        friend constexpr bool operator<(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it < rhs.m_it;
+        }
+
+        friend constexpr bool operator<=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it <= rhs.m_it;
+        }
+
+        friend constexpr bool operator>(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it > rhs.m_it;
+        }
+
+        friend constexpr bool operator>=(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it >= rhs.m_it;
+        }
+
+        primitive_iterator_t operator+(difference_type i)
+        {
+            auto result = *this;
+            result += i;
+            return result;
+        }
+
+        friend constexpr difference_type operator-(primitive_iterator_t lhs, primitive_iterator_t rhs) noexcept
+        {
+            return lhs.m_it - rhs.m_it;
+        }
+
+        friend std::ostream& operator<<(std::ostream& os, primitive_iterator_t it)
+        {
+            return os << it.m_it;
+        }
+
+        primitive_iterator_t& operator++()
+        {
+            ++m_it;
+            return *this;
+        }
+
+        primitive_iterator_t operator++(int)
+        {
+            auto result = *this;
+            m_it++;
+            return result;
+        }
+
+        primitive_iterator_t& operator--()
+        {
+            --m_it;
+            return *this;
+        }
+
+        primitive_iterator_t operator--(int)
+        {
+            auto result = *this;
+            m_it--;
+            return result;
+        }
+
+        primitive_iterator_t& operator+=(difference_type n)
+        {
+            m_it += n;
+            return *this;
+        }
+
+        primitive_iterator_t& operator-=(difference_type n)
+        {
+            m_it -= n;
+            return *this;
+        }
+
+      private:
+        static constexpr difference_type begin_value = 0;
+        static constexpr difference_type end_value = begin_value + 1;
+
+        /// iterator as signed integer type
+        difference_type m_it = std::numeric_limits<std::ptrdiff_t>::denorm_min();
+    };
+
+    /*!
+    @brief an iterator value
+
+    @note This structure could easily be a union, but MSVC currently does not
+    allow unions members with complex constructors, see
+    https://github.com/nlohmann/json/pull/105.
+    */
+    struct internal_iterator
+    {
+        /// iterator for JSON objects
+        typename object_t::iterator object_iterator;
+        /// iterator for JSON arrays
+        typename array_t::iterator array_iterator;
+        /// generic iterator for all other types
+        primitive_iterator_t primitive_iterator;
+
+        /// create an uninitialized internal_iterator
+        internal_iterator() noexcept
+            : object_iterator(), array_iterator(), primitive_iterator()
+        {}
+    };
+
+    /// proxy class for the iterator_wrapper functions
+    template<typename IteratorType>
+    class iteration_proxy
+    {
+      private:
+        /// helper class for iteration
+        class iteration_proxy_internal
+        {
+          private:
+            /// the iterator
+            IteratorType anchor;
+            /// an index for arrays (used to create key names)
+            size_t array_index = 0;
+
+          public:
+            explicit iteration_proxy_internal(IteratorType it) noexcept
+                : anchor(it)
+            {}
+
+            /// dereference operator (needed for range-based for)
+            iteration_proxy_internal& operator*()
+            {
+                return *this;
+            }
+
+            /// increment operator (needed for range-based for)
+            iteration_proxy_internal& operator++()
+            {
+                ++anchor;
+                ++array_index;
+
+                return *this;
+            }
+
+            /// inequality operator (needed for range-based for)
+            bool operator!= (const iteration_proxy_internal& o) const
+            {
+                return anchor != o.anchor;
+            }
+
+            /// return key of the iterator
+            typename basic_json::string_t key() const
+            {
+                assert(anchor.m_object != nullptr);
+
+                switch (anchor.m_object->type())
+                {
+                    // use integer array index as key
+                    case value_t::array:
+                    {
+                        return std::to_string(array_index);
+                    }
+
+                    // use key from the object
+                    case value_t::object:
+                    {
+                        return anchor.key();
+                    }
+
+                    // use an empty key for all primitive types
+                    default:
+                    {
+                        return "";
+                    }
+                }
+            }
+
+            /// return value of the iterator
+            typename IteratorType::reference value() const
+            {
+                return anchor.value();
+            }
+        };
+
+        /// the container to iterate
+        typename IteratorType::reference container;
+
+      public:
+        /// construct iteration proxy from a container
+        explicit iteration_proxy(typename IteratorType::reference cont)
+            : container(cont)
+        {}
+
+        /// return iterator begin (needed for range-based for)
+        iteration_proxy_internal begin() noexcept
+        {
+            return iteration_proxy_internal(container.begin());
+        }
+
+        /// return iterator end (needed for range-based for)
+        iteration_proxy_internal end() noexcept
+        {
+            return iteration_proxy_internal(container.end());
+        }
+    };
+
+  public:
+    /*!
+    @brief a template for a random access iterator for the @ref basic_json class
+
+    This class implements a both iterators (iterator and const_iterator) for the
+    @ref basic_json class.
+
+    @note An iterator is called *initialized* when a pointer to a JSON value
+          has been set (e.g., by a constructor or a copy assignment). If the
+          iterator is default-constructed, it is *uninitialized* and most
+          methods are undefined. **The library uses assertions to detect calls
+          on uninitialized iterators.**
+
+    @requirement The class satisfies the following concept requirements:
+    - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator):
+      The iterator that can be moved to point (forward and backward) to any
+      element in constant time.
+
+    @since version 1.0.0, simplified in version 2.0.9
+    */
+    template<typename U>
+    class iter_impl : public std::iterator<std::random_access_iterator_tag, U>
+    {
+        /// allow basic_json to access private members
+        friend class basic_json;
+
+        // make sure U is basic_json or const basic_json
+        static_assert(std::is_same<U, basic_json>::value
+                      or std::is_same<U, const basic_json>::value,
+                      "iter_impl only accepts (const) basic_json");
+
+      public:
+        /// the type of the values when the iterator is dereferenced
+        using value_type = typename basic_json::value_type;
+        /// a type to represent differences between iterators
+        using difference_type = typename basic_json::difference_type;
+        /// defines a pointer to the type iterated over (value_type)
+        using pointer = typename std::conditional<std::is_const<U>::value,
+              typename basic_json::const_pointer,
+              typename basic_json::pointer>::type;
+        /// defines a reference to the type iterated over (value_type)
+        using reference = typename std::conditional<std::is_const<U>::value,
+              typename basic_json::const_reference,
+              typename basic_json::reference>::type;
+        /// the category of the iterator
+        using iterator_category = std::bidirectional_iterator_tag;
+
+        /// default constructor
+        iter_impl() = default;
+
+        /*!
+        @brief constructor for a given JSON instance
+        @param[in] object  pointer to a JSON object for this iterator
+        @pre object != nullptr
+        @post The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        explicit iter_impl(pointer object) noexcept
+            : m_object(object)
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    m_it.object_iterator = typename object_t::iterator();
+                    break;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    m_it.array_iterator = typename array_t::iterator();
+                    break;
+                }
+
+                default:
+                {
+                    m_it.primitive_iterator = primitive_iterator_t();
+                    break;
+                }
+            }
+        }
+
+        /*
+        Use operator `const_iterator` instead of `const_iterator(const iterator&
+        other) noexcept` to avoid two class definitions for @ref iterator and
+        @ref const_iterator.
+
+        This function is only called if this class is an @ref iterator. If this
+        class is a @ref const_iterator this function is not called.
+        */
+        operator const_iterator() const
+        {
+            const_iterator ret;
+
+            if (m_object)
+            {
+                ret.m_object = m_object;
+                ret.m_it = m_it;
+            }
+
+            return ret;
+        }
+
+        /*!
+        @brief copy constructor
+        @param[in] other  iterator to copy from
+        @note It is not checked whether @a other is initialized.
+        */
+        iter_impl(const iter_impl& other) noexcept
+            : m_object(other.m_object), m_it(other.m_it)
+        {}
+
+        /*!
+        @brief copy assignment
+        @param[in,out] other  iterator to copy from
+        @note It is not checked whether @a other is initialized.
+        */
+        iter_impl& operator=(iter_impl other) noexcept(
+            std::is_nothrow_move_constructible<pointer>::value and
+            std::is_nothrow_move_assignable<pointer>::value and
+            std::is_nothrow_move_constructible<internal_iterator>::value and
+            std::is_nothrow_move_assignable<internal_iterator>::value
+        )
+        {
+            std::swap(m_object, other.m_object);
+            std::swap(m_it, other.m_it);
+            return *this;
+        }
+
+      private:
+        /*!
+        @brief set the iterator to the first value
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        void set_begin() noexcept
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    m_it.object_iterator = m_object->m_value.object->begin();
+                    break;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    m_it.array_iterator = m_object->m_value.array->begin();
+                    break;
+                }
+
+                case basic_json::value_t::null:
+                {
+                    // set to end so begin()==end() is true: null is empty
+                    m_it.primitive_iterator.set_end();
+                    break;
+                }
+
+                default:
+                {
+                    m_it.primitive_iterator.set_begin();
+                    break;
+                }
+            }
+        }
+
+        /*!
+        @brief set the iterator past the last value
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        void set_end() noexcept
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    m_it.object_iterator = m_object->m_value.object->end();
+                    break;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    m_it.array_iterator = m_object->m_value.array->end();
+                    break;
+                }
+
+                default:
+                {
+                    m_it.primitive_iterator.set_end();
+                    break;
+                }
+            }
+        }
+
+      public:
+        /*!
+        @brief return a reference to the value pointed to by the iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        reference operator*() const
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    assert(m_it.object_iterator != m_object->m_value.object->end());
+                    return m_it.object_iterator->second;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    assert(m_it.array_iterator != m_object->m_value.array->end());
+                    return *m_it.array_iterator;
+                }
+
+                case basic_json::value_t::null:
+                {
+                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
+                }
+
+                default:
+                {
+                    if (m_it.primitive_iterator.is_begin())
+                    {
+                        return *m_object;
+                    }
+
+                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
+                }
+            }
+        }
+
+        /*!
+        @brief dereference the iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        pointer operator->() const
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    assert(m_it.object_iterator != m_object->m_value.object->end());
+                    return &(m_it.object_iterator->second);
+                }
+
+                case basic_json::value_t::array:
+                {
+                    assert(m_it.array_iterator != m_object->m_value.array->end());
+                    return &*m_it.array_iterator;
+                }
+
+                default:
+                {
+                    if (m_it.primitive_iterator.is_begin())
+                    {
+                        return m_object;
+                    }
+
+                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
+                }
+            }
+        }
+
+        /*!
+        @brief post-increment (it++)
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl operator++(int)
+        {
+            auto result = *this;
+            ++(*this);
+            return result;
+        }
+
+        /*!
+        @brief pre-increment (++it)
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl& operator++()
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    std::advance(m_it.object_iterator, 1);
+                    break;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    std::advance(m_it.array_iterator, 1);
+                    break;
+                }
+
+                default:
+                {
+                    ++m_it.primitive_iterator;
+                    break;
+                }
+            }
+
+            return *this;
+        }
+
+        /*!
+        @brief post-decrement (it--)
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl operator--(int)
+        {
+            auto result = *this;
+            --(*this);
+            return result;
+        }
+
+        /*!
+        @brief pre-decrement (--it)
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl& operator--()
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    std::advance(m_it.object_iterator, -1);
+                    break;
+                }
+
+                case basic_json::value_t::array:
+                {
+                    std::advance(m_it.array_iterator, -1);
+                    break;
+                }
+
+                default:
+                {
+                    --m_it.primitive_iterator;
+                    break;
+                }
+            }
+
+            return *this;
+        }
+
+        /*!
+        @brief  comparison: equal
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator==(const iter_impl& other) const
+        {
+            // if objects are not the same, the comparison is undefined
+            if (m_object != other.m_object)
+            {
+                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
+            }
+
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    return (m_it.object_iterator == other.m_it.object_iterator);
+                }
+
+                case basic_json::value_t::array:
+                {
+                    return (m_it.array_iterator == other.m_it.array_iterator);
+                }
+
+                default:
+                {
+                    return (m_it.primitive_iterator == other.m_it.primitive_iterator);
+                }
+            }
+        }
+
+        /*!
+        @brief  comparison: not equal
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator!=(const iter_impl& other) const
+        {
+            return not operator==(other);
+        }
+
+        /*!
+        @brief  comparison: smaller
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator<(const iter_impl& other) const
+        {
+            // if objects are not the same, the comparison is undefined
+            if (m_object != other.m_object)
+            {
+                JSON_THROW(invalid_iterator::create(212, "cannot compare iterators of different containers"));
+            }
+
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    JSON_THROW(invalid_iterator::create(213, "cannot compare order of object iterators"));
+                }
+
+                case basic_json::value_t::array:
+                {
+                    return (m_it.array_iterator < other.m_it.array_iterator);
+                }
+
+                default:
+                {
+                    return (m_it.primitive_iterator < other.m_it.primitive_iterator);
+                }
+            }
+        }
+
+        /*!
+        @brief  comparison: less than or equal
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator<=(const iter_impl& other) const
+        {
+            return not other.operator < (*this);
+        }
+
+        /*!
+        @brief  comparison: greater than
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator>(const iter_impl& other) const
+        {
+            return not operator<=(other);
+        }
+
+        /*!
+        @brief  comparison: greater than or equal
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        bool operator>=(const iter_impl& other) const
+        {
+            return not operator<(other);
+        }
+
+        /*!
+        @brief  add to iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl& operator+=(difference_type i)
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
+                }
+
+                case basic_json::value_t::array:
+                {
+                    std::advance(m_it.array_iterator, i);
+                    break;
+                }
+
+                default:
+                {
+                    m_it.primitive_iterator += i;
+                    break;
+                }
+            }
+
+            return *this;
+        }
+
+        /*!
+        @brief  subtract from iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl& operator-=(difference_type i)
+        {
+            return operator+=(-i);
+        }
+
+        /*!
+        @brief  add to iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl operator+(difference_type i)
+        {
+            auto result = *this;
+            result += i;
+            return result;
+        }
+
+        /*!
+        @brief  subtract from iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        iter_impl operator-(difference_type i)
+        {
+            auto result = *this;
+            result -= i;
+            return result;
+        }
+
+        /*!
+        @brief  return difference
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        difference_type operator-(const iter_impl& other) const
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    JSON_THROW(invalid_iterator::create(209, "cannot use offsets with object iterators"));
+                }
+
+                case basic_json::value_t::array:
+                {
+                    return m_it.array_iterator - other.m_it.array_iterator;
+                }
+
+                default:
+                {
+                    return m_it.primitive_iterator - other.m_it.primitive_iterator;
+                }
+            }
+        }
+
+        /*!
+        @brief  access to successor
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        reference operator[](difference_type n) const
+        {
+            assert(m_object != nullptr);
+
+            switch (m_object->m_type)
+            {
+                case basic_json::value_t::object:
+                {
+                    JSON_THROW(invalid_iterator::create(208, "cannot use operator[] for object iterators"));
+                }
+
+                case basic_json::value_t::array:
+                {
+                    return *std::next(m_it.array_iterator, n);
+                }
+
+                case basic_json::value_t::null:
+                {
+                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
+                }
+
+                default:
+                {
+                    if (m_it.primitive_iterator.get_value() == -n)
+                    {
+                        return *m_object;
+                    }
+
+                    JSON_THROW(invalid_iterator::create(214, "cannot get value"));
+                }
+            }
+        }
+
+        /*!
+        @brief  return the key of an object iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        typename object_t::key_type key() const
+        {
+            assert(m_object != nullptr);
+
+            if (m_object->is_object())
+            {
+                return m_it.object_iterator->first;
+            }
+
+            JSON_THROW(invalid_iterator::create(207, "cannot use key() for non-object iterators"));
+        }
+
+        /*!
+        @brief  return the value of an iterator
+        @pre The iterator is initialized; i.e. `m_object != nullptr`.
+        */
+        reference value() const
+        {
+            return operator*();
+        }
+
+      private:
+        /// associated JSON instance
+        pointer m_object = nullptr;
+        /// the actual iterator of the associated instance
+        internal_iterator m_it = internal_iterator();
+    };
+
+    /*!
+    @brief a template for a reverse iterator class
+
+    @tparam Base the base iterator type to reverse. Valid types are @ref
+    iterator (to create @ref reverse_iterator) and @ref const_iterator (to
+    create @ref const_reverse_iterator).
+
+    @requirement The class satisfies the following concept requirements:
+    - [RandomAccessIterator](http://en.cppreference.com/w/cpp/concept/RandomAccessIterator):
+      The iterator that can be moved to point (forward and backward) to any
+      element in constant time.
+    - [OutputIterator](http://en.cppreference.com/w/cpp/concept/OutputIterator):
+      It is possible to write to the pointed-to element (only if @a Base is
+      @ref iterator).
+
+    @since version 1.0.0
+    */
+    template<typename Base>
+    class json_reverse_iterator : public std::reverse_iterator<Base>
+    {
+      public:
+        /// shortcut to the reverse iterator adaptor
+        using base_iterator = std::reverse_iterator<Base>;
+        /// the reference type for the pointed-to element
+        using reference = typename Base::reference;
+
+        /// create reverse iterator from iterator
+        json_reverse_iterator(const typename base_iterator::iterator_type& it) noexcept
+            : base_iterator(it)
+        {}
+
+        /// create reverse iterator from base class
+        json_reverse_iterator(const base_iterator& it) noexcept
+            : base_iterator(it)
+        {}
+
+        /// post-increment (it++)
+        json_reverse_iterator operator++(int)
+        {
+            return base_iterator::operator++(1);
+        }
+
+        /// pre-increment (++it)
+        json_reverse_iterator& operator++()
+        {
+            base_iterator::operator++();
+            return *this;
+        }
+
+        /// post-decrement (it--)
+        json_reverse_iterator operator--(int)
+        {
+            return base_iterator::operator--(1);
+        }
+
+        /// pre-decrement (--it)
+        json_reverse_iterator& operator--()
+        {
+            base_iterator::operator--();
+            return *this;
+        }
+
+        /// add to iterator
+        json_reverse_iterator& operator+=(difference_type i)
+        {
+            base_iterator::operator+=(i);
+            return *this;
+        }
+
+        /// add to iterator
+        json_reverse_iterator operator+(difference_type i) const
+        {
+            auto result = *this;
+            result += i;
+            return result;
+        }
+
+        /// subtract from iterator
+        json_reverse_iterator operator-(difference_type i) const
+        {
+            auto result = *this;
+            result -= i;
+            return result;
+        }
+
+        /// return difference
+        difference_type operator-(const json_reverse_iterator& other) const
+        {
+            return this->base() - other.base();
+        }
+
+        /// access to successor
+        reference operator[](difference_type n) const
+        {
+            return *(this->operator+(n));
+        }
+
+        /// return the key of an object iterator
+        typename object_t::key_type key() const
+        {
+            auto it = --this->base();
+            return it.key();
+        }
+
+        /// return the value of an iterator
+        reference value() const
+        {
+            auto it = --this->base();
+            return it.operator * ();
+        }
+    };
+
+
+  private:
+    //////////////////////
+    // lexer and parser //
+    //////////////////////
+
+    /*!
+    @brief lexical analysis
+
+    This class organizes the lexical analysis during JSON deserialization. The
+    core of it is a scanner generated by [re2c](http://re2c.org) that
+    processes a buffer and recognizes tokens according to RFC 7159.
+    */
+    class lexer
+    {
+      public:
+        /// token types for the parser
+        enum class token_type
+        {
+            uninitialized,   ///< indicating the scanner is uninitialized
+            literal_true,    ///< the `true` literal
+            literal_false,   ///< the `false` literal
+            literal_null,    ///< the `null` literal
+            value_string,    ///< a string -- use get_string() for actual value
+            value_unsigned,  ///< an unsigned integer -- use get_number() for actual value
+            value_integer,   ///< a signed integer -- use get_number() for actual value
+            value_float,     ///< an floating point number -- use get_number() for actual value
+            begin_array,     ///< the character for array begin `[`
+            begin_object,    ///< the character for object begin `{`
+            end_array,       ///< the character for array end `]`
+            end_object,      ///< the character for object end `}`
+            name_separator,  ///< the name separator `:`
+            value_separator, ///< the value separator `,`
+            parse_error,     ///< indicating a parse error
+            end_of_input     ///< indicating the end of the input buffer
+        };
+
+        /// the char type to use in the lexer
+        using lexer_char_t = unsigned char;
+
+        /// a lexer from a buffer with given length
+        lexer(const lexer_char_t* buff, const size_t len) noexcept
+            : m_content(buff)
+        {
+            assert(m_content != nullptr);
+            m_start = m_cursor = m_content;
+            m_limit = m_content + len;
+        }
+
+        /*!
+        @brief a lexer from an input stream
+        @throw parse_error.111 if input stream is in a bad state
+        */
+        explicit lexer(std::istream& s)
+            : m_stream(&s), m_line_buffer()
+        {
+            // immediately abort if stream is erroneous
+            if (s.fail())
+            {
+                JSON_THROW(parse_error::create(111, 0, "bad input stream"));
+            }
+
+            // fill buffer
+            fill_line_buffer();
+
+            // skip UTF-8 byte-order mark
+            if (m_line_buffer.size() >= 3 and m_line_buffer.substr(0, 3) == "\xEF\xBB\xBF")
+            {
+                m_line_buffer[0] = ' ';
+                m_line_buffer[1] = ' ';
+                m_line_buffer[2] = ' ';
+            }
+        }
+
+        // switch off unwanted functions (due to pointer members)
+        lexer() = delete;
+        lexer(const lexer&) = delete;
+        lexer operator=(const lexer&) = delete;
+
+        /*!
+        @brief create a string from one or two Unicode code points
+
+        There are two cases: (1) @a codepoint1 is in the Basic Multilingual
+        Plane (U+0000 through U+FFFF) and @a codepoint2 is 0, or (2)
+        @a codepoint1 and @a codepoint2 are a UTF-16 surrogate pair to
+        represent a code point above U+FFFF.
+
+        @param[in] codepoint1  the code point (can be high surrogate)
+        @param[in] codepoint2  the code point (can be low surrogate or 0)
+
+        @return string representation of the code point; the length of the
+        result string is between 1 and 4 characters.
+
+        @throw parse_error.102 if the low surrogate is invalid; example:
+        `""missing or wrong low surrogate""`
+        @throw parse_error.103 if code point is > 0x10ffff; example: `"code
+        points above 0x10FFFF are invalid"`
+
+        @complexity Constant.
+
+        @see <http://en.wikipedia.org/wiki/UTF-8#Sample_code>
+        */
+        string_t to_unicode(const std::size_t codepoint1,
+                            const std::size_t codepoint2 = 0) const
+        {
+            // calculate the code point from the given code points
+            std::size_t codepoint = codepoint1;
+
+            // check if codepoint1 is a high surrogate
+            if (codepoint1 >= 0xD800 and codepoint1 <= 0xDBFF)
+            {
+                // check if codepoint2 is a low surrogate
+                if (codepoint2 >= 0xDC00 and codepoint2 <= 0xDFFF)
+                {
+                    codepoint =
+                        // high surrogate occupies the most significant 22 bits
+                        (codepoint1 << 10)
+                        // low surrogate occupies the least significant 15 bits
+                        + codepoint2
+                        // there is still the 0xD800, 0xDC00 and 0x10000 noise
+                        // in the result so we have to subtract with:
+                        // (0xD800 << 10) + DC00 - 0x10000 = 0x35FDC00
+                        - 0x35FDC00;
+                }
+                else
+                {
+                    JSON_THROW(parse_error::create(102, get_position(), "missing or wrong low surrogate"));
+                }
+            }
+
+            string_t result;
+
+            if (codepoint < 0x80)
+            {
+                // 1-byte characters: 0xxxxxxx (ASCII)
+                result.append(1, static_cast<typename string_t::value_type>(codepoint));
+            }
+            else if (codepoint <= 0x7ff)
+            {
+                // 2-byte characters: 110xxxxx 10xxxxxx
+                result.append(1, static_cast<typename string_t::value_type>(0xC0 | (codepoint >> 6)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
+            }
+            else if (codepoint <= 0xffff)
+            {
+                // 3-byte characters: 1110xxxx 10xxxxxx 10xxxxxx
+                result.append(1, static_cast<typename string_t::value_type>(0xE0 | (codepoint >> 12)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 6) & 0x3F)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
+            }
+            else if (codepoint <= 0x10ffff)
+            {
+                // 4-byte characters: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
+                result.append(1, static_cast<typename string_t::value_type>(0xF0 | (codepoint >> 18)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 12) & 0x3F)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | ((codepoint >> 6) & 0x3F)));
+                result.append(1, static_cast<typename string_t::value_type>(0x80 | (codepoint & 0x3F)));
+            }
+            else
+            {
+                JSON_THROW(parse_error::create(103, get_position(), "code points above 0x10FFFF are invalid"));
+            }
+
+            return result;
+        }
+
+        /// return name of values of type token_type (only used for errors)
+        static std::string token_type_name(const token_type t)
+        {
+            switch (t)
+            {
+                case token_type::uninitialized:
+                    return "<uninitialized>";
+                case token_type::literal_true:
+                    return "true literal";
+                case token_type::literal_false:
+                    return "false literal";
+                case token_type::literal_null:
+                    return "null literal";
+                case token_type::value_string:
+                    return "string literal";
+                case lexer::token_type::value_unsigned:
+                case lexer::token_type::value_integer:
+                case lexer::token_type::value_float:
+                    return "number literal";
+                case token_type::begin_array:
+                    return "'['";
+                case token_type::begin_object:
+                    return "'{'";
+                case token_type::end_array:
+                    return "']'";
+                case token_type::end_object:
+                    return "'}'";
+                case token_type::name_separator:
+                    return "':'";
+                case token_type::value_separator:
+                    return "','";
+                case token_type::parse_error:
+                    return "<parse error>";
+                case token_type::end_of_input:
+                    return "end of input";
+                default:
+                {
+                    // catch non-enum values
+                    return "unknown token"; // LCOV_EXCL_LINE
+                }
+            }
+        }
+
+        /*!
+        This function implements a scanner for JSON. It is specified using
+        regular expressions that try to follow RFC 7159 as close as possible.
+        These regular expressions are then translated into a minimized
+        deterministic finite automaton (DFA) by the tool
+        [re2c](http://re2c.org). As a result, the translated code for this
+        function consists of a large block of code with `goto` jumps.
+
+        @return the class of the next token read from the buffer
+
+        @complexity Linear in the length of the input.\n
+
+        Proposition: The loop below will always terminate for finite input.\n
+
+        Proof (by contradiction): Assume a finite input. To loop forever, the
+        loop must never hit code with a `break` statement. The only code
+        snippets without a `break` statement is the continue statement for
+        whitespace. To loop forever, the input must be an infinite sequence
+        whitespace. This contradicts the assumption of finite input, q.e.d.
+        */
+        token_type scan()
+        {
+            while (true)
+            {
+                // pointer for backtracking information
+                m_marker = nullptr;
+
+                // remember the begin of the token
+                m_start = m_cursor;
+                assert(m_start != nullptr);
+
+
+                {
+                    lexer_char_t yych;
+                    unsigned int yyaccept = 0;
+                    static const unsigned char yybm[] =
+                    {
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,  32,  32,   0,   0,  32,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        160, 128,   0, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        192, 192, 192, 192, 192, 192, 192, 192,
+                        192, 192, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128,   0, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        128, 128, 128, 128, 128, 128, 128, 128,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                        0,   0,   0,   0,   0,   0,   0,   0,
+                    };
+                    if ((m_limit - m_cursor) < 5)
+                    {
+                        fill_line_buffer(5);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yybm[0 + yych] & 32)
+                    {
+                        goto basic_json_parser_6;
+                    }
+                    if (yych <= '[')
+                    {
+                        if (yych <= '-')
+                        {
+                            if (yych <= '"')
+                            {
+                                if (yych <= 0x00)
+                                {
+                                    goto basic_json_parser_2;
+                                }
+                                if (yych <= '!')
+                                {
+                                    goto basic_json_parser_4;
+                                }
+                                goto basic_json_parser_9;
+                            }
+                            else
+                            {
+                                if (yych <= '+')
+                                {
+                                    goto basic_json_parser_4;
+                                }
+                                if (yych <= ',')
+                                {
+                                    goto basic_json_parser_10;
+                                }
+                                goto basic_json_parser_12;
+                            }
+                        }
+                        else
+                        {
+                            if (yych <= '9')
+                            {
+                                if (yych <= '/')
+                                {
+                                    goto basic_json_parser_4;
+                                }
+                                if (yych <= '0')
+                                {
+                                    goto basic_json_parser_13;
+                                }
+                                goto basic_json_parser_15;
+                            }
+                            else
+                            {
+                                if (yych <= ':')
+                                {
+                                    goto basic_json_parser_17;
+                                }
+                                if (yych <= 'Z')
+                                {
+                                    goto basic_json_parser_4;
+                                }
+                                goto basic_json_parser_19;
+                            }
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 'n')
+                        {
+                            if (yych <= 'e')
+                            {
+                                if (yych == ']')
+                                {
+                                    goto basic_json_parser_21;
+                                }
+                                goto basic_json_parser_4;
+                            }
+                            else
+                            {
+                                if (yych <= 'f')
+                                {
+                                    goto basic_json_parser_23;
+                                }
+                                if (yych <= 'm')
+                                {
+                                    goto basic_json_parser_4;
+                                }
+                                goto basic_json_parser_24;
+                            }
+                        }
+                        else
+                        {
+                            if (yych <= 'z')
+                            {
+                                if (yych == 't')
+                                {
+                                    goto basic_json_parser_25;
+                                }
+                                goto basic_json_parser_4;
+                            }
+                            else
+                            {
+                                if (yych <= '{')
+                                {
+                                    goto basic_json_parser_26;
+                                }
+                                if (yych == '}')
+                                {
+                                    goto basic_json_parser_28;
+                                }
+                                goto basic_json_parser_4;
+                            }
+                        }
+                    }
+basic_json_parser_2:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::end_of_input;
+                        break;
+                    }
+basic_json_parser_4:
+                    ++m_cursor;
+basic_json_parser_5:
+                    {
+                        last_token_type = token_type::parse_error;
+                        break;
+                    }
+basic_json_parser_6:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yybm[0 + yych] & 32)
+                    {
+                        goto basic_json_parser_6;
+                    }
+                    {
+                        position += static_cast<size_t>((m_cursor - m_start));
+                        continue;
+                    }
+basic_json_parser_9:
+                    yyaccept = 0;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych <= 0x1F)
+                    {
+                        goto basic_json_parser_5;
+                    }
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_31;
+                    }
+                    if (yych <= 0xC1)
+                    {
+                        goto basic_json_parser_5;
+                    }
+                    if (yych <= 0xF4)
+                    {
+                        goto basic_json_parser_31;
+                    }
+                    goto basic_json_parser_5;
+basic_json_parser_10:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::value_separator;
+                        break;
+                    }
+basic_json_parser_12:
+                    yych = *++m_cursor;
+                    if (yych <= '/')
+                    {
+                        goto basic_json_parser_5;
+                    }
+                    if (yych <= '0')
+                    {
+                        goto basic_json_parser_43;
+                    }
+                    if (yych <= '9')
+                    {
+                        goto basic_json_parser_45;
+                    }
+                    goto basic_json_parser_5;
+basic_json_parser_13:
+                    yyaccept = 1;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych <= '9')
+                    {
+                        if (yych == '.')
+                        {
+                            goto basic_json_parser_47;
+                        }
+                        if (yych >= '0')
+                        {
+                            goto basic_json_parser_48;
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 'E')
+                        {
+                            if (yych >= 'E')
+                            {
+                                goto basic_json_parser_51;
+                            }
+                        }
+                        else
+                        {
+                            if (yych == 'e')
+                            {
+                                goto basic_json_parser_51;
+                            }
+                        }
+                    }
+basic_json_parser_14:
+                    {
+                        last_token_type = token_type::value_unsigned;
+                        break;
+                    }
+basic_json_parser_15:
+                    yyaccept = 1;
+                    m_marker = ++m_cursor;
+                    if ((m_limit - m_cursor) < 3)
+                    {
+                        fill_line_buffer(3);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yybm[0 + yych] & 64)
+                    {
+                        goto basic_json_parser_15;
+                    }
+                    if (yych <= 'D')
+                    {
+                        if (yych == '.')
+                        {
+                            goto basic_json_parser_47;
+                        }
+                        goto basic_json_parser_14;
+                    }
+                    else
+                    {
+                        if (yych <= 'E')
+                        {
+                            goto basic_json_parser_51;
+                        }
+                        if (yych == 'e')
+                        {
+                            goto basic_json_parser_51;
+                        }
+                        goto basic_json_parser_14;
+                    }
+basic_json_parser_17:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::name_separator;
+                        break;
+                    }
+basic_json_parser_19:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::begin_array;
+                        break;
+                    }
+basic_json_parser_21:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::end_array;
+                        break;
+                    }
+basic_json_parser_23:
+                    yyaccept = 0;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych == 'a')
+                    {
+                        goto basic_json_parser_52;
+                    }
+                    goto basic_json_parser_5;
+basic_json_parser_24:
+                    yyaccept = 0;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych == 'u')
+                    {
+                        goto basic_json_parser_53;
+                    }
+                    goto basic_json_parser_5;
+basic_json_parser_25:
+                    yyaccept = 0;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych == 'r')
+                    {
+                        goto basic_json_parser_54;
+                    }
+                    goto basic_json_parser_5;
+basic_json_parser_26:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::begin_object;
+                        break;
+                    }
+basic_json_parser_28:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::end_object;
+                        break;
+                    }
+basic_json_parser_30:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+basic_json_parser_31:
+                    if (yybm[0 + yych] & 128)
+                    {
+                        goto basic_json_parser_30;
+                    }
+                    if (yych <= 0xE0)
+                    {
+                        if (yych <= '\\')
+                        {
+                            if (yych <= 0x1F)
+                            {
+                                goto basic_json_parser_32;
+                            }
+                            if (yych <= '"')
+                            {
+                                goto basic_json_parser_33;
+                            }
+                            goto basic_json_parser_35;
+                        }
+                        else
+                        {
+                            if (yych <= 0xC1)
+                            {
+                                goto basic_json_parser_32;
+                            }
+                            if (yych <= 0xDF)
+                            {
+                                goto basic_json_parser_36;
+                            }
+                            goto basic_json_parser_37;
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 0xEF)
+                        {
+                            if (yych == 0xED)
+                            {
+                                goto basic_json_parser_39;
+                            }
+                            goto basic_json_parser_38;
+                        }
+                        else
+                        {
+                            if (yych <= 0xF0)
+                            {
+                                goto basic_json_parser_40;
+                            }
+                            if (yych <= 0xF3)
+                            {
+                                goto basic_json_parser_41;
+                            }
+                            if (yych <= 0xF4)
+                            {
+                                goto basic_json_parser_42;
+                            }
+                        }
+                    }
+basic_json_parser_32:
+                    m_cursor = m_marker;
+                    if (yyaccept <= 1)
+                    {
+                        if (yyaccept == 0)
+                        {
+                            goto basic_json_parser_5;
+                        }
+                        else
+                        {
+                            goto basic_json_parser_14;
+                        }
+                    }
+                    else
+                    {
+                        if (yyaccept == 2)
+                        {
+                            goto basic_json_parser_44;
+                        }
+                        else
+                        {
+                            goto basic_json_parser_58;
+                        }
+                    }
+basic_json_parser_33:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::value_string;
+                        break;
+                    }
+basic_json_parser_35:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 'e')
+                    {
+                        if (yych <= '/')
+                        {
+                            if (yych == '"')
+                            {
+                                goto basic_json_parser_30;
+                            }
+                            if (yych <= '.')
+                            {
+                                goto basic_json_parser_32;
+                            }
+                            goto basic_json_parser_30;
+                        }
+                        else
+                        {
+                            if (yych <= '\\')
+                            {
+                                if (yych <= '[')
+                                {
+                                    goto basic_json_parser_32;
+                                }
+                                goto basic_json_parser_30;
+                            }
+                            else
+                            {
+                                if (yych == 'b')
+                                {
+                                    goto basic_json_parser_30;
+                                }
+                                goto basic_json_parser_32;
+                            }
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 'q')
+                        {
+                            if (yych <= 'f')
+                            {
+                                goto basic_json_parser_30;
+                            }
+                            if (yych == 'n')
+                            {
+                                goto basic_json_parser_30;
+                            }
+                            goto basic_json_parser_32;
+                        }
+                        else
+                        {
+                            if (yych <= 's')
+                            {
+                                if (yych <= 'r')
+                                {
+                                    goto basic_json_parser_30;
+                                }
+                                goto basic_json_parser_32;
+                            }
+                            else
+                            {
+                                if (yych <= 't')
+                                {
+                                    goto basic_json_parser_30;
+                                }
+                                if (yych <= 'u')
+                                {
+                                    goto basic_json_parser_55;
+                                }
+                                goto basic_json_parser_32;
+                            }
+                        }
+                    }
+basic_json_parser_36:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0xBF)
+                    {
+                        goto basic_json_parser_30;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_37:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x9F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0xBF)
+                    {
+                        goto basic_json_parser_36;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_38:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0xBF)
+                    {
+                        goto basic_json_parser_36;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_39:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0x9F)
+                    {
+                        goto basic_json_parser_36;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_40:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x8F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0xBF)
+                    {
+                        goto basic_json_parser_38;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_41:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0xBF)
+                    {
+                        goto basic_json_parser_38;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_42:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 0x7F)
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= 0x8F)
+                    {
+                        goto basic_json_parser_38;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_43:
+                    yyaccept = 2;
+                    yych = *(m_marker = ++m_cursor);
+                    if (yych <= '9')
+                    {
+                        if (yych == '.')
+                        {
+                            goto basic_json_parser_47;
+                        }
+                        if (yych >= '0')
+                        {
+                            goto basic_json_parser_48;
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 'E')
+                        {
+                            if (yych >= 'E')
+                            {
+                                goto basic_json_parser_51;
+                            }
+                        }
+                        else
+                        {
+                            if (yych == 'e')
+                            {
+                                goto basic_json_parser_51;
+                            }
+                        }
+                    }
+basic_json_parser_44:
+                    {
+                        last_token_type = token_type::value_integer;
+                        break;
+                    }
+basic_json_parser_45:
+                    yyaccept = 2;
+                    m_marker = ++m_cursor;
+                    if ((m_limit - m_cursor) < 3)
+                    {
+                        fill_line_buffer(3);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '9')
+                    {
+                        if (yych == '.')
+                        {
+                            goto basic_json_parser_47;
+                        }
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_44;
+                        }
+                        goto basic_json_parser_45;
+                    }
+                    else
+                    {
+                        if (yych <= 'E')
+                        {
+                            if (yych <= 'D')
+                            {
+                                goto basic_json_parser_44;
+                            }
+                            goto basic_json_parser_51;
+                        }
+                        else
+                        {
+                            if (yych == 'e')
+                            {
+                                goto basic_json_parser_51;
+                            }
+                            goto basic_json_parser_44;
+                        }
+                    }
+basic_json_parser_47:
+                    yych = *++m_cursor;
+                    if (yych <= '/')
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych <= '9')
+                    {
+                        goto basic_json_parser_56;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_48:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '/')
+                    {
+                        goto basic_json_parser_50;
+                    }
+                    if (yych <= '9')
+                    {
+                        goto basic_json_parser_48;
+                    }
+basic_json_parser_50:
+                    {
+                        last_token_type = token_type::parse_error;
+                        break;
+                    }
+basic_json_parser_51:
+                    yych = *++m_cursor;
+                    if (yych <= ',')
+                    {
+                        if (yych == '+')
+                        {
+                            goto basic_json_parser_59;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                    else
+                    {
+                        if (yych <= '-')
+                        {
+                            goto basic_json_parser_59;
+                        }
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_60;
+                        }
+                        goto basic_json_parser_32;
+                    }
+basic_json_parser_52:
+                    yych = *++m_cursor;
+                    if (yych == 'l')
+                    {
+                        goto basic_json_parser_62;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_53:
+                    yych = *++m_cursor;
+                    if (yych == 'l')
+                    {
+                        goto basic_json_parser_63;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_54:
+                    yych = *++m_cursor;
+                    if (yych == 'u')
+                    {
+                        goto basic_json_parser_64;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_55:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '@')
+                    {
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_65;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                    else
+                    {
+                        if (yych <= 'F')
+                        {
+                            goto basic_json_parser_65;
+                        }
+                        if (yych <= '`')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= 'f')
+                        {
+                            goto basic_json_parser_65;
+                        }
+                        goto basic_json_parser_32;
+                    }
+basic_json_parser_56:
+                    yyaccept = 3;
+                    m_marker = ++m_cursor;
+                    if ((m_limit - m_cursor) < 3)
+                    {
+                        fill_line_buffer(3);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= 'D')
+                    {
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_58;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_56;
+                        }
+                    }
+                    else
+                    {
+                        if (yych <= 'E')
+                        {
+                            goto basic_json_parser_51;
+                        }
+                        if (yych == 'e')
+                        {
+                            goto basic_json_parser_51;
+                        }
+                    }
+basic_json_parser_58:
+                    {
+                        last_token_type = token_type::value_float;
+                        break;
+                    }
+basic_json_parser_59:
+                    yych = *++m_cursor;
+                    if (yych <= '/')
+                    {
+                        goto basic_json_parser_32;
+                    }
+                    if (yych >= ':')
+                    {
+                        goto basic_json_parser_32;
+                    }
+basic_json_parser_60:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '/')
+                    {
+                        goto basic_json_parser_58;
+                    }
+                    if (yych <= '9')
+                    {
+                        goto basic_json_parser_60;
+                    }
+                    goto basic_json_parser_58;
+basic_json_parser_62:
+                    yych = *++m_cursor;
+                    if (yych == 's')
+                    {
+                        goto basic_json_parser_66;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_63:
+                    yych = *++m_cursor;
+                    if (yych == 'l')
+                    {
+                        goto basic_json_parser_67;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_64:
+                    yych = *++m_cursor;
+                    if (yych == 'e')
+                    {
+                        goto basic_json_parser_69;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_65:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '@')
+                    {
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_71;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                    else
+                    {
+                        if (yych <= 'F')
+                        {
+                            goto basic_json_parser_71;
+                        }
+                        if (yych <= '`')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= 'f')
+                        {
+                            goto basic_json_parser_71;
+                        }
+                        goto basic_json_parser_32;
+                    }
+basic_json_parser_66:
+                    yych = *++m_cursor;
+                    if (yych == 'e')
+                    {
+                        goto basic_json_parser_72;
+                    }
+                    goto basic_json_parser_32;
+basic_json_parser_67:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::literal_null;
+                        break;
+                    }
+basic_json_parser_69:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::literal_true;
+                        break;
+                    }
+basic_json_parser_71:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '@')
+                    {
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_74;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                    else
+                    {
+                        if (yych <= 'F')
+                        {
+                            goto basic_json_parser_74;
+                        }
+                        if (yych <= '`')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= 'f')
+                        {
+                            goto basic_json_parser_74;
+                        }
+                        goto basic_json_parser_32;
+                    }
+basic_json_parser_72:
+                    ++m_cursor;
+                    {
+                        last_token_type = token_type::literal_false;
+                        break;
+                    }
+basic_json_parser_74:
+                    ++m_cursor;
+                    if (m_limit <= m_cursor)
+                    {
+                        fill_line_buffer(1);    // LCOV_EXCL_LINE
+                    }
+                    yych = *m_cursor;
+                    if (yych <= '@')
+                    {
+                        if (yych <= '/')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= '9')
+                        {
+                            goto basic_json_parser_30;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                    else
+                    {
+                        if (yych <= 'F')
+                        {
+                            goto basic_json_parser_30;
+                        }
+                        if (yych <= '`')
+                        {
+                            goto basic_json_parser_32;
+                        }
+                        if (yych <= 'f')
+                        {
+                            goto basic_json_parser_30;
+                        }
+                        goto basic_json_parser_32;
+                    }
+                }
+
+            }
+
+            position += static_cast<size_t>((m_cursor - m_start));
+            return last_token_type;
+        }
+
+        /*!
+        @brief append data from the stream to the line buffer
+
+        This function is called by the scan() function when the end of the
+        buffer (`m_limit`) is reached and the `m_cursor` pointer cannot be
+        incremented without leaving the limits of the line buffer. Note re2c
+        decides when to call this function.
+
+        If the lexer reads from contiguous storage, there is no trailing null
+        byte. Therefore, this function must make sure to add these padding
+        null bytes.
+
+        If the lexer reads from an input stream, this function reads the next
+        line of the input.
+
+        @pre
+            p p p p p p u u u u u x . . . . . .
+            ^           ^       ^   ^
+            m_content   m_start |   m_limit
+                                m_cursor
+
+        @post
+            u u u u u x x x x x x x . . . . . .
+            ^       ^               ^
+            |       m_cursor        m_limit
+            m_start
+            m_content
+        */
+        void fill_line_buffer(size_t n = 0)
+        {
+            // if line buffer is used, m_content points to its data
+            assert(m_line_buffer.empty()
+                   or m_content == reinterpret_cast<const lexer_char_t*>(m_line_buffer.data()));
+
+            // if line buffer is used, m_limit is set past the end of its data
+            assert(m_line_buffer.empty()
+                   or m_limit == m_content + m_line_buffer.size());
+
+            // pointer relationships
+            assert(m_content <= m_start);
+            assert(m_start <= m_cursor);
+            assert(m_cursor <= m_limit);
+            assert(m_marker == nullptr or m_marker  <= m_limit);
+
+            // number of processed characters (p)
+            const auto num_processed_chars = static_cast<size_t>(m_start - m_content);
+            // offset for m_marker wrt. to m_start
+            const auto offset_marker = (m_marker == nullptr) ? 0 : m_marker - m_start;
+            // number of unprocessed characters (u)
+            const auto offset_cursor = m_cursor - m_start;
+
+            // no stream is used or end of file is reached
+            if (m_stream == nullptr or m_stream->eof())
+            {
+                // m_start may or may not be pointing into m_line_buffer at
+                // this point. We trust the standard library to do the right
+                // thing. See http://stackoverflow.com/q/28142011/266378
+                m_line_buffer.assign(m_start, m_limit);
+
+                // append n characters to make sure that there is sufficient
+                // space between m_cursor and m_limit
+                m_line_buffer.append(1, '\x00');
+                if (n > 0)
+                {
+                    m_line_buffer.append(n - 1, '\x01');
+                }
+            }
+            else
+            {
+                // delete processed characters from line buffer
+                m_line_buffer.erase(0, num_processed_chars);
+                // read next line from input stream
+                m_line_buffer_tmp.clear();
+
+                // check if stream is still good
+                if (m_stream->fail())
+                {
+                    JSON_THROW(parse_error::create(111, 0, "bad input stream"));
+                }
+
+                std::getline(*m_stream, m_line_buffer_tmp, '\n');
+
+                // add line with newline symbol to the line buffer
+                m_line_buffer += m_line_buffer_tmp;
+                m_line_buffer.push_back('\n');
+            }
+
+            // set pointers
+            m_content = reinterpret_cast<const lexer_char_t*>(m_line_buffer.data());
+            assert(m_content != nullptr);
+            m_start  = m_content;
+            m_marker = m_start + offset_marker;
+            m_cursor = m_start + offset_cursor;
+            m_limit  = m_start + m_line_buffer.size();
+        }
+
+        /// return string representation of last read token
+        string_t get_token_string() const
+        {
+            assert(m_start != nullptr);
+            return string_t(reinterpret_cast<typename string_t::const_pointer>(m_start),
+                            static_cast<size_t>(m_cursor - m_start));
+        }
+
+        /*!
+        @brief return string value for string tokens
+
+        The function iterates the characters between the opening and closing
+        quotes of the string value. The complete string is the range
+        [m_start,m_cursor). Consequently, we iterate from m_start+1 to
+        m_cursor-1.
+
+        We differentiate two cases:
+
+        1. Escaped characters. In this case, a new character is constructed
+           according to the nature of the escape. Some escapes create new
+           characters (e.g., `"\\n"` is replaced by `"\n"`), some are copied
+           as is (e.g., `"\\\\"`). Furthermore, Unicode escapes of the shape
+           `"\\uxxxx"` need special care. In this case, to_unicode takes care
+           of the construction of the values.
+        2. Unescaped characters are copied as is.
+
+        @pre `m_cursor - m_start >= 2`, meaning the length of the last token
+        is at least 2 bytes which is trivially true for any string (which
+        consists of at least two quotes).
+
+            " c1 c2 c3 ... "
+            ^                ^
+            m_start          m_cursor
+
+        @complexity Linear in the length of the string.\n
+
+        Lemma: The loop body will always terminate.\n
+
+        Proof (by contradiction): Assume the loop body does not terminate. As
+        the loop body does not contain another loop, one of the called
+        functions must never return. The called functions are `std::strtoul`
+        and to_unicode. Neither function can loop forever, so the loop body
+        will never loop forever which contradicts the assumption that the loop
+        body does not terminate, q.e.d.\n
+
+        Lemma: The loop condition for the for loop is eventually false.\n
+
+        Proof (by contradiction): Assume the loop does not terminate. Due to
+        the above lemma, this can only be due to a tautological loop
+        condition; that is, the loop condition i < m_cursor - 1 must always be
+        true. Let x be the change of i for any loop iteration. Then
+        m_start + 1 + x < m_cursor - 1 must hold to loop indefinitely. This
+        can be rephrased to m_cursor - m_start - 2 > x. With the
+        precondition, we x <= 0, meaning that the loop condition holds
+        indefinitely if i is always decreased. However, observe that the value
+        of i is strictly increasing with each iteration, as it is incremented
+        by 1 in the iteration expression and never decremented inside the loop
+        body. Hence, the loop condition will eventually be false which
+        contradicts the assumption that the loop condition is a tautology,
+        q.e.d.
+
+        @return string value of current token without opening and closing
+        quotes
+        @throw parse_error.102 if to_unicode fails or surrogate error
+        @throw parse_error.103 if to_unicode fails
+        */
+        string_t get_string() const
+        {
+            assert(m_cursor - m_start >= 2);
+
+            string_t result;
+            result.reserve(static_cast<size_t>(m_cursor - m_start - 2));
+
+            // iterate the result between the quotes
+            for (const lexer_char_t* i = m_start + 1; i < m_cursor - 1; ++i)
+            {
+                // find next escape character
+                auto e = std::find(i, m_cursor - 1, '\\');
+                if (e != i)
+                {
+                    // see https://github.com/nlohmann/json/issues/365#issuecomment-262874705
+                    for (auto k = i; k < e; k++)
+                    {
+                        result.push_back(static_cast<typename string_t::value_type>(*k));
+                    }
+                    i = e - 1; // -1 because of ++i
+                }
+                else
+                {
+                    // processing escaped character
+                    // read next character
+                    ++i;
+
+                    switch (*i)
+                    {
+                        // the default escapes
+                        case 't':
+                        {
+                            result += "\t";
+                            break;
+                        }
+                        case 'b':
+                        {
+                            result += "\b";
+                            break;
+                        }
+                        case 'f':
+                        {
+                            result += "\f";
+                            break;
+                        }
+                        case 'n':
+                        {
+                            result += "\n";
+                            break;
+                        }
+                        case 'r':
+                        {
+                            result += "\r";
+                            break;
+                        }
+                        case '\\':
+                        {
+                            result += "\\";
+                            break;
+                        }
+                        case '/':
+                        {
+                            result += "/";
+                            break;
+                        }
+                        case '"':
+                        {
+                            result += "\"";
+                            break;
+                        }
+
+                        // unicode
+                        case 'u':
+                        {
+                            // get code xxxx from uxxxx
+                            auto codepoint = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>(i + 1),
+                                                          4).c_str(), nullptr, 16);
+
+                            // check if codepoint is a high surrogate
+                            if (codepoint >= 0xD800 and codepoint <= 0xDBFF)
+                            {
+                                // make sure there is a subsequent unicode
+                                if ((i + 6 >= m_limit) or * (i + 5) != '\\' or * (i + 6) != 'u')
+                                {
+                                    JSON_THROW(parse_error::create(102, get_position(), "missing low surrogate"));
+                                }
+
+                                // get code yyyy from uxxxx\uyyyy
+                                auto codepoint2 = std::strtoul(std::string(reinterpret_cast<typename string_t::const_pointer>
+                                                               (i + 7), 4).c_str(), nullptr, 16);
+                                result += to_unicode(codepoint, codepoint2);
+                                // skip the next 10 characters (xxxx\uyyyy)
+                                i += 10;
+                            }
+                            else if (codepoint >= 0xDC00 and codepoint <= 0xDFFF)
+                            {
+                                // we found a lone low surrogate
+                                JSON_THROW(parse_error::create(102, get_position(), "missing high surrogate"));
+                            }
+                            else
+                            {
+                                // add unicode character(s)
+                                result += to_unicode(codepoint);
+                                // skip the next four characters (xxxx)
+                                i += 4;
+                            }
+                            break;
+                        }
+                    }
+                }
+            }
+
+            return result;
+        }
+
+
+        /*!
+        @brief parse string into a built-in arithmetic type as if the current
+               locale is POSIX.
+
+        @note in floating-point case strtod may parse past the token's end -
+              this is not an error
+
+        @note any leading blanks are not handled
+        */
+        struct strtonum
+        {
+          public:
+            strtonum(const char* start, const char* end)
+                : m_start(start), m_end(end)
+            {}
+
+            /*!
+            @return true iff parsed successfully as number of type T
+
+            @param[in,out] val shall contain parsed value, or undefined value
+            if could not parse
+            */
+            template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value>::type>
+            bool to(T& val) const
+            {
+                return parse(val, std::is_integral<T>());
+            }
+
+          private:
+            const char* const m_start = nullptr;
+            const char* const m_end = nullptr;
+
+            // floating-point conversion
+
+            // overloaded wrappers for strtod/strtof/strtold
+            // that will be called from parse<floating_point_t>
+            static void strtof(float& f, const char* str, char** endptr)
+            {
+                f = std::strtof(str, endptr);
+            }
+
+            static void strtof(double& f, const char* str, char** endptr)
+            {
+                f = std::strtod(str, endptr);
+            }
+
+            static void strtof(long double& f, const char* str, char** endptr)
+            {
+                f = std::strtold(str, endptr);
+            }
+
+            template<typename T>
+            bool parse(T& value, /*is_integral=*/std::false_type) const
+            {
+                // replace decimal separator with locale-specific version,
+                // when necessary; data will point to either the original
+                // string, or buf, or tempstr containing the fixed string.
+                std::string tempstr;
+                std::array<char, 64> buf;
+                const size_t len = static_cast<size_t>(m_end - m_start);
+
+                // lexer will reject empty numbers
+                assert(len > 0);
+
+                // since dealing with strtod family of functions, we're
+                // getting the decimal point char from the C locale facilities
+                // instead of C++'s numpunct facet of the current std::locale
+                const auto loc = localeconv();
+                assert(loc != nullptr);
+                const char decimal_point_char = (loc->decimal_point == nullptr) ? '.' : loc->decimal_point[0];
+
+                const char* data = m_start;
+
+                if (decimal_point_char != '.')
+                {
+                    const size_t ds_pos = static_cast<size_t>(std::find(m_start, m_end, '.') - m_start);
+
+                    if (ds_pos != len)
+                    {
+                        // copy the data into the local buffer or tempstr, if
+                        // buffer is too small; replace decimal separator, and
+                        // update data to point to the modified bytes
+                        if ((len + 1) < buf.size())
+                        {
+                            std::copy(m_start, m_end, buf.begin());
+                            buf[len] = 0;
+                            buf[ds_pos] = decimal_point_char;
+                            data = buf.data();
+                        }
+                        else
+                        {
+                            tempstr.assign(m_start, m_end);
+                            tempstr[ds_pos] = decimal_point_char;
+                            data = tempstr.c_str();
+                        }
+                    }
+                }
+
+                char* endptr = nullptr;
+                value = 0;
+                // this calls appropriate overload depending on T
+                strtof(value, data, &endptr);
+
+                // parsing was successful iff strtof parsed exactly the number
+                // of characters determined by the lexer (len)
+                const bool ok = (endptr == (data + len));
+
+                if (ok and (value == static_cast<T>(0.0)) and (*data == '-'))
+                {
+                    // some implementations forget to negate the zero
+                    value = -0.0;
+                }
+
+                return ok;
+            }
+
+            // integral conversion
+
+            signed long long parse_integral(char** endptr, /*is_signed*/std::true_type) const
+            {
+                return std::strtoll(m_start, endptr, 10);
+            }
+
+            unsigned long long parse_integral(char** endptr, /*is_signed*/std::false_type) const
+            {
+                return std::strtoull(m_start, endptr, 10);
+            }
+
+            template<typename T>
+            bool parse(T& value, /*is_integral=*/std::true_type) const
+            {
+                char* endptr = nullptr;
+                errno = 0; // these are thread-local
+                const auto x = parse_integral(&endptr, std::is_signed<T>());
+
+                // called right overload?
+                static_assert(std::is_signed<T>() == std::is_signed<decltype(x)>(), "");
+
+                value = static_cast<T>(x);
+
+                return (x == static_cast<decltype(x)>(value)) // x fits into destination T
+                       and (x < 0) == (value < 0)             // preserved sign
+                       //and ((x != 0) or is_integral())        // strto[u]ll did nto fail
+                       and (errno == 0)                       // strto[u]ll did not overflow
+                       and (m_start < m_end)                  // token was not empty
+                       and (endptr == m_end);                 // parsed entire token exactly
+            }
+        };
+
+        /*!
+        @brief return number value for number tokens
+
+        This function translates the last token into the most appropriate
+        number type (either integer, unsigned integer or floating point),
+        which is passed back to the caller via the result parameter.
+
+        integral numbers that don't fit into the the range of the respective
+        type are parsed as number_float_t
+
+        floating-point values do not satisfy std::isfinite predicate
+        are converted to value_t::null
+
+        throws if the entire string [m_start .. m_cursor) cannot be
+        interpreted as a number
+
+        @param[out] result  @ref basic_json object to receive the number.
+        @param[in]  token   the type of the number token
+        */
+        bool get_number(basic_json& result, const token_type token) const
+        {
+            assert(m_start != nullptr);
+            assert(m_start < m_cursor);
+            assert((token == token_type::value_unsigned) or
+                   (token == token_type::value_integer) or
+                   (token == token_type::value_float));
+
+            strtonum num_converter(reinterpret_cast<const char*>(m_start),
+                                   reinterpret_cast<const char*>(m_cursor));
+
+            switch (token)
+            {
+                case lexer::token_type::value_unsigned:
+                {
+                    number_unsigned_t val;
+                    if (num_converter.to(val))
+                    {
+                        // parsing successful
+                        result.m_type = value_t::number_unsigned;
+                        result.m_value = val;
+                        return true;
+                    }
+                    break;
+                }
+
+                case lexer::token_type::value_integer:
+                {
+                    number_integer_t val;
+                    if (num_converter.to(val))
+                    {
+                        // parsing successful
+                        result.m_type = value_t::number_integer;
+                        result.m_value = val;
+                        return true;
+                    }
+                    break;
+                }
+
+                default:
+                {
+                    break;
+                }
+            }
+
+            // parse float (either explicitly or because a previous conversion
+            // failed)
+            number_float_t val;
+            if (num_converter.to(val))
+            {
+                // parsing successful
+                result.m_type = value_t::number_float;
+                result.m_value = val;
+
+                // throw in case of infinity or NAN
+                if (not std::isfinite(result.m_value.number_float))
+                {
+                    JSON_THROW(out_of_range::create(406, "number overflow parsing '" + get_token_string() + "'"));
+                }
+
+                return true;
+            }
+
+            // couldn't parse number in any format
+            return false;
+        }
+
+        constexpr size_t get_position() const
+        {
+            return position;
+        }
+
+      private:
+        /// optional input stream
+        std::istream* m_stream = nullptr;
+        /// line buffer buffer for m_stream
+        string_t m_line_buffer {};
+        /// used for filling m_line_buffer
+        string_t m_line_buffer_tmp {};
+        /// the buffer pointer
+        const lexer_char_t* m_content = nullptr;
+        /// pointer to the beginning of the current symbol
+        const lexer_char_t* m_start = nullptr;
+        /// pointer for backtracking information
+        const lexer_char_t* m_marker = nullptr;
+        /// pointer to the current symbol
+        const lexer_char_t* m_cursor = nullptr;
+        /// pointer to the end of the buffer
+        const lexer_char_t* m_limit = nullptr;
+        /// the last token type
+        token_type last_token_type = token_type::end_of_input;
+        /// current position in the input (read bytes)
+        size_t position = 0;
+    };
+
+    /*!
+    @brief syntax analysis
+
+    This class implements a recursive decent parser.
+    */
+    class parser
+    {
+      public:
+        /// a parser reading from a string literal
+        parser(const char* buff, const parser_callback_t cb = nullptr)
+            : callback(cb),
+              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(buff), std::strlen(buff))
+        {}
+
+        /*!
+        @brief a parser reading from an input stream
+        @throw parse_error.111 if input stream is in a bad state
+        */
+        parser(std::istream& is, const parser_callback_t cb = nullptr)
+            : callback(cb), m_lexer(is)
+        {}
+
+        /// a parser reading from an iterator range with contiguous storage
+        template<class IteratorType, typename std::enable_if<
+                     std::is_same<typename std::iterator_traits<IteratorType>::iterator_category, std::random_access_iterator_tag>::value
+                     , int>::type
+                 = 0>
+        parser(IteratorType first, IteratorType last, const parser_callback_t cb = nullptr)
+            : callback(cb),
+              m_lexer(reinterpret_cast<const typename lexer::lexer_char_t*>(&(*first)),
+                      static_cast<size_t>(std::distance(first, last)))
+        {}
+
+        /*!
+        @brief public parser interface
+        @throw parse_error.101 in case of an unexpected token
+        @throw parse_error.102 if to_unicode fails or surrogate error
+        @throw parse_error.103 if to_unicode fails
+        */
+        basic_json parse()
+        {
+            // read first token
+            get_token();
+
+            basic_json result = parse_internal(true);
+            result.assert_invariant();
+
+            expect(lexer::token_type::end_of_input);
+
+            // return parser result and replace it with null in case the
+            // top-level value was discarded by the callback function
+            return result.is_discarded() ? basic_json() : std::move(result);
+        }
+
+      private:
+        /*!
+        @brief the actual parser
+        @throw parse_error.101 in case of an unexpected token
+        @throw parse_error.102 if to_unicode fails or surrogate error
+        @throw parse_error.103 if to_unicode fails
+        */
+        basic_json parse_internal(bool keep)
+        {
+            auto result = basic_json(value_t::discarded);
+
+            switch (last_token)
+            {
+                case lexer::token_type::begin_object:
+                {
+                    if (keep and (not callback
+                                  or ((keep = callback(depth++, parse_event_t::object_start, result)) != 0)))
+                    {
+                        // explicitly set result to object to cope with {}
+                        result.m_type = value_t::object;
+                        result.m_value = value_t::object;
+                    }
+
+                    // read next token
+                    get_token();
+
+                    // closing } -> we are done
+                    if (last_token == lexer::token_type::end_object)
+                    {
+                        get_token();
+                        if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
+                        {
+                            result = basic_json(value_t::discarded);
+                        }
+                        return result;
+                    }
+
+                    // no comma is expected here
+                    unexpect(lexer::token_type::value_separator);
+
+                    // otherwise: parse key-value pairs
+                    do
+                    {
+                        // ugly, but could be fixed with loop reorganization
+                        if (last_token == lexer::token_type::value_separator)
+                        {
+                            get_token();
+                        }
+
+                        // store key
+                        expect(lexer::token_type::value_string);
+                        const auto key = m_lexer.get_string();
+
+                        bool keep_tag = false;
+                        if (keep)
+                        {
+                            if (callback)
+                            {
+                                basic_json k(key);
+                                keep_tag = callback(depth, parse_event_t::key, k);
+                            }
+                            else
+                            {
+                                keep_tag = true;
+                            }
+                        }
+
+                        // parse separator (:)
+                        get_token();
+                        expect(lexer::token_type::name_separator);
+
+                        // parse and add value
+                        get_token();
+                        auto value = parse_internal(keep);
+                        if (keep and keep_tag and not value.is_discarded())
+                        {
+                            result[key] = std::move(value);
+                        }
+                    }
+                    while (last_token == lexer::token_type::value_separator);
+
+                    // closing }
+                    expect(lexer::token_type::end_object);
+                    get_token();
+                    if (keep and callback and not callback(--depth, parse_event_t::object_end, result))
+                    {
+                        result = basic_json(value_t::discarded);
+                    }
+
+                    return result;
+                }
+
+                case lexer::token_type::begin_array:
+                {
+                    if (keep and (not callback
+                                  or ((keep = callback(depth++, parse_event_t::array_start, result)) != 0)))
+                    {
+                        // explicitly set result to object to cope with []
+                        result.m_type = value_t::array;
+                        result.m_value = value_t::array;
+                    }
+
+                    // read next token
+                    get_token();
+
+                    // closing ] -> we are done
+                    if (last_token == lexer::token_type::end_array)
+                    {
+                        get_token();
+                        if (callback and not callback(--depth, parse_event_t::array_end, result))
+                        {
+                            result = basic_json(value_t::discarded);
+                        }
+                        return result;
+                    }
+
+                    // no comma is expected here
+                    unexpect(lexer::token_type::value_separator);
+
+                    // otherwise: parse values
+                    do
+                    {
+                        // ugly, but could be fixed with loop reorganization
+                        if (last_token == lexer::token_type::value_separator)
+                        {
+                            get_token();
+                        }
+
+                        // parse value
+                        auto value = parse_internal(keep);
+                        if (keep and not value.is_discarded())
+                        {
+                            result.push_back(std::move(value));
+                        }
+                    }
+                    while (last_token == lexer::token_type::value_separator);
+
+                    // closing ]
+                    expect(lexer::token_type::end_array);
+                    get_token();
+                    if (keep and callback and not callback(--depth, parse_event_t::array_end, result))
+                    {
+                        result = basic_json(value_t::discarded);
+                    }
+
+                    return result;
+                }
+
+                case lexer::token_type::literal_null:
+                {
+                    get_token();
+                    result.m_type = value_t::null;
+                    break;
+                }
+
+                case lexer::token_type::value_string:
+                {
+                    const auto s = m_lexer.get_string();
+                    get_token();
+                    result = basic_json(s);
+                    break;
+                }
+
+                case lexer::token_type::literal_true:
+                {
+                    get_token();
+                    result.m_type = value_t::boolean;
+                    result.m_value = true;
+                    break;
+                }
+
+                case lexer::token_type::literal_false:
+                {
+                    get_token();
+                    result.m_type = value_t::boolean;
+                    result.m_value = false;
+                    break;
+                }
+
+                case lexer::token_type::value_unsigned:
+                case lexer::token_type::value_integer:
+                case lexer::token_type::value_float:
+                {
+                    m_lexer.get_number(result, last_token);
+                    get_token();
+                    break;
+                }
+
+                default:
+                {
+                    // the last token was unexpected
+                    unexpect(last_token);
+                }
+            }
+
+            if (keep and callback and not callback(depth, parse_event_t::value, result))
+            {
+                result = basic_json(value_t::discarded);
+            }
+            return result;
+        }
+
+        /// get next token from lexer
+        typename lexer::token_type get_token()
+        {
+            last_token = m_lexer.scan();
+            return last_token;
+        }
+
+        /*!
+        @throw parse_error.101 if expected token did not occur
+        */
+        void expect(typename lexer::token_type t) const
+        {
+            if (t != last_token)
+            {
+                std::string error_msg = "parse error - unexpected ";
+                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
+                              "'") :
+                              lexer::token_type_name(last_token));
+                error_msg += "; expected " + lexer::token_type_name(t);
+                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
+            }
+        }
+
+        /*!
+        @throw parse_error.101 if unexpected token occurred
+        */
+        void unexpect(typename lexer::token_type t) const
+        {
+            if (t == last_token)
+            {
+                std::string error_msg = "parse error - unexpected ";
+                error_msg += (last_token == lexer::token_type::parse_error ? ("'" +  m_lexer.get_token_string() +
+                              "'") :
+                              lexer::token_type_name(last_token));
+                JSON_THROW(parse_error::create(101, m_lexer.get_position(), error_msg));
+            }
+        }
+
+      private:
+        /// current level of recursion
+        int depth = 0;
+        /// callback function
+        const parser_callback_t callback = nullptr;
+        /// the type of the last read token
+        typename lexer::token_type last_token = lexer::token_type::uninitialized;
+        /// the lexer
+        lexer m_lexer;
+    };
+
+  public:
+    /*!
+    @brief JSON Pointer
+
+    A JSON pointer defines a string syntax for identifying a specific value
+    within a JSON document. It can be used with functions `at` and
+    `operator[]`. Furthermore, JSON pointers are the base for JSON patches.
+
+    @sa [RFC 6901](https://tools.ietf.org/html/rfc6901)
+
+    @since version 2.0.0
+    */
+    class json_pointer
+    {
+        /// allow basic_json to access private members
+        friend class basic_json;
+
+      public:
+        /*!
+        @brief create JSON pointer
+
+        Create a JSON pointer according to the syntax described in
+        [Section 3 of RFC6901](https://tools.ietf.org/html/rfc6901#section-3).
+
+        @param[in] s  string representing the JSON pointer; if omitted, the
+                      empty string is assumed which references the whole JSON
+                      value
+
+        @throw parse_error.107 if the given JSON pointer @a s is nonempty and
+        does not begin with a slash (`/`); see example below
+
+        @throw parse_error.108 if a tilde (`~`) in the given JSON pointer @a s
+        is not followed by `0` (representing `~`) or `1` (representing `/`);
+        see example below
+
+        @liveexample{The example shows the construction several valid JSON
+        pointers as well as the exceptional behavior.,json_pointer}
+
+        @since version 2.0.0
+        */
+        explicit json_pointer(const std::string& s = "")
+            : reference_tokens(split(s))
+        {}
+
+        /*!
+        @brief return a string representation of the JSON pointer
+
+        @invariant For each JSON pointer `ptr`, it holds:
+        @code {.cpp}
+        ptr == json_pointer(ptr.to_string());
+        @endcode
+
+        @return a string representation of the JSON pointer
+
+        @liveexample{The example shows the result of `to_string`.,
+        json_pointer__to_string}
+
+        @since version 2.0.0
+        */
+        std::string to_string() const noexcept
+        {
+            return std::accumulate(reference_tokens.begin(),
+                                   reference_tokens.end(), std::string{},
+                                   [](const std::string & a, const std::string & b)
+            {
+                return a + "/" + escape(b);
+            });
+        }
+
+        /// @copydoc to_string()
+        operator std::string() const
+        {
+            return to_string();
+        }
+
+      private:
+        /*!
+        @brief remove and return last reference pointer
+        @throw out_of_range.405 if JSON pointer has no parent
+        */
+        std::string pop_back()
+        {
+            if (is_root())
+            {
+                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
+            }
+
+            auto last = reference_tokens.back();
+            reference_tokens.pop_back();
+            return last;
+        }
+
+        /// return whether pointer points to the root document
+        bool is_root() const
+        {
+            return reference_tokens.empty();
+        }
+
+        json_pointer top() const
+        {
+            if (is_root())
+            {
+                JSON_THROW(out_of_range::create(405, "JSON pointer has no parent"));
+            }
+
+            json_pointer result = *this;
+            result.reference_tokens = {reference_tokens[0]};
+            return result;
+        }
+
+        /*!
+        @brief create and return a reference to the pointed to value
+
+        @complexity Linear in the number of reference tokens.
+
+        @throw parse_error.109 if array index is not a number
+        @throw type_error.313 if value cannot be unflattened
+        */
+        reference get_and_create(reference j) const
+        {
+            pointer result = &j;
+
+            // in case no reference tokens exist, return a reference to the
+            // JSON value j which will be overwritten by a primitive value
+            for (const auto& reference_token : reference_tokens)
+            {
+                switch (result->m_type)
+                {
+                    case value_t::null:
+                    {
+                        if (reference_token == "0")
+                        {
+                            // start a new array if reference token is 0
+                            result = &result->operator[](0);
+                        }
+                        else
+                        {
+                            // start a new object otherwise
+                            result = &result->operator[](reference_token);
+                        }
+                        break;
+                    }
+
+                    case value_t::object:
+                    {
+                        // create an entry in the object
+                        result = &result->operator[](reference_token);
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        // create an entry in the array
+                        JSON_TRY
+                        {
+                            result = &result->operator[](static_cast<size_type>(std::stoi(reference_token)));
+                        }
+                        JSON_CATCH (std::invalid_argument&)
+                        {
+                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
+                        }
+                        break;
+                    }
+
+                    /*
+                    The following code is only reached if there exists a
+                    reference token _and_ the current value is primitive. In
+                    this case, we have an error situation, because primitive
+                    values may only occur as single value; that is, with an
+                    empty list of reference tokens.
+                    */
+                    default:
+                    {
+                        JSON_THROW(type_error::create(313, "invalid value to unflatten"));
+                    }
+                }
+            }
+
+            return *result;
+        }
+
+        /*!
+        @brief return a reference to the pointed to value
+
+        @note This version does not throw if a value is not present, but tries
+        to create nested values instead. For instance, calling this function
+        with pointer `"/this/that"` on a null value is equivalent to calling
+        `operator[]("this").operator[]("that")` on that value, effectively
+        changing the null value to an object.
+
+        @param[in] ptr  a JSON value
+
+        @return reference to the JSON value pointed to by the JSON pointer
+
+        @complexity Linear in the length of the JSON pointer.
+
+        @throw parse_error.106   if an array index begins with '0'
+        @throw parse_error.109   if an array index was not a number
+        @throw out_of_range.404  if the JSON pointer can not be resolved
+        */
+        reference get_unchecked(pointer ptr) const
+        {
+            for (const auto& reference_token : reference_tokens)
+            {
+                // convert null values to arrays or objects before continuing
+                if (ptr->m_type == value_t::null)
+                {
+                    // check if reference token is a number
+                    const bool nums = std::all_of(reference_token.begin(),
+                                                  reference_token.end(),
+                                                  [](const char x)
+                    {
+                        return (x >= '0' and x <= '9');
+                    });
+
+                    // change value to array for numbers or "-" or to object
+                    // otherwise
+                    if (nums or reference_token == "-")
+                    {
+                        *ptr = value_t::array;
+                    }
+                    else
+                    {
+                        *ptr = value_t::object;
+                    }
+                }
+
+                switch (ptr->m_type)
+                {
+                    case value_t::object:
+                    {
+                        // use unchecked object access
+                        ptr = &ptr->operator[](reference_token);
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        // error condition (cf. RFC 6901, Sect. 4)
+                        if (reference_token.size() > 1 and reference_token[0] == '0')
+                        {
+                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
+                        }
+
+                        if (reference_token == "-")
+                        {
+                            // explicitly treat "-" as index beyond the end
+                            ptr = &ptr->operator[](ptr->m_value.array->size());
+                        }
+                        else
+                        {
+                            // convert array index to number; unchecked access
+                            JSON_TRY
+                            {
+                                ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
+                            }
+                            JSON_CATCH (std::invalid_argument&)
+                            {
+                                JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
+                            }
+                        }
+                        break;
+                    }
+
+                    default:
+                    {
+                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
+                    }
+                }
+            }
+
+            return *ptr;
+        }
+
+        /*!
+        @throw parse_error.106   if an array index begins with '0'
+        @throw parse_error.109   if an array index was not a number
+        @throw out_of_range.402  if the array index '-' is used
+        @throw out_of_range.404  if the JSON pointer can not be resolved
+        */
+        reference get_checked(pointer ptr) const
+        {
+            for (const auto& reference_token : reference_tokens)
+            {
+                switch (ptr->m_type)
+                {
+                    case value_t::object:
+                    {
+                        // note: at performs range check
+                        ptr = &ptr->at(reference_token);
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        if (reference_token == "-")
+                        {
+                            // "-" always fails the range check
+                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
+                                                            std::to_string(ptr->m_value.array->size()) +
+                                                            ") is out of range"));
+                        }
+
+                        // error condition (cf. RFC 6901, Sect. 4)
+                        if (reference_token.size() > 1 and reference_token[0] == '0')
+                        {
+                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
+                        }
+
+                        // note: at performs range check
+                        JSON_TRY
+                        {
+                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
+                        }
+                        JSON_CATCH (std::invalid_argument&)
+                        {
+                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
+                        }
+                        break;
+                    }
+
+                    default:
+                    {
+                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
+                    }
+                }
+            }
+
+            return *ptr;
+        }
+
+        /*!
+        @brief return a const reference to the pointed to value
+
+        @param[in] ptr  a JSON value
+
+        @return const reference to the JSON value pointed to by the JSON
+                pointer
+
+        @throw parse_error.106   if an array index begins with '0'
+        @throw parse_error.109   if an array index was not a number
+        @throw out_of_range.402  if the array index '-' is used
+        @throw out_of_range.404  if the JSON pointer can not be resolved
+        */
+        const_reference get_unchecked(const_pointer ptr) const
+        {
+            for (const auto& reference_token : reference_tokens)
+            {
+                switch (ptr->m_type)
+                {
+                    case value_t::object:
+                    {
+                        // use unchecked object access
+                        ptr = &ptr->operator[](reference_token);
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        if (reference_token == "-")
+                        {
+                            // "-" cannot be used for const access
+                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
+                                                            std::to_string(ptr->m_value.array->size()) +
+                                                            ") is out of range"));
+                        }
+
+                        // error condition (cf. RFC 6901, Sect. 4)
+                        if (reference_token.size() > 1 and reference_token[0] == '0')
+                        {
+                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
+                        }
+
+                        // use unchecked array access
+                        JSON_TRY
+                        {
+                            ptr = &ptr->operator[](static_cast<size_type>(std::stoi(reference_token)));
+                        }
+                        JSON_CATCH (std::invalid_argument&)
+                        {
+                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
+                        }
+                        break;
+                    }
+
+                    default:
+                    {
+                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
+                    }
+                }
+            }
+
+            return *ptr;
+        }
+
+        /*!
+        @throw parse_error.106   if an array index begins with '0'
+        @throw parse_error.109   if an array index was not a number
+        @throw out_of_range.402  if the array index '-' is used
+        @throw out_of_range.404  if the JSON pointer can not be resolved
+        */
+        const_reference get_checked(const_pointer ptr) const
+        {
+            for (const auto& reference_token : reference_tokens)
+            {
+                switch (ptr->m_type)
+                {
+                    case value_t::object:
+                    {
+                        // note: at performs range check
+                        ptr = &ptr->at(reference_token);
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        if (reference_token == "-")
+                        {
+                            // "-" always fails the range check
+                            JSON_THROW(out_of_range::create(402, "array index '-' (" +
+                                                            std::to_string(ptr->m_value.array->size()) +
+                                                            ") is out of range"));
+                        }
+
+                        // error condition (cf. RFC 6901, Sect. 4)
+                        if (reference_token.size() > 1 and reference_token[0] == '0')
+                        {
+                            JSON_THROW(parse_error::create(106, 0, "array index '" + reference_token + "' must not begin with '0'"));
+                        }
+
+                        // note: at performs range check
+                        JSON_TRY
+                        {
+                            ptr = &ptr->at(static_cast<size_type>(std::stoi(reference_token)));
+                        }
+                        JSON_CATCH (std::invalid_argument&)
+                        {
+                            JSON_THROW(parse_error::create(109, 0, "array index '" + reference_token + "' is not a number"));
+                        }
+                        break;
+                    }
+
+                    default:
+                    {
+                        JSON_THROW(out_of_range::create(404, "unresolved reference token '" + reference_token + "'"));
+                    }
+                }
+            }
+
+            return *ptr;
+        }
+
+        /*!
+        @brief split the string input to reference tokens
+
+        @note This function is only called by the json_pointer constructor.
+              All exceptions below are documented there.
+
+        @throw parse_error.107  if the pointer is not empty or begins with '/'
+        @throw parse_error.108  if character '~' is not followed by '0' or '1'
+        */
+        static std::vector<std::string> split(const std::string& reference_string)
+        {
+            std::vector<std::string> result;
+
+            // special case: empty reference string -> no reference tokens
+            if (reference_string.empty())
+            {
+                return result;
+            }
+
+            // check if nonempty reference string begins with slash
+            if (reference_string[0] != '/')
+            {
+                JSON_THROW(parse_error::create(107, 1, "JSON pointer must be empty or begin with '/' - was: '" + reference_string + "'"));
+            }
+
+            // extract the reference tokens:
+            // - slash: position of the last read slash (or end of string)
+            // - start: position after the previous slash
+            for (
+                // search for the first slash after the first character
+                size_t slash = reference_string.find_first_of('/', 1),
+                // set the beginning of the first reference token
+                start = 1;
+                // we can stop if start == string::npos+1 = 0
+                start != 0;
+                // set the beginning of the next reference token
+                // (will eventually be 0 if slash == std::string::npos)
+                start = slash + 1,
+                // find next slash
+                slash = reference_string.find_first_of('/', start))
+            {
+                // use the text between the beginning of the reference token
+                // (start) and the last slash (slash).
+                auto reference_token = reference_string.substr(start, slash - start);
+
+                // check reference tokens are properly escaped
+                for (size_t pos = reference_token.find_first_of('~');
+                        pos != std::string::npos;
+                        pos = reference_token.find_first_of('~', pos + 1))
+                {
+                    assert(reference_token[pos] == '~');
+
+                    // ~ must be followed by 0 or 1
+                    if (pos == reference_token.size() - 1 or
+                            (reference_token[pos + 1] != '0' and
+                             reference_token[pos + 1] != '1'))
+                    {
+                        JSON_THROW(parse_error::create(108, 0, "escape character '~' must be followed with '0' or '1'"));
+                    }
+                }
+
+                // finally, store the reference token
+                unescape(reference_token);
+                result.push_back(reference_token);
+            }
+
+            return result;
+        }
+
+        /*!
+        @brief replace all occurrences of a substring by another string
+
+        @param[in,out] s  the string to manipulate; changed so that all
+                          occurrences of @a f are replaced with @a t
+        @param[in]     f  the substring to replace with @a t
+        @param[in]     t  the string to replace @a f
+
+        @pre The search string @a f must not be empty. **This precondition is
+             enforced with an assertion.**
+
+        @since version 2.0.0
+        */
+        static void replace_substring(std::string& s,
+                                      const std::string& f,
+                                      const std::string& t)
+        {
+            assert(not f.empty());
+
+            for (
+                size_t pos = s.find(f);         // find first occurrence of f
+                pos != std::string::npos;       // make sure f was found
+                s.replace(pos, f.size(), t),    // replace with t
+                pos = s.find(f, pos + t.size()) // find next occurrence of f
+            );
+        }
+
+        /// escape tilde and slash
+        static std::string escape(std::string s)
+        {
+            // escape "~"" to "~0" and "/" to "~1"
+            replace_substring(s, "~", "~0");
+            replace_substring(s, "/", "~1");
+            return s;
+        }
+
+        /// unescape tilde and slash
+        static void unescape(std::string& s)
+        {
+            // first transform any occurrence of the sequence '~1' to '/'
+            replace_substring(s, "~1", "/");
+            // then transform any occurrence of the sequence '~0' to '~'
+            replace_substring(s, "~0", "~");
+        }
+
+        /*!
+        @param[in] reference_string  the reference string to the current value
+        @param[in] value             the value to consider
+        @param[in,out] result        the result object to insert values to
+
+        @note Empty objects or arrays are flattened to `null`.
+        */
+        static void flatten(const std::string& reference_string,
+                            const basic_json& value,
+                            basic_json& result)
+        {
+            switch (value.m_type)
+            {
+                case value_t::array:
+                {
+                    if (value.m_value.array->empty())
+                    {
+                        // flatten empty array as null
+                        result[reference_string] = nullptr;
+                    }
+                    else
+                    {
+                        // iterate array and use index as reference string
+                        for (size_t i = 0; i < value.m_value.array->size(); ++i)
+                        {
+                            flatten(reference_string + "/" + std::to_string(i),
+                                    value.m_value.array->operator[](i), result);
+                        }
+                    }
+                    break;
+                }
+
+                case value_t::object:
+                {
+                    if (value.m_value.object->empty())
+                    {
+                        // flatten empty object as null
+                        result[reference_string] = nullptr;
+                    }
+                    else
+                    {
+                        // iterate object and use keys as reference string
+                        for (const auto& element : *value.m_value.object)
+                        {
+                            flatten(reference_string + "/" + escape(element.first),
+                                    element.second, result);
+                        }
+                    }
+                    break;
+                }
+
+                default:
+                {
+                    // add primitive value with its reference string
+                    result[reference_string] = value;
+                    break;
+                }
+            }
+        }
+
+        /*!
+        @param[in] value  flattened JSON
+
+        @return unflattened JSON
+
+        @throw parse_error.109 if array index is not a number
+        @throw type_error.314  if value is not an object
+        @throw type_error.315  if object values are not primitive
+        @throw type_error.313  if value cannot be unflattened
+        */
+        static basic_json unflatten(const basic_json& value)
+        {
+            if (not value.is_object())
+            {
+                JSON_THROW(type_error::create(314, "only objects can be unflattened"));
+            }
+
+            basic_json result;
+
+            // iterate the JSON object values
+            for (const auto& element : *value.m_value.object)
+            {
+                if (not element.second.is_primitive())
+                {
+                    JSON_THROW(type_error::create(315, "values in object must be primitive"));
+                }
+
+                // assign value to reference pointed to by JSON pointer; Note
+                // that if the JSON pointer is "" (i.e., points to the whole
+                // value), function get_and_create returns a reference to
+                // result itself. An assignment will then create a primitive
+                // value.
+                json_pointer(element.first).get_and_create(result) = element.second;
+            }
+
+            return result;
+        }
+
+        friend bool operator==(json_pointer const& lhs,
+                               json_pointer const& rhs) noexcept
+        {
+            return lhs.reference_tokens == rhs.reference_tokens;
+        }
+
+        friend bool operator!=(json_pointer const& lhs,
+                               json_pointer const& rhs) noexcept
+        {
+            return !(lhs == rhs);
+        }
+
+        /// the reference tokens
+        std::vector<std::string> reference_tokens {};
+    };
+
+    //////////////////////////
+    // JSON Pointer support //
+    //////////////////////////
+
+    /// @name JSON Pointer functions
+    /// @{
+
+    /*!
+    @brief access specified element via JSON Pointer
+
+    Uses a JSON pointer to retrieve a reference to the respective JSON value.
+    No bound checking is performed. Similar to @ref operator[](const typename
+    object_t::key_type&), `null` values are created in arrays and objects if
+    necessary.
+
+    In particular:
+    - If the JSON pointer points to an object key that does not exist, it
+      is created an filled with a `null` value before a reference to it
+      is returned.
+    - If the JSON pointer points to an array index that does not exist, it
+      is created an filled with a `null` value before a reference to it
+      is returned. All indices between the current maximum and the given
+      index are also filled with `null`.
+    - The special value `-` is treated as a synonym for the index past the
+      end.
+
+    @param[in] ptr  a JSON pointer
+
+    @return reference to the element pointed to by @a ptr
+
+    @complexity Constant.
+
+    @throw parse_error.106   if an array index begins with '0'
+    @throw parse_error.109   if an array index was not a number
+    @throw out_of_range.404  if the JSON pointer can not be resolved
+
+    @liveexample{The behavior is shown in the example.,operatorjson_pointer}
+
+    @since version 2.0.0
+    */
+    reference operator[](const json_pointer& ptr)
+    {
+        return ptr.get_unchecked(this);
+    }
+
+    /*!
+    @brief access specified element via JSON Pointer
+
+    Uses a JSON pointer to retrieve a reference to the respective JSON value.
+    No bound checking is performed. The function does not change the JSON
+    value; no `null` values are created. In particular, the the special value
+    `-` yields an exception.
+
+    @param[in] ptr  JSON pointer to the desired element
+
+    @return const reference to the element pointed to by @a ptr
+
+    @complexity Constant.
+
+    @throw parse_error.106   if an array index begins with '0'
+    @throw parse_error.109   if an array index was not a number
+    @throw out_of_range.402  if the array index '-' is used
+    @throw out_of_range.404  if the JSON pointer can not be resolved
+
+    @liveexample{The behavior is shown in the example.,operatorjson_pointer_const}
+
+    @since version 2.0.0
+    */
+    const_reference operator[](const json_pointer& ptr) const
+    {
+        return ptr.get_unchecked(this);
+    }
+
+    /*!
+    @brief access specified element via JSON Pointer
+
+    Returns a reference to the element at with specified JSON pointer @a ptr,
+    with bounds checking.
+
+    @param[in] ptr  JSON pointer to the desired element
+
+    @return reference to the element pointed to by @a ptr
+
+    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
+    begins with '0'. See example below.
+
+    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
+    is not a number. See example below.
+
+    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
+    is out of range. See example below.
+
+    @throw out_of_range.402 if the array index '-' is used in the passed JSON
+    pointer @a ptr. As `at` provides checked access (and no elements are
+    implicitly inserted), the index '-' is always invalid. See example below.
+
+    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
+    See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Constant.
+
+    @since version 2.0.0
+
+    @liveexample{The behavior is shown in the example.,at_json_pointer}
+    */
+    reference at(const json_pointer& ptr)
+    {
+        return ptr.get_checked(this);
+    }
+
+    /*!
+    @brief access specified element via JSON Pointer
+
+    Returns a const reference to the element at with specified JSON pointer @a
+    ptr, with bounds checking.
+
+    @param[in] ptr  JSON pointer to the desired element
+
+    @return reference to the element pointed to by @a ptr
+
+    @throw parse_error.106 if an array index in the passed JSON pointer @a ptr
+    begins with '0'. See example below.
+
+    @throw parse_error.109 if an array index in the passed JSON pointer @a ptr
+    is not a number. See example below.
+
+    @throw out_of_range.401 if an array index in the passed JSON pointer @a ptr
+    is out of range. See example below.
+
+    @throw out_of_range.402 if the array index '-' is used in the passed JSON
+    pointer @a ptr. As `at` provides checked access (and no elements are
+    implicitly inserted), the index '-' is always invalid. See example below.
+
+    @throw out_of_range.404 if the JSON pointer @a ptr can not be resolved.
+    See example below.
+
+    @exceptionsafety Strong guarantee: if an exception is thrown, there are no
+    changes in the JSON value.
+
+    @complexity Constant.
+
+    @since version 2.0.0
+
+    @liveexample{The behavior is shown in the example.,at_json_pointer_const}
+    */
+    const_reference at(const json_pointer& ptr) const
+    {
+        return ptr.get_checked(this);
+    }
+
+    /*!
+    @brief return flattened JSON value
+
+    The function creates a JSON object whose keys are JSON pointers (see [RFC
+    6901](https://tools.ietf.org/html/rfc6901)) and whose values are all
+    primitive. The original JSON value can be restored using the @ref
+    unflatten() function.
+
+    @return an object that maps JSON pointers to primitive values
+
+    @note Empty objects and arrays are flattened to `null` and will not be
+          reconstructed correctly by the @ref unflatten() function.
+
+    @complexity Linear in the size the JSON value.
+
+    @liveexample{The following code shows how a JSON object is flattened to an
+    object whose keys consist of JSON pointers.,flatten}
+
+    @sa @ref unflatten() for the reverse function
+
+    @since version 2.0.0
+    */
+    basic_json flatten() const
+    {
+        basic_json result(value_t::object);
+        json_pointer::flatten("", *this, result);
+        return result;
+    }
+
+    /*!
+    @brief unflatten a previously flattened JSON value
+
+    The function restores the arbitrary nesting of a JSON value that has been
+    flattened before using the @ref flatten() function. The JSON value must
+    meet certain constraints:
+    1. The value must be an object.
+    2. The keys must be JSON pointers (see
+       [RFC 6901](https://tools.ietf.org/html/rfc6901))
+    3. The mapped values must be primitive JSON types.
+
+    @return the original JSON from a flattened version
+
+    @note Empty objects and arrays are flattened by @ref flatten() to `null`
+          values and can not unflattened to their original type. Apart from
+          this example, for a JSON value `j`, the following is always true:
+          `j == j.flatten().unflatten()`.
+
+    @complexity Linear in the size the JSON value.
+
+    @throw type_error.314  if value is not an object
+    @throw type_error.315  if object values are not primitve
+
+    @liveexample{The following code shows how a flattened JSON object is
+    unflattened into the original nested JSON object.,unflatten}
+
+    @sa @ref flatten() for the reverse function
+
+    @since version 2.0.0
+    */
+    basic_json unflatten() const
+    {
+        return json_pointer::unflatten(*this);
+    }
+
+    /// @}
+
+    //////////////////////////
+    // JSON Patch functions //
+    //////////////////////////
+
+    /// @name JSON Patch functions
+    /// @{
+
+    /*!
+    @brief applies a JSON patch
+
+    [JSON Patch](http://jsonpatch.com) defines a JSON document structure for
+    expressing a sequence of operations to apply to a JSON) document. With
+    this function, a JSON Patch is applied to the current JSON value by
+    executing all operations from the patch.
+
+    @param[in] json_patch  JSON patch document
+    @return patched document
+
+    @note The application of a patch is atomic: Either all operations succeed
+          and the patched document is returned or an exception is thrown. In
+          any case, the original value is not changed: the patch is applied
+          to a copy of the value.
+
+    @throw parse_error.104 if the JSON patch does not consist of an array of
+    objects
+
+    @throw parse_error.105 if the JSON patch is malformed (e.g., mandatory
+    attributes are missing); example: `"operation add must have member path"`
+
+    @throw out_of_range.401 if an array index is out of range.
+
+    @throw out_of_range.403 if a JSON pointer inside the patch could not be
+    resolved successfully in the current JSON value; example: `"key baz not
+    found"`
+
+    @throw out_of_range.405 if JSON pointer has no parent ("add", "remove",
+    "move")
+
+    @throw other_error.501 if "test" operation was unsuccessful
+
+    @complexity Linear in the size of the JSON value and the length of the
+    JSON patch. As usually only a fraction of the JSON value is affected by
+    the patch, the complexity can usually be neglected.
+
+    @liveexample{The following code shows how a JSON patch is applied to a
+    value.,patch}
+
+    @sa @ref diff -- create a JSON patch by comparing two JSON values
+
+    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
+    @sa [RFC 6901 (JSON Pointer)](https://tools.ietf.org/html/rfc6901)
+
+    @since version 2.0.0
+    */
+    basic_json patch(const basic_json& json_patch) const
+    {
+        // make a working copy to apply the patch to
+        basic_json result = *this;
+
+        // the valid JSON Patch operations
+        enum class patch_operations {add, remove, replace, move, copy, test, invalid};
+
+        const auto get_op = [](const std::string & op)
+        {
+            if (op == "add")
+            {
+                return patch_operations::add;
+            }
+            if (op == "remove")
+            {
+                return patch_operations::remove;
+            }
+            if (op == "replace")
+            {
+                return patch_operations::replace;
+            }
+            if (op == "move")
+            {
+                return patch_operations::move;
+            }
+            if (op == "copy")
+            {
+                return patch_operations::copy;
+            }
+            if (op == "test")
+            {
+                return patch_operations::test;
+            }
+
+            return patch_operations::invalid;
+        };
+
+        // wrapper for "add" operation; add value at ptr
+        const auto operation_add = [&result](json_pointer & ptr, basic_json val)
+        {
+            // adding to the root of the target document means replacing it
+            if (ptr.is_root())
+            {
+                result = val;
+            }
+            else
+            {
+                // make sure the top element of the pointer exists
+                json_pointer top_pointer = ptr.top();
+                if (top_pointer != ptr)
+                {
+                    result.at(top_pointer);
+                }
+
+                // get reference to parent of JSON pointer ptr
+                const auto last_path = ptr.pop_back();
+                basic_json& parent = result[ptr];
+
+                switch (parent.m_type)
+                {
+                    case value_t::null:
+                    case value_t::object:
+                    {
+                        // use operator[] to add value
+                        parent[last_path] = val;
+                        break;
+                    }
+
+                    case value_t::array:
+                    {
+                        if (last_path == "-")
+                        {
+                            // special case: append to back
+                            parent.push_back(val);
+                        }
+                        else
+                        {
+                            const auto idx = std::stoi(last_path);
+                            if (static_cast<size_type>(idx) > parent.size())
+                            {
+                                // avoid undefined behavior
+                                JSON_THROW(out_of_range::create(401, "array index " + std::to_string(idx) + " is out of range"));
+                            }
+                            else
+                            {
+                                // default case: insert add offset
+                                parent.insert(parent.begin() + static_cast<difference_type>(idx), val);
+                            }
+                        }
+                        break;
+                    }
+
+                    default:
+                    {
+                        // if there exists a parent it cannot be primitive
+                        assert(false);  // LCOV_EXCL_LINE
+                    }
+                }
+            }
+        };
+
+        // wrapper for "remove" operation; remove value at ptr
+        const auto operation_remove = [&result](json_pointer & ptr)
+        {
+            // get reference to parent of JSON pointer ptr
+            const auto last_path = ptr.pop_back();
+            basic_json& parent = result.at(ptr);
+
+            // remove child
+            if (parent.is_object())
+            {
+                // perform range check
+                auto it = parent.find(last_path);
+                if (it != parent.end())
+                {
+                    parent.erase(it);
+                }
+                else
+                {
+                    JSON_THROW(out_of_range::create(403, "key '" + last_path + "' not found"));
+                }
+            }
+            else if (parent.is_array())
+            {
+                // note erase performs range check
+                parent.erase(static_cast<size_type>(std::stoi(last_path)));
+            }
+        };
+
+        // type check: top level value must be an array
+        if (not json_patch.is_array())
+        {
+            JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
+        }
+
+        // iterate and apply the operations
+        for (const auto& val : json_patch)
+        {
+            // wrapper to get a value for an operation
+            const auto get_value = [&val](const std::string & op,
+                                          const std::string & member,
+                                          bool string_type) -> basic_json&
+            {
+                // find value
+                auto it = val.m_value.object->find(member);
+
+                // context-sensitive error message
+                const auto error_msg = (op == "op") ? "operation" : "operation '" + op + "'";
+
+                // check if desired value is present
+                if (it == val.m_value.object->end())
+                {
+                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have member '" + member + "'"));
+                }
+
+                // check if result is of type string
+                if (string_type and not it->second.is_string())
+                {
+                    JSON_THROW(parse_error::create(105, 0, error_msg + " must have string member '" + member + "'"));
+                }
+
+                // no error: return value
+                return it->second;
+            };
+
+            // type check: every element of the array must be an object
+            if (not val.is_object())
+            {
+                JSON_THROW(parse_error::create(104, 0, "JSON patch must be an array of objects"));
+            }
+
+            // collect mandatory members
+            const std::string op = get_value("op", "op", true);
+            const std::string path = get_value(op, "path", true);
+            json_pointer ptr(path);
+
+            switch (get_op(op))
+            {
+                case patch_operations::add:
+                {
+                    operation_add(ptr, get_value("add", "value", false));
+                    break;
+                }
+
+                case patch_operations::remove:
+                {
+                    operation_remove(ptr);
+                    break;
+                }
+
+                case patch_operations::replace:
+                {
+                    // the "path" location must exist - use at()
+                    result.at(ptr) = get_value("replace", "value", false);
+                    break;
+                }
+
+                case patch_operations::move:
+                {
+                    const std::string from_path = get_value("move", "from", true);
+                    json_pointer from_ptr(from_path);
+
+                    // the "from" location must exist - use at()
+                    basic_json v = result.at(from_ptr);
+
+                    // The move operation is functionally identical to a
+                    // "remove" operation on the "from" location, followed
+                    // immediately by an "add" operation at the target
+                    // location with the value that was just removed.
+                    operation_remove(from_ptr);
+                    operation_add(ptr, v);
+                    break;
+                }
+
+                case patch_operations::copy:
+                {
+                    const std::string from_path = get_value("copy", "from", true);;
+                    const json_pointer from_ptr(from_path);
+
+                    // the "from" location must exist - use at()
+                    result[ptr] = result.at(from_ptr);
+                    break;
+                }
+
+                case patch_operations::test:
+                {
+                    bool success = false;
+                    JSON_TRY
+                    {
+                        // check if "value" matches the one at "path"
+                        // the "path" location must exist - use at()
+                        success = (result.at(ptr) == get_value("test", "value", false));
+                    }
+                    JSON_CATCH (out_of_range&)
+                    {
+                        // ignore out of range errors: success remains false
+                    }
+
+                    // throw an exception if test fails
+                    if (not success)
+                    {
+                        JSON_THROW(other_error::create(501, "unsuccessful: " + val.dump()));
+                    }
+
+                    break;
+                }
+
+                case patch_operations::invalid:
+                {
+                    // op must be "add", "remove", "replace", "move", "copy", or
+                    // "test"
+                    JSON_THROW(parse_error::create(105, 0, "operation value '" + op + "' is invalid"));
+                }
+            }
+        }
+
+        return result;
+    }
+
+    /*!
+    @brief creates a diff as a JSON patch
+
+    Creates a [JSON Patch](http://jsonpatch.com) so that value @a source can
+    be changed into the value @a target by calling @ref patch function.
+
+    @invariant For two JSON values @a source and @a target, the following code
+    yields always `true`:
+    @code {.cpp}
+    source.patch(diff(source, target)) == target;
+    @endcode
+
+    @note Currently, only `remove`, `add`, and `replace` operations are
+          generated.
+
+    @param[in] source  JSON value to compare from
+    @param[in] target  JSON value to compare against
+    @param[in] path    helper value to create JSON pointers
+
+    @return a JSON patch to convert the @a source to @a target
+
+    @complexity Linear in the lengths of @a source and @a target.
+
+    @liveexample{The following code shows how a JSON patch is created as a
+    diff for two JSON values.,diff}
+
+    @sa @ref patch -- apply a JSON patch
+
+    @sa [RFC 6902 (JSON Patch)](https://tools.ietf.org/html/rfc6902)
+
+    @since version 2.0.0
+    */
+    static basic_json diff(const basic_json& source,
+                           const basic_json& target,
+                           const std::string& path = "")
+    {
+        // the patch
+        basic_json result(value_t::array);
+
+        // if the values are the same, return empty patch
+        if (source == target)
+        {
+            return result;
+        }
+
+        if (source.type() != target.type())
+        {
+            // different types: replace value
+            result.push_back(
+            {
+                {"op", "replace"},
+                {"path", path},
+                {"value", target}
+            });
+        }
+        else
+        {
+            switch (source.type())
+            {
+                case value_t::array:
+                {
+                    // first pass: traverse common elements
+                    size_t i = 0;
+                    while (i < source.size() and i < target.size())
+                    {
+                        // recursive call to compare array values at index i
+                        auto temp_diff = diff(source[i], target[i], path + "/" + std::to_string(i));
+                        result.insert(result.end(), temp_diff.begin(), temp_diff.end());
+                        ++i;
+                    }
+
+                    // i now reached the end of at least one array
+                    // in a second pass, traverse the remaining elements
+
+                    // remove my remaining elements
+                    const auto end_index = static_cast<difference_type>(result.size());
+                    while (i < source.size())
+                    {
+                        // add operations in reverse order to avoid invalid
+                        // indices
+                        result.insert(result.begin() + end_index, object(
+                        {
+                            {"op", "remove"},
+                            {"path", path + "/" + std::to_string(i)}
+                        }));
+                        ++i;
+                    }
+
+                    // add other remaining elements
+                    while (i < target.size())
+                    {
+                        result.push_back(
+                        {
+                            {"op", "add"},
+                            {"path", path + "/" + std::to_string(i)},
+                            {"value", target[i]}
+                        });
+                        ++i;
+                    }
+
+                    break;
+                }
+
+                case value_t::object:
+                {
+                    // first pass: traverse this object's elements
+                    for (auto it = source.begin(); it != source.end(); ++it)
+                    {
+                        // escape the key name to be used in a JSON patch
+                        const auto key = json_pointer::escape(it.key());
+
+                        if (target.find(it.key()) != target.end())
+                        {
+                            // recursive call to compare object values at key it
+                            auto temp_diff = diff(it.value(), target[it.key()], path + "/" + key);
+                            result.insert(result.end(), temp_diff.begin(), temp_diff.end());
+                        }
+                        else
+                        {
+                            // found a key that is not in o -> remove it
+                            result.push_back(object(
+                            {
+                                {"op", "remove"},
+                                {"path", path + "/" + key}
+                            }));
+                        }
+                    }
+
+                    // second pass: traverse other object's elements
+                    for (auto it = target.begin(); it != target.end(); ++it)
+                    {
+                        if (source.find(it.key()) == source.end())
+                        {
+                            // found a key that is not in this -> add it
+                            const auto key = json_pointer::escape(it.key());
+                            result.push_back(
+                            {
+                                {"op", "add"},
+                                {"path", path + "/" + key},
+                                {"value", it.value()}
+                            });
+                        }
+                    }
+
+                    break;
+                }
+
+                default:
+                {
+                    // both primitive type: replace value
+                    result.push_back(
+                    {
+                        {"op", "replace"},
+                        {"path", path},
+                        {"value", target}
+                    });
+                    break;
+                }
+            }
+        }
+
+        return result;
+    }
+
+    /// @}
+};
+
+/////////////
+// presets //
+/////////////
+
+/*!
+@brief default JSON class
+
+This type is the default specialization of the @ref basic_json class which
+uses the standard template types.
+
+@since version 1.0.0
+*/
+using json = basic_json<>;
+} // namespace nlohmann
+
+
+///////////////////////
+// nonmember support //
+///////////////////////
+
+// specialization of std::swap, and std::hash
+namespace std
+{
+/*!
+@brief exchanges the values of two JSON objects
+
+@since version 1.0.0
+*/
+template<>
+inline void swap(nlohmann::json& j1,
+                 nlohmann::json& j2) noexcept(
+                     is_nothrow_move_constructible<nlohmann::json>::value and
+                     is_nothrow_move_assignable<nlohmann::json>::value
+                 )
+{
+    j1.swap(j2);
+}
+
+/// hash value for JSON objects
+template<>
+struct hash<nlohmann::json>
+{
+    /*!
+    @brief return a hash value for a JSON object
+
+    @since version 1.0.0
+    */
+    std::size_t operator()(const nlohmann::json& j) const
+    {
+        // a naive hashing via the string representation
+        const auto& h = hash<nlohmann::json::string_t>();
+        return h(j.dump());
+    }
+};
+
+/// specialization for std::less<value_t>
+template <>
+struct less<::nlohmann::detail::value_t>
+{
+    /*!
+    @brief compare two value_t enum values
+    @since version 3.0.0
+    */
+    bool operator()(nlohmann::detail::value_t lhs,
+                    nlohmann::detail::value_t rhs) const noexcept
+    {
+        return nlohmann::detail::operator<(lhs, rhs);
+    }
+};
+
+} // namespace std
+
+/*!
+@brief user-defined string literal for JSON values
+
+This operator implements a user-defined string literal for JSON objects. It
+can be used by adding `"_json"` to a string literal and returns a JSON object
+if no parse error occurred.
+
+@param[in] s  a string representation of a JSON object
+@param[in] n  the length of string @a s
+@return a JSON object
+
+@since version 1.0.0
+*/
+inline nlohmann::json operator "" _json(const char* s, std::size_t n)
+{
+    return nlohmann::json::parse(s, s + n);
+}
+
+/*!
+@brief user-defined string literal for JSON pointer
+
+This operator implements a user-defined string literal for JSON Pointers. It
+can be used by adding `"_json_pointer"` to a string literal and returns a JSON pointer
+object if no parse error occurred.
+
+@param[in] s  a string representation of a JSON Pointer
+@param[in] n  the length of string @a s
+@return a JSON pointer object
+
+@since version 2.0.0
+*/
+inline nlohmann::json::json_pointer operator "" _json_pointer(const char* s, std::size_t n)
+{
+    return nlohmann::json::json_pointer(std::string(s, n));
+}
+
+// restore GCC/clang diagnostic settings
+#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__)
+    #pragma GCC diagnostic pop
+#endif
+#if defined(__clang__)
+    #pragma GCC diagnostic pop
+#endif
+
+// clean up
+#undef JSON_CATCH
+#undef JSON_THROW
+#undef JSON_TRY
+#undef JSON_DEPRECATED
+
+#endif

websocketForMt4/logger.cpp

@@ -0,0 +1,212 @@
+#include "logger.h"
+
+using namespace tools;
+
+logger::logger()
+	: m_curlv(LVWARN)
+{}
+
+logger::logger(const std::string filename, const std::string filetype)
+	: m_curlv(LVWARN)
+{
+	open(filename, filetype);
+}
+
+logger::~logger()
+{
+	stop();
+}
+
+int
+logger::open(const std::string filename, std::string filetype)
+{
+	m_filename = filename;
+	m_filetype = filetype;
+	SYSTEMTIME st = { 0 };
+	GetLocalTime(&st);
+	char file_path[MAX_PATH] = { 0 };
+	m_last_day = st.wDay;
+	sprintf(file_path, "%s%04u%02u%02u%s", filename.c_str(), st.wYear, st.wMonth, st.wDay, filetype.c_str());
+	m_hfile = CreateFile(file_path,
+		GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+		NULL, OPEN_ALWAYS,
+		FILE_ATTRIBUTE_NORMAL, NULL);
+
+	if (INVALID_HANDLE_VALUE == m_hfile)
+	{
+		CloseHandle(m_hfile);
+		m_run = false;
+		return -1;
+	}
+
+	SetFilePointer(m_hfile, 0, NULL, FILE_END);
+
+	m_run = true;
+	if (!m_proc.joinable())
+		m_proc = std::thread(&logger::processor, this);
+
+	return 0;
+}
+
+void
+logger::set_level(const log_level& level)
+{
+	if (level >= LVTRACK)
+		m_curlv = level;
+
+	if (level >= LVFATAL)
+		m_curlv = LVFATAL;
+}
+
+void
+logger::write(const char* msg, ...)
+{
+	if (NULL == msg)						return;
+	if (false == m_run)						return;
+	if (INVALID_HANDLE_VALUE == m_hfile)	return;
+
+	raw_log tmp;
+	tmp.level = LVWARN;
+	GetLocalTime(&tmp.time);
+
+	char buffer[2048];
+	va_list arg_ptr;
+	va_start(arg_ptr, msg);
+	_vsnprintf(buffer, sizeof(buffer) - 1, msg, arg_ptr);
+	va_end(arg_ptr);
+
+	tmp.log.append(buffer);
+
+	m_req_que.push(tmp);
+}
+
+void
+logger::write(const log_level& level, const char* msg, ...)
+{
+	if (NULL == msg)						return;
+	if (false == m_run)						return;
+	if (INVALID_HANDLE_VALUE == m_hfile)	return;
+	if (level < m_curlv)					return;
+
+	raw_log tmp;
+	tmp.level = level;
+	GetLocalTime(&tmp.time);
+
+	char buffer[2048];
+	va_list arg_ptr;
+	va_start(arg_ptr, msg);
+	_vsnprintf(buffer, sizeof(buffer) - 1, msg, arg_ptr);
+	va_end(arg_ptr);
+
+	tmp.log.append(buffer);
+
+	m_req_que.push(tmp);
+}
+
+#ifdef _DEBUG
+#include <iostream>
+#endif // _DEBUG
+
+void
+logger::processor()
+{
+	char buf[2048];
+	std::shared_ptr<raw_log>	p_rlog;
+
+	DWORD	write_length;
+
+	char level[8];
+
+	while (m_run)
+	{
+		while (m_run)
+		{
+			p_rlog = m_req_que.try_pop();
+			if (std::shared_ptr<raw_log>() == p_rlog && m_run)
+				Sleep(3);
+			else
+				break;
+		}
+
+		if (!m_run)	return;
+
+		switch (p_rlog->level)
+		{
+		case LVTRACK:
+			sprintf(level, "[TRACK]");
+			break;
+		case LVDEBUG:
+			sprintf(level, "[DEBUG]");
+			break;
+		case LVWARN:
+			sprintf(level, "[WARN]");
+			break;
+		case LVERROR:
+			sprintf(level, "[ERROR]");
+			break;
+		case LVFATAL:
+			sprintf(level, "[FATAL]");
+			break;
+		case LVNORMAL:
+			sprintf(level, "");
+			break;
+		default:
+			sprintf(level, "[WARN]");
+			break;
+		}
+		if (m_last_day != p_rlog->time.wDay)
+		{
+			CloseHandle(m_hfile);
+			char file_path[MAX_PATH] = { 0 };
+			m_last_day = p_rlog->time.wDay;
+			sprintf(file_path, "%s%04u%02u%02u%s", m_filename.c_str(), p_rlog->time.wYear, p_rlog->time.wMonth, p_rlog->time.wDay,m_filename.c_str());
+			m_hfile = CreateFile(file_path,
+				GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+				NULL, OPEN_ALWAYS,
+				FILE_ATTRIBUTE_NORMAL, NULL);
+
+			if (INVALID_HANDLE_VALUE == m_hfile)
+			{
+				CloseHandle(m_hfile);
+				m_run = false;
+				return;
+			}
+
+			SetFilePointer(m_hfile, 0, NULL, FILE_END);
+
+			m_run = true;
+		}
+		if (m_filetype.compare(".csv")==0)
+			sprintf(buf, "%d-%02d-%02d %02d:%02d:%2d.%03d,%s%s\r\n",
+			p_rlog->time.wYear, p_rlog->time.wMonth, p_rlog->time.wDay,
+			p_rlog->time.wHour, p_rlog->time.wMinute, p_rlog->time.wSecond,
+			p_rlog->time.wMilliseconds, level, p_rlog->log.c_str());
+		else
+		sprintf(buf, "%d-%02d-%02d %02d:%02d:%2d.%03d: %s%s\r\n",
+			p_rlog->time.wYear, p_rlog->time.wMonth, p_rlog->time.wDay,
+			p_rlog->time.wHour, p_rlog->time.wMinute, p_rlog->time.wSecond,
+			p_rlog->time.wMilliseconds, level, p_rlog->log.c_str());
+
+		if (!WriteFile(m_hfile, buf, strlen(buf), &write_length, NULL))
+		{
+#ifdef _DEBUG
+			std::cout << "write file error" << std::endl;
+#endif // _DEBUG
+		}
+	}
+}
+
+void
+logger::fsync()
+{
+	while (!m_req_que.empty());
+}
+
+void
+logger::stop()
+{
+	fsync();
+	m_run = false;
+	if (m_proc.joinable())
+		m_proc.join();
+}

websocketForMt4/logger.h

@@ -0,0 +1,75 @@
+#pragma once
+
+//#ifdef WIN32
+//#ifdef _MT
+//#ifndef _DLL
+//#ifdef _DEBUG
+//#pragma comment(lib, "logger-mtd.lib") // _MT && _DEBUG
+//#else
+//#pragma comment(lib, "logger-mt.lib") // _MT
+//#endif
+//#else
+//#ifdef _DEBUG
+//#pragma comment(lib, "logger-mdd.lib") // _MT && _DLL && _DEBUG
+//#else
+//#pragma comment(lib, "logger-md.lib") // _MT && _DLL
+//#endif
+//#endif
+//#endif
+//#endif
+
+#include <string>
+#include <thread>
+#include <windows.h>
+
+#include "threadsafe_queue.hpp"
+
+namespace tools
+{
+
+class logger
+{
+public:
+	enum log_level
+	{
+		LVTRACK,
+		LVDEBUG,
+		LVWARN,
+		LVERROR,
+		LVFATAL,
+		LVNORMAL
+	};
+
+	logger();
+	logger(const std::string filename,const std::string filetype);
+	virtual ~logger();
+
+	void	set_level(const log_level& level);
+
+	int		open(const std::string filename, const std::string filetype);
+	void	write(const char* msg, ...);
+	void	write(const log_level& level, const char* msg, ...);
+	void	fsync();
+	void	stop();
+	bool    startflag() { return m_run; }
+private:
+	void	processor();
+	std::thread	m_proc;
+
+	struct raw_log
+	{
+		SYSTEMTIME	time;
+		std::string	log;
+		log_level	level;
+	};
+
+	threadsafe_queue<raw_log>	m_req_que;
+	bool	m_run;
+	HANDLE	m_hfile;
+	log_level	m_curlv;
+	unsigned int  m_last_day;
+	std::string   m_filename;
+	std::string   m_filetype;
+};
+
+};

websocketForMt4/stdafx.cpp

@@ -0,0 +1,8 @@
+// stdafx.cpp : 只包括标准包含文件的源文件
+// websocketForMt4.pch 将作为预编译头
+// stdafx.obj 将包含预编译类型信息
+
+#include "stdafx.h"
+
+// TODO: 在 STDAFX.H 中引用任何所需的附加头文件，
+//而不是在此文件中引用

websocketForMt4/stdafx.h

@@ -0,0 +1,26 @@
+// stdafx.h : 标准系统包含文件的包含文件，
+// 或是经常使用但不常更改的
+// 特定于项目的包含文件
+//
+
+#pragma once
+
+#include "targetver.h"
+
+#include <stdio.h>
+#include <tchar.h>
+
+#include <time.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <process.h>
+#include <math.h>
+#include <io.h>
+#include <sys/stat.h>
+//#define WIN32_LEAN_AND_MEAN
+#include <winsock2.h>
+#include <Windows.h>
+#include "..\socket\common\Src\GeneralHelper.h"
+
+
+// TODO:  在此处引用程序需要的其他头文件

websocketForMt4/targetver.h

@@ -0,0 +1,8 @@
+#pragma once
+
+// 包括 SDKDDKVer.h 将定义可用的最高版本的 Windows 平台。
+
+// 如果要为以前的 Windows 平台生成应用程序，请包括 WinSDKVer.h，并将
+// 将 _WIN32_WINNT 宏设置为要支持的平台，然后再包括 SDKDDKVer.h。
+
+#include <SDKDDKVer.h>

websocketForMt4/threadsafe_queue.hpp

@@ -0,0 +1,88 @@
+#pragma once
+
+#include <queue>
+#include <memory>
+#include <mutex>
+#include <condition_variable>
+
+template<typename T>
+class threadsafe_queue
+{
+public:
+	threadsafe_queue() {}
+	threadsafe_queue(threadsafe_queue const& other)
+	{
+		std::lock_guard<std::mutex> lk(other.m_mut);
+		m_queue = other.m_queue;
+	}
+
+	void push(T data)
+	{
+		std::lock_guard<std::mutex> lk(m_mut);
+		m_queue.push(data);
+		m_cond.notify_one();
+	}
+
+	void wait_and_pop(T& data)
+	{
+		std::unique_lock<std::mutex> lk(m_mut);
+		m_cond.wait
+		(
+			lk,
+			[this]
+			{
+				return !m_queue.empty();
+			}
+		);
+		data = m_queue.front();
+		m_queue.pop();
+	}
+	std::shared_ptr<T> wait_and_pop()
+	{
+		std::unique_lock<std::mutex> lk(m_mut);
+		m_cond.wait
+		(
+			lk,
+			[this]
+			{
+				return !m_queue.empty();
+			}
+		);
+		std::shared_ptr<T> res(std::make_shared<T>(m_queue.front()));
+		m_queue.pop();
+		return res;
+	}
+
+	bool try_pop(T& data)
+	{
+		std::lock_guard<std::mutex> lk(m_mut);
+
+		if (m_queue.empty())
+			return false;
+
+		data = m_queue.front();
+		m_queue.pop();
+		return true;
+	}
+	std::shared_ptr<T> try_pop()
+	{
+		std::lock_guard<std::mutex> lk(m_mut);
+
+		if (m_queue.empty())
+			return std::shared_ptr<T>();
+
+		std::shared_ptr<T> res(std::make_shared<T>(m_queue.front()));
+		m_queue.pop();
+		return res;
+	}
+
+	bool empty() const
+	{
+		std::lock_guard<std::mutex> lk(m_mut);
+		return m_queue.empty();
+	}
+private:
+	mutable std::mutex		m_mut;
+	std::queue<T>			m_queue;
+	std::condition_variable	m_cond;
+};

websocketForMt4/timer.hpp

@@ -0,0 +1,108 @@
+#pragma once
+
+#include <chrono>
+#include <iostream>
+#include <chrono>
+#include <thread>
+#include <list>
+#include <functional>
+#include <atomic>
+#include <mutex>
+namespace tools
+{
+
+namespace tim
+{
+    
+	struct tim_task
+	{
+		std::function<void()> task;
+		int delay;
+		std::chrono::high_resolution_clock::time_point tp;
+	};
+
+	class timer
+	{
+	public:
+		timer()
+			: m_stopflag(false)
+		{}
+
+		~timer()
+		{
+			m_stopflag = true;
+			if (m_bgtask.joinable())
+				m_bgtask.join();
+		}
+
+		void stop()
+		{
+			m_stopflag = true;
+			if (m_bgtask.joinable())
+				m_bgtask.join();
+			//m_tasks.clear();
+		}
+
+		void run()
+		{
+			m_stopflag = false;
+			if (!m_bgtask.joinable())
+			m_bgtask = std::thread(&timer::internal_work, this);
+		}
+
+		void add_task(std::function<void()> func, int delay_ms)
+		{
+			tim_task tmp;
+			tmp.task = func;
+			tmp.delay = delay_ms;
+			tmp.tp = std::chrono::high_resolution_clock::now();
+			std::lock_guard<std::mutex> lk(m_mutex);
+			m_tasks.push_back(tmp);
+		}
+		void clear_task()
+		{
+			std::lock_guard<std::mutex> lk(m_mutex);
+			m_tasks.clear();
+		}
+	private:
+		std::atomic<bool> m_stopflag;
+		std::thread m_bgtask;
+		std::mutex	m_mutex;
+		void internal_work()
+		{
+			while (!m_stopflag)
+			{
+				std::this_thread::sleep_for(std::chrono::milliseconds(5));
+				if (m_stopflag)	break;
+				std::list<tim_task>::iterator it;
+				std::vector<std::function<void()>> _task;
+				m_mutex.lock();
+				for (it = m_tasks.begin(); it != m_tasks.end();)
+				{
+					auto now = std::chrono::high_resolution_clock::now();
+					auto tmp = std::chrono::duration_cast<std::chrono::milliseconds>(now - it->tp).count();
+					if (it->delay < tmp)
+					{
+						//it->task();
+						_task.push_back(it->task);
+						m_tasks.erase(it++);
+					}
+					else
+					{
+						++it;
+					}
+				}
+				m_mutex.unlock();
+				for (int i = 0; i< _task.size();++i)
+				{
+					_task.at(i)();
+				}
+			}
+		}
+
+		std::list<tim_task> m_tasks;
+	};
+
+};
+
+};

websocketForMt4/websocketForMt4.cpp

@@ -0,0 +1,23 @@
+// websocketForMt4.cpp : 定义控制台应用程序的入口点。
+//
+
+#include "stdafx.h"
+
+#include "Processor.h"
+
+TradeTransmit trWeb;
+int main()
+{
+	if (trWeb.Start() != 0)
+	{
+		trWeb.Stop();
+		trWeb.Start();
+	}
+
+	while (true)
+	{
+		getchar();
+	}
+    return 0;
+}
+

websocketForMt4/websocketForMt4.vcxproj

@@ -0,0 +1,222 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" ToolsVersion="14.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|Win32">
+      <Configuration>Debug</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|Win32">
+      <Configuration>Release</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>{1FDEF400-1DDA-4E45-9368-A4BEBE12787C}</ProjectGuid>
+    <Keyword>Win32Proj</Keyword>
+    <RootNamespace>websocketForMt4</RootNamespace>
+    <WindowsTargetPlatformVersion>8.1</WindowsTargetPlatformVersion>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v140</PlatformToolset>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v140</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v140</PlatformToolset>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
+    <ConfigurationType>Application</ConfigurationType>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v140</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>Unicode</CharacterSet>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="Shared">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <LinkIncremental>true</LinkIncremental>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <LinkIncremental>true</LinkIncremental>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <LinkIncremental>false</LinkIncremental>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <LinkIncremental>false</LinkIncremental>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <ClCompile>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
+    <ClCompile>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <PreprocessorDefinitions>_DEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>WIN32;NDEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+      <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
+    <ClCompile>
+      <WarningLevel>Level3</WarningLevel>
+      <PrecompiledHeader>Use</PrecompiledHeader>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <PreprocessorDefinitions>NDEBUG;_CONSOLE;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <SDLCheck>true</SDLCheck>
+    </ClCompile>
+    <Link>
+      <SubSystem>Console</SubSystem>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <Text Include="ReadMe.txt" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="..\public\MT4ManagerAPI.h" />
+    <ClInclude Include="..\socket\common\Src\bufferpool.h" />
+    <ClInclude Include="..\socket\common\Src\bufferptr.h" />
+    <ClInclude Include="..\socket\common\Src\CriticalSection.h" />
+    <ClInclude Include="..\socket\common\Src\Event.h" />
+    <ClInclude Include="..\socket\common\Src\GeneralHelper.h" />
+    <ClInclude Include="..\socket\common\Src\PrivateHeap.h" />
+    <ClInclude Include="..\socket\common\Src\RingBuffer.h" />
+    <ClInclude Include="..\socket\common\Src\RWLock.h" />
+    <ClInclude Include="..\socket\common\Src\Semaphore.h" />
+    <ClInclude Include="..\socket\common\Src\Singleton.h" />
+    <ClInclude Include="..\socket\common\Src\STLHelper.h" />
+    <ClInclude Include="..\socket\common\Src\SysHelper.h" />
+    <ClInclude Include="..\socket\common\Src\WaitFor.h" />
+    <ClInclude Include="..\socket\common\Src\Win32Helper.h" />
+    <ClInclude Include="..\socket\HP-Socket\Src\HPTypeDef.h" />
+    <ClInclude Include="..\socket\HP-Socket\Src\SocketHelper.h" />
+    <ClInclude Include="..\socket\HP-Socket\Src\SocketInterface.h" />
+    <ClInclude Include="..\socket\HP-Socket\Src\TcpClient.h" />
+    <ClInclude Include="..\socket\HP-Socket\Src\TcpServer.h" />
+    <ClInclude Include="ATW.h" />
+    <ClInclude Include="csv.hpp" />
+    <ClInclude Include="json.hpp" />
+    <ClInclude Include="logger.h" />
+    <ClInclude Include="Processor.h" />
+    <ClInclude Include="SHA1.h" />
+    <ClInclude Include="stdafx.h" />
+    <ClInclude Include="targetver.h" />
+    <ClInclude Include="TcpServerProcess.h" />
+    <ClInclude Include="threadsafe_queue.hpp" />
+    <ClInclude Include="timer.hpp" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="..\socket\common\Src\bufferpool.cpp" />
+    <ClCompile Include="..\socket\common\Src\bufferptr.cpp" />
+    <ClCompile Include="..\socket\common\Src\CriticalSection.cpp" />
+    <ClCompile Include="..\socket\common\Src\Event.cpp" />
+    <ClCompile Include="..\socket\common\Src\GeneralHelper.cpp" />
+    <ClCompile Include="..\socket\common\Src\PrivateHeap.cpp" />
+    <ClCompile Include="..\socket\common\Src\RingBuffer.cpp" />
+    <ClCompile Include="..\socket\common\Src\RWLock.cpp" />
+    <ClCompile Include="..\socket\common\Src\Semaphore.cpp" />
+    <ClCompile Include="..\socket\common\Src\SysHelper.cpp" />
+    <ClCompile Include="..\socket\common\Src\WaitFor.cpp" />
+    <ClCompile Include="..\socket\HP-Socket\Src\SocketHelper.cpp" />
+    <ClCompile Include="..\socket\HP-Socket\Src\TcpClient.cpp" />
+    <ClCompile Include="..\socket\HP-Socket\Src\TcpServer.cpp" />
+    <ClCompile Include="ATW.cpp" />
+    <ClCompile Include="logger.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">NotUsing</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">NotUsing</PrecompiledHeader>
+    </ClCompile>
+    <ClCompile Include="Processor.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">NotUsing</PrecompiledHeader>
+    </ClCompile>
+    <ClCompile Include="SHA1.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">NotUsing</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">NotUsing</PrecompiledHeader>
+    </ClCompile>
+    <ClCompile Include="stdafx.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">Create</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">Create</PrecompiledHeader>
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Release|x64'">Create</PrecompiledHeader>
+    </ClCompile>
+    <ClCompile Include="TcpServerProcess.cpp" />
+    <ClCompile Include="websocketForMt4.cpp">
+      <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">NotUsing</PrecompiledHeader>
+    </ClCompile>
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+  </ImportGroup>
+</Project>

websocketForMt4/websocketForMt4.vcxproj.filters

@@ -0,0 +1,189 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup>
+    <Filter Include="源文件">
+      <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
+      <Extensions>cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
+    </Filter>
+    <Filter Include="头文件">
+      <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
+      <Extensions>h;hh;hpp;hxx;hm;inl;inc;xsd</Extensions>
+    </Filter>
+    <Filter Include="资源文件">
+      <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
+      <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
+    </Filter>
+    <Filter Include="public">
+      <UniqueIdentifier>{d32cdda9-113b-4914-8dab-6b585970125a}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="common">
+      <UniqueIdentifier>{f6a79c24-a892-409b-9809-c3e6570b6768}</UniqueIdentifier>
+    </Filter>
+    <Filter Include="HPSocket">
+      <UniqueIdentifier>{64c58930-8839-4e52-9172-efbd9b9813f5}</UniqueIdentifier>
+    </Filter>
+  </ItemGroup>
+  <ItemGroup>
+    <Text Include="ReadMe.txt" />
+  </ItemGroup>
+  <ItemGroup>
+    <ClInclude Include="stdafx.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="targetver.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="..\public\MT4ManagerAPI.h">
+      <Filter>public</Filter>
+    </ClInclude>
+    <ClInclude Include="Processor.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="csv.hpp">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="json.hpp">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="logger.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="threadsafe_queue.hpp">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="timer.hpp">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\bufferpool.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\bufferptr.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\CriticalSection.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\Event.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\GeneralHelper.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\PrivateHeap.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\RingBuffer.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\RWLock.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\Semaphore.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\Singleton.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\STLHelper.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\SysHelper.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\WaitFor.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\common\Src\Win32Helper.h">
+      <Filter>common</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\HP-Socket\Src\HPTypeDef.h">
+      <Filter>HPSocket</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\HP-Socket\Src\SocketHelper.h">
+      <Filter>HPSocket</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\HP-Socket\Src\SocketInterface.h">
+      <Filter>HPSocket</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\HP-Socket\Src\TcpClient.h">
+      <Filter>HPSocket</Filter>
+    </ClInclude>
+    <ClInclude Include="..\socket\HP-Socket\Src\TcpServer.h">
+      <Filter>HPSocket</Filter>
+    </ClInclude>
+    <ClInclude Include="TcpServerProcess.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="SHA1.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+    <ClInclude Include="ATW.h">
+      <Filter>头文件</Filter>
+    </ClInclude>
+  </ItemGroup>
+  <ItemGroup>
+    <ClCompile Include="stdafx.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="websocketForMt4.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="Processor.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="logger.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\bufferpool.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\bufferptr.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\CriticalSection.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\Event.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\GeneralHelper.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\PrivateHeap.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\RingBuffer.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\RWLock.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\Semaphore.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\SysHelper.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\common\Src\WaitFor.cpp">
+      <Filter>common</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\HP-Socket\Src\SocketHelper.cpp">
+      <Filter>HPSocket</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\HP-Socket\Src\TcpClient.cpp">
+      <Filter>HPSocket</Filter>
+    </ClCompile>
+    <ClCompile Include="..\socket\HP-Socket\Src\TcpServer.cpp">
+      <Filter>HPSocket</Filter>
+    </ClCompile>
+    <ClCompile Include="TcpServerProcess.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="SHA1.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+    <ClCompile Include="ATW.cpp">
+      <Filter>源文件</Filter>
+    </ClCompile>
+  </ItemGroup>
+</Project>