GoldSrc Rest In Pawn (gRIP)
GRIP started as an effort to make an asynchronous REST API for Pawn.
Months ago I was invited to participate in the GameX project initiative. GameX was striving to create a modern administrating system for HLDS. To do this many problems queued up, waiting to be solved. One of the major challenges was the interaction with the database.
A long time ago before GRIP and GameX, web-server and HLDS modified database direcly. It was a crude and a brutal approach, which is one of the sources of todays problems.
GRIP was created to fill this gap, by providing asynchronous REST Client for Pawn. Database access and modification, with the server-specific code are delegated to the server and encapsulated in REST API, which is a sophisticated and modern approach.
Before we proceed, I should mention that HLDS and Pawn operate on the main thread. Generally code isn't concurrent.
So to sum up there are 3 key requirements for the GRIP.
2) Asynchronous API
3) Support for the modern web standards.
4) Builtin JSON support (to bypass limits on the AMXX buffer sizes)
Solutions implemented before, usually achieved only second requirement or just basically nothing. They used raw sockets and blocked the main thread for the IO.
To solve blocking problem requests were dispatched to another thread (See for SQL_ThreadQuery for example). This approach has several problems. One of them is the difficulty on concurrent and safe programming in C++. To speed up things, thread pool should be written. With bad dependency management... This is just a mess!
Why don't use modern programming language which is as fast as C++, but is safe, has greater libraries and tooling support? Yeah, basically no reasons to not to.
Rust has many libraries dedicated to high-performance HTTP(s) requests, implemented (at the lowest level) using non-blocking sockets. It is extremely easy to write something in Rust, which is otherwise nearly impossible in C++.
Thus, I, with the team of dedicated supporters give a birth to a GRIP. It supports modern web standards, will eventually support JSON and many other things..
To familiarize yourself with the API you need little to no knowledge about it's inner structure. You should be familiar with Pawn scripting language in the context of the AMX Mod X and REST API.
First of all, let's see whats the most important point. All the necessary optimizations are done under the hood, developer is exposed only to the high-level view of the things.
You start a request with the corresponding arguments and just after that, function returns immediately. There is no blocking and no way to achieve it by design.
Next I think it is important to describe idiomatic callback implementation. User is forced to provide completion handler, which is guaranteed to be called in the case of success, timeout, cancellation, etc.. Requests completion order is unspecified. On completion, response status should be checked. No function silently fails. it is strict API which forces users to consider all cases. All network requests are done simultaneously in the implementation specified order.
JSON API tries to mimic corresponding json.inc file from AMX Mod X. Some things were removed/changed, because in my opinion they are bad design choices. Such dangerous components should rarely cause compilation errors in the plugin, but in the majority of the cases gRIP JSON API is drop-in replacement of AMX Mod X json.inc .
Anyway they are some fundamental places where my point of view and that of AMX Mod X JSON implementation diverge drastically. Here is semi-complete list of such [problems](https://github.com/alliedmodders/amx...thor%3AIn-line
Currently building only on the Linux is supported, but there are some discussions and ongoing work for Windows support. Anyway, the best way to get list of up to date build time dependencies is to view [.travis.yml](https://github.com/In-line/grip/blob/master/.travis.yml
) section containing debian packages.
After installing these dependencies you need to install Rust, follow your distribution specific instruction or simply download it from [rustup](https://rustup.rs/
Because, currently Rustup ships by default only host target, you need to manually install 32-bit x86 target for Rust.
$ rustup target install i686-unknown-linux-gnu
To get nice IDE for Rust and C++, I recommend first of all googling and choosing something based on your taste, but I usually develop using CLion with InteliJ Rust plugin, it is very convenient to use in with mixed Rust/C++ project.
To start building you should use cmake, so first of all, do standard procedure.
$ cmake . # Generate makefile
$ make # Make makefile.
This will compile Rust code, C++ code and produce single shared library at the end. There is no much to tell about this process, but feel free to ask questions (even stupid!). I appreciate contributions and will help anybody, who wants to be involved.