mongoose/README.md

75 lines
3.7 KiB
Markdown
Raw Normal View History

2016-03-01 18:04:10 +08:00
# <img src="http://www.cesanta.com/hubfs/www.cesanta.com/Images/mongoose_library.png" width="64" height="64"> Mongoose - Embedded Web Server / Embedded Networking Library
2012-08-26 05:48:14 +08:00
![](https://img.shields.io/badge/license-GPL_2-green.svg "License")
2014-04-10 01:10:49 +08:00
Mongoose is ideal for embedded environments. It has been designed
for connecting devices and bringing them online.
[Mongoose](https://www.cesanta.com/products)
has been on the market since 2004 and attracted
over 1 million cumulative downloads.
It provides easy to use event-driven interface that allows to implement
network protocols or scalable network applications with little effort.
Mongoose helps developers to manage the complexity of network programming
and let them concentrate on the logic, saving time and money.
2014-04-10 01:10:49 +08:00
- [Download Mongoose Source Code here](http://hubs.ly/H01bWvx0)
2016-03-01 18:04:10 +08:00
- [Check our latest releases] (https://github.com/cesanta/mongoose/releases)
- [Read User Guide and API reference](https://docs.cesanta.com/mongoose)
- [Study mongoose example code](https://github.com/cesanta/mongoose/tree/master/examples)
2015-08-20 15:56:14 +08:00
> Nothing overdone. Nothing less. So unbelievably easy to use.
> Just how good software should be! -- Pritin Tyagaraj, SAP
2016-03-01 18:04:10 +08:00
If you are looking for a complete IoT platform with firmware and cloud compotent, check out [Smart.js.] (https://github.com/cesanta/smart.js)
2016-03-01 18:04:57 +08:00
# Support
- [Support Forum - Ask your technical questions here] (http://forum.cesanta.com/index.php?p=/categories/smart-js)
2016-03-01 18:36:33 +08:00
- [Chat - Visit www.cesanta.com for our live chat] (http://www.cesanta.com)
2016-03-01 18:04:57 +08:00
- [Commercial one-to-one support - Available to all commercial license holders] (https://www.cesanta.com/services-support)
2013-01-02 07:05:09 +08:00
# Features
* Cross-platform: works on Linux/UNIX, MacOS, QNX, eCos, Windows, Android,
iPhone, FreeRTOS (TI CC3200, ESP8266), etc
* Single-threaded, asynchronous, non-blocking core with simple event-based API
* Native support for [PicoTCP embedded TCP/IP stack](http://www.picotcp.com),
[LWIP embedded TCP/IP stack](https://en.wikipedia.org/wiki/LwIP)
* Builtin protocols:
- plain TCP, plain UDP, SSL/TLS (over TCP, one-way or two-way)
- HTTP client, HTTP server
2016-03-01 18:04:10 +08:00
- WebSocket client, WebSocket server
- JSON-RPC client, JSON-RPC server
- MQTT client, MQTT broker
- CoAP client, CoAP server
- DNS client, DNS server, async DNS resolver
* Tiny static and run-time footprint
* Source code is both ISO C and ISO C++ compliant
* Very easy to integrate: just copy
[mongoose.c](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.c) and
[mongoose.h](https://raw.githubusercontent.com/cesanta/mongoose/master/mongoose.h)
files to your build tree
2016-03-01 18:04:10 +08:00
# Licensing
2016-03-01 18:36:33 +08:00
Mongoose is released under commercial and [GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html) open source licenses.
2016-03-01 18:04:10 +08:00
Commercial Projects:
Once your project becomes commercialised GPLv2 licensing dictates that you need to either open your source fully or purchase a commercial license. Cesanta offer full, royalty-free commercial licenses without any GPL restrictions. [Contact us for pricing.](https://www.cesanta.com/contact)
Prototyping:
While your project is still in prototyping stage and not for sale, you can use Mongooses open source code without license restrictions.
2015-08-18 16:50:00 +08:00
# Dashboard Example
2014-03-12 00:59:17 +08:00
Mongoose is often used to implement device dashboards and real-time
data exchange over Websocket. Here is a dashboard example that illustrates
the functionality:
2015-08-18 16:50:00 +08:00
![](http://www.cesanta.com/hubfs/www.cesanta.com/diagrams/dash_mongoose_diagram.png)
2014-03-12 00:59:17 +08:00
2015-08-18 16:50:00 +08:00
[Developing a new product? Contact us today to discuss how Mongoose can help
](https://www.cesanta.com/contact)
2014-03-12 00:59:17 +08:00
[![Analytics](https://ga-beacon.appspot.com/UA-42732794-5/project-page)](https://github.com/cesanta/mongoose)