 |
General Programming »
Internet / Network »
HTTP
Intermediate
License: The BSD License
A C++ Embedded Web ServerBy ravenspointGive a C++ application its own web page |
C++ (VC6, VC7, VC7.1, VC8.0), Windows (WinXP), Win32, Dev
|
|
Advanced Search Add to IE Search |
|
|
|
||||||||||||||||
Do you have a web page or two? Nothing fancy, perhaps, but a neat demonstration of what can be achieved with a handful of HTML tags? Do you have a sophisticated C++ Windows desktop application which now needs to be controlled and monitored remotely? So, without learning a whole new technology, let's give your application its own web page!
Webem is a web server that you can embed in your C++ application. It makes it easy to implement a browser GUI accessible from anywhere.
Webem is based on a minimally modified version of the boost::asio web server, and permits HTML code to execute C++ methods.
The available embedded C++ web servers are a challenge to use, and tend not to be Windows friendly. They are not the kind of thing you want to get into just to add the ability to monitor your lab application from your cell phone.
I have tried Wt (http://www.webtoolkit.eu/wt) but was defeated by the installation and learning curve.
I recently began using Webio by John Bartas. I liked the concept and it worked well.
However, I still found it overly complicated to use and the server code hard to understand. I wanted something easier to use, based on a well known web server that had only been slightly modified.
A lot of the complexity of Webio is caused by using an “HML compiler” to hide the HTML pages that control the appearance of the GUI inside a file system embedded inside the application code. I prefer to have the HTML pages outside in plain view where I can adjust the GUI without recompiling the application.
I learned a lot trying to adjust Webio to my taste, and eventually was ready to build my own exactly to my requirements.
You build your application's GUI exactly like you build a web site - create pages using HTML all starting from index.html.
Now you need to make the HTML invoke your C++ methods. There are two things you can do:
Step 1: Create the web page. This can be as elaborate as you like, but let's keep it simple for our first "hello, world" application:
The Webem Embedded Web server says: <!--#webem hello -->
The text in angle brackets tells webem where you want to include text from the application, and "hello" is the code for the particular application method that must be invoked to provide the included text.
Step 2: Create the class which says hello:
/// An application class which says hello
class cHello
{
public:
char * DisplayHTML()
{
return "Hello World";
}
};
Step 3: Initialize Webem, telling it the address and port to listen for browser requests and where to find the index.html that begins the web page.
// Initialize web server.
http::server::cWebem theServer(
"0.0.0.0", // address
"1570", // port
".\\"); // document root
Step 4: Register the application method with webem:
cHello hello;
// register application method
// Whenever server sees <!--#webem hello -->
// call cHello::DisplayHTML() and include the HTML returned
theServer.RegisterIncludeCode( "hello",
boost::bind(
&cHello::DisplayHTML, // member function
&hello ) ); // instance of class
Step 4: Finally, you are ready to start the server running.
// run the server
theServer.Run();
Let's create a more polite program which addresses the world by name (CodeProject is, after all, Canadian.)
Step 1: Create the website:
What is your name, please?
<form action=name.webem>
<input name=yourname /><input value="Enter" type=submit />
</form>
The Webem Embedded Web server says: <!--#webem hello -->
The form provides a field to enter the user's name, and a button to submit the entered name to the server. The form attribute "action=name.webem" ensures that the webem server will call the application method registered with "name" to process the input.
Step 2: Create the application class:
/// An application class which says hello to the identified user
class cHelloForm
{
string UserName;
http::server::cWebem& myWebem;
public:
cHelloForm( http::server::cWebem& webem ) :
myWebem( webem )
{
myWebem.RegisterIncludeCode( "hello",
boost::bind(
&cHelloForm::DisplayHTML, // member function
this ) ); // instance of class
myWebem.RegisterActionCode( "name",
boost::bind(
&cHelloForm::Action, // member function
this ) ); // instance of class
}
char * DisplayHTML()
{
static char buf[1000];
if( UserName.length() )
sprintf_s( buf, 999,
"Hello, %s", UserName.c_str() );
else
buf[0] = '\0';
return buf;
}
char * Action()
{
UserName = myWebem.FindValue("yourname");
return "/index.html";
}
};
The application class stores a reference to the webem server. This allows it to look after registering its own methods with the server when it is constructed, and to call the cWebem class FindValue() to extract the value of the field entered into the form.
The application class must register two methods, one to save the entered user name when the submit button is clicked, one to display the stored user name when the web page is assembled and sent to the browser.
The action methods must return the webpage which should be displayed in response to the click on the submit button.
Note that all action methods are invoked by Webem before the include methods, so that the web page always displays updated data.
Step 3: Construct webem, construct the application class and run the server:
// Initialize web server
http::server::cWebem theServer(
"0.0.0.0", // address
"1570", // port
".\\"); // document root
// Initialize application code
cHelloForm hello( theServer );
// run the server
theServer.Run();
You may need to run the server in another thread, perhaps so your application can continue logging data from a lab device. To do this, modify the call to server::run:
boost::thread* pThread = new boost::thread(
boost::bind(
&http::server::server::run, // member function
&theServer ) ); // instance of class
Webem controls are classes which look after the details of displaying and manipulating application data in standard ways, so that the application programmer does not need to be concerned with all the details of generating HTML text.
The demo application uses a webem control to list the contents of a SQLITE database table with the ability to add or delete records. There is a screenshot at the top of this article.
More webem controls, detailed documentation and the latest code are available here.
This section describes how webem is integrated with the server. It is not necessary to read this in order to use webem.
The boost::asio HTTP server invokes the method:
request_handler::handle_request( const request& req, reply& rep)
This is where the browser requests are parsed and the new page assembled to be sent back to the browser. We need to override this method in a specialization of the request handler so that, in turn, the registered application methods can be invoked.
void cWebemRequestHandler::handle_request( const request& req, reply& rep)
{
// check for webem action request
request req_modified = req;
myWebem.CheckForAction( req_modified.uri );
// call base method to do normal handling
request_handler::handle_request( req_modified, rep);
// Find and include any special cWebem strings
myWebem.Include( rep.content );
}
Unfortunately, the boost::asio server, although otherwise very elegantly designed and implemented, has not been designed with inheritance in mind. In order to allow the server to invoke the webem request handler, I have made minimal changes to the boost code:
request_handler::handle_request method virtual so specialized override will be called request_handler it will use. Here is the patch:
>hg diff -U1 -r 0 -r 1 --nodates
diff -r 32dc1a479036 -r 86a6e2a3ff58 src/webem/server/request_handler.hpp
--- a/src/webem/server/request_handler.hpp
+++ b/src/webem/server/request_handler.hpp
@@ -31,3 +31,3 @@
/// Handle a request and produce a reply.
- void handle_request(const request& req, reply& rep);
+ virtual void handle_request(const request& req, reply& rep);
diff -r 32dc1a479036 -r 86a6e2a3ff58 src/webem/server/server.cpp
--- a/src/webem/server/server.cpp
+++ b/src/webem/server/server.cpp
@@ -17,3 +17,3 @@
server::server(const std::string& address, const std::string& port,
- const std::string& doc_root)
+ request_handler& user_request_handler )
: io_service_(),
@@ -23,3 +23,3 @@
connection_manager_, request_handler_)),
- request_handler_(doc_root)
+ request_handler_( user_request_handler)
{
diff -r 32dc1a479036 -r 86a6e2a3ff58 src/webem/server/server.hpp
--- a/src/webem/server/server.hpp
+++ b/src/webem/server/server.hpp
@@ -31,3 +31,3 @@
explicit server(const std::string& address, const std::string& port,
- const std::string& doc_root);
+ request_handler& user_request_handler );
@@ -55,2 +55,5 @@
+ /// The handler for all incoming requests.
+ request_handler& request_handler_;
+
/// The next connection to be accepted.
@@ -58,4 +61,2 @@
- /// The handler for all incoming requests.
- request_handler request_handler_;
};
cWebem constructor, which simplifies application code Hello World" and "Formal Hello" Content-Length, apparently some browsers truncate display to this length. Change provided by http://www.codeproject.com/Members/jaeheung72
General 
News 
Question 
Answer 
Joke 
Rant 
Admin
Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads.
|
PermaLink |
Privacy |
Terms of Use
Last Updated: 5 May 2009 Editor: Deeksha Shenoy |
Copyright 2008 by ravenspoint Everything else Copyright © CodeProject, 1999-2010 Web19 | Advertise on the Code Project |
