Asynframe framework v2.0.1

https://github.com/netsecsp/asynframe

Background 中文

In the process of software product development, we often encounter problems in the following scenarios:

Centralized management of configuration parameters required by each module– Involving configuration parameter loading and persistence;
Can use the existing network module to develop its own functions, such as submitting the log file to the background through HTTP protocol– Knowledge difficulties involving network, HTTP DNS and using network agent;
Problems caused by information interaction between the interface and other SDK modules (including integration of third-party open source projects)– Thread synchronization, event sequence and long operation time are involved;
Each module (including the interface) solves time-consuming / synchronous operation and other problems by creating working threads, – involving resource optimization;
Using synchronous lock, – there is a deadlock problem.
The complex business logic of the module leads to frequent release of patches

Introduction

This is a message driven SDK development framework based on Windows platform, which provides basic interfaces such as logs, threads, pipes, files and networks.

Asynframe framework solves the six problems mentioned above in the process of software product development:

Manage the parameters of each module through the famous parameter management object
Reduce the learning cost through plug-in and unified operation interface
Provide notification results in the caller’s thread and set the serial operation chain to solve the problems of thread synchronization, event sequence and long operation time
Optimize the execution of working threads of each module through the named thread pool
Provide lockless mechanism
Support dynamic loading of the latest version of plugins

Feature:

Easy integration into MFC，DUI，SoUI，Qt6.7.3 And other third-party open source projects
Provide a unified device operation interface (including file, pipe, socket, etc.)
The operation chain is used to solve the problems of synchronization / communication between threads, execution timeout and resource / performance when integrating third-party open source projects
Provide basic network protocol module：dns/udp/tcp/ssl/ftp/http/rtsp/proxy/websocket
Reference count management object memory
Provide microsecond timer
Support dynamic loading Log4cplus, unified module output logs
Support embedded Lua, JVM and Python Virtual Machine Development Framework

Development advantage:

Support the upgradable plug-in and assist the modularization of windows products.
Support the generation of stack information and dmp files when cross process acquisition crashes.
Embed the micro thread core object into other threads to isolate other codes, so as to facilitate code reconstruction.
Get a very smooth user experience through the asynchronous execution framework.
The unified development template, non locking mechanism, high-performance IO framework and demo reduce the learning cost of developers. It can rapidly develop stable and high-performance application modules. It can greatly reduce the amount of developed code.
Support network UDP/TCP port multiplexing framework.
Support embedded Lua, JVM and Python Virtual Machine Development Framework
lua:
a. Built in VNet class, providing castOf/release interface
b. The appconf.get/set/save interface provides access to the corresponding configuration items of the app
c. The log.v/d/i/w/e/write interface provides printing logs
d. Sys. create/invioke provides the ability to create c objects/specify threads to call c functions
e. IScriptHost.exe provides calls to Lua functions, IOeCommand.Execute provides execution of Lua
python:
a. Built in sys VNet class
b. The appconf.get/set/save interface provides access to the corresponding configuration items of the app
c. The log.v/d/i/w/e/write interface provides printing logs
d. Sys. create/invioke provides the ability to create c objects/specify threads to call c functions
e. IScriptHost.exe provides calling of Python functions, IOeCommand.Execute provides execution of Python functions
JVM integrated frame.jar
a. Built in CUnknown class
b. CSetting provides access to corresponding configuration items for the app
c. CLogger provides print logs
d. CInstanceManager provides the ability to create objects/specify threads to call c functions
e. IScriptHost.exe provides calling Java functions, IOeCommand.Execute provides executing Java

module	type	function	demo
asyncore	framework	asynframe framework	\support\testframe
		integrate MFC	\support\3rd\mfc\testnetserver \support\3rd\mfc\testnetclient_dlg \support\3rd\mfc\testnetclient_doc
		integrate DUI	source
		integrate SoUI	source
		integrate Qt6.7.3	source
crashexplorer	plugin[asyncore]	Capture the crash information of the current process and generate DMP file at the same time	\support\testcrashexplorer
console	plugin[asyncore]	console 1.implement loading / unloading IOsCommand plug-ins：cmd/lua 2.implement keyboard / mouse input	\support\testconsole
asynfile	plugin[asyncore]	file	\support\testfile_copy \support\testfile_copy-pipe
asynipcs	plugin[asyncore]	Interprocess communication	\support\testipcclient \support\testipcserver
asynneta	plugin[asyncore]	network agent service 1.implement http[s] agent：Basic/Digest authorize 2.implement ftp[s] agent 3. implement socks4.0/4.a/5.0 agent	aneta
asynsock	plugin[asyncore]	network: 1.implement IPv6 and compatible with IPv4 2.implement DNS	\support\testnetclient \support\testnetserver pingx
dns	plugin[asynsock]	DNS 1.implement udp dns 2.implement tcp dns 3.implement httpDNS: Alibaba cloud/Tengxun cloud	\support\testdns
ftp	plugin[asynsock]	ftp protocol	aftpx acurl
http	plugin[asynsock]	http protocol	ahttp acurl
rtsp	plugin[asynsock]	rtsp protocol 1.implement rtsp over http	\support\testnetclient_rtsp \support\testnetserver_rtsp
ssl	plugin[asynsock]	ssl/tls encryption/decryption 1.implement p12 certificate	\support\testnetclient_ssl \support\testnetserver_ssl
proxy	plugin[asynsock]	client proxy 1.implement http/https proxy：Basic/Digest authorize 2.implement ftp/ftps proxy 3.implement socks4.0/4.a/5.0 proxy	\support\testnetclient_proxy \support\testnetserver_socks
websocket	plugin[asynsock]	websocket protocol 1.implement data frame slice 2.priority transmission control frame	\support\testnetclient_websocket \support\testnetserver_websocket
zip	plugin	Implementation of IDataTransmit interface based on zlib1.3.1 1.implement zip files 2.deflate/inflate data	\support\testframe
sqlite	plugin	Implementation of IOsCommand interface based on sqlite3.47.2	\support\testframe
dtp	plugin[asynsock]	port reuse framework to implement tcp/udp	support testnetserver_ dtp-tcp.port \support\testnetserver_ dtp-udp.port
lua	plugin	Implementation of IOsCommand interface lua framework	\support\testlua\testlua \support\testlua\testapi
jvmproxy	plugin	Implementation of IOsCommand interface java framework	\support\testjava\testjvm \support\testjava\testapi javax
python38/python312	plugin	Implementation of IOsCommand interface python framework	\support\testpython\testpython \support\testpython\testapi
edgeproxy	plugin[asyncore]	Encapsulation ICoreWebView2	\support\testedgeproxy

Change log

2025/02/13 Release asynframe framework v2.0.1

Release edgeproxy
Support dynamic loading log4cplus

2024/12/23 Release asynframe framework v1.9.0
2024/11/11 Release asynframe framework v1.8.1
2024/08/16 Release asynframe framework v1.7.1
2024/07/12 Release asynframe framework v1.6.1
2023/11/15 Release asynframe framework v1.5.2
2023/03/31 Release asynframe framework v1.4.6
2023/02/02 Release asynframe framework v1.3.2
2022/06/08 Release asynframe framework v1.2.0
2022/05/26 Release asynframe framework v1.1.0
2022/05/05 Release asynframe framework v1.0.0

Build

sdk_v2.0.1-Msvc2019_20250213.zip is compiled through Microsoft Visual Studio 2019
sdk_v2.0.1-Msvc2013_20250213.zip is compiled through Microsoft Visual Studio 2013

The include / lib path corresponding to asynframe needs to be set in the project
Select and link the corresponding asynsdk of asynframe according to the runtime of the asynsdk_mini-[MD/MDd/MT/MTd].lib

Link asyncore_dll.lib

int main(int argc, const char *argv[])
{
 HRESULT ret = Initialize(NULL, NULL); //Initialize asynframe
 if( ret != NO_ERROR )
 {
     return 1;
 }

 InstancesManager *lpInstancesManager = GetInstancesManager(); //Get the instance manager, which can get all interfaces

 CComPtr<IAsynFrameThread> spAsynFrameThread; //Create thread
 lpInstancesManager->NewInstance(0,0,IID_IAsynFrameThread, (void**)&spAsynFrameThread);

 lpInstancesManager->Require(STRING_from_string(IN_AsynNetwork)); //Load network module

 CComPtr<IAsynNetwork    > spAsynNetwork;
 lpInstancesManager->GetInstance(STRING_from_string(IN_AsynNetwork), IID_IAsynNetwork, (void **)&spAsynNetwork);

 CComPtr<IAsynUdpSocket  > spAsynUdpSocket; //Create UDP object
 spAsynNetwork->CreateAsynTcpSocket(&spAsynTcpSocket );

 spAsynUdpSocket->Bind(asynsdk::STRING_EX::null, 0, 0, NULL);  

 ......

 Destory(); //Destory asynframe
 return 0;
}

Development

Interface
IAsynFrame
IAsynFileSystem
IAsynIpcChannel
IAsynNetwork
IAsynNetAgent
IConsole
IExceptionTrapper
INet
IProxy
ISsl
IScriptHost
IDtp

[Plugins](https://netsecsp.github.io/doc/externapi.md)

base modules
asyncore
asynfile
asynipcs
asynsock
crashexplorer

network modules
asynneta
dtp
dns
ftp
http
rtsp
proxy
ssl
websocket

extend modules
console
lua
jvm
python
zip
sqlite

Thanks

Log4cplus
Lua
Luatinker
Zlib
Sqlite
FFmpeg
Python