Embedded Gateway Interface (EGI) Sample in C

The simpleEgi sample demonstrates how to create and use the Embedded Gateway Interface (EGI) in your application to respond to posted HTTP forms.

The sample is a main program that listens on port 8888 for HTTP requests and responds to the "/myEgi" URL when used with the POST method. The supplied index.esp page displays a form and prompts for user input. This is sent to the form when the user presses OK. The EGI handler echos back the input data values.

The sample is multithreaded and is configured to use a pool of 4 threads. By changing the value of the ThreadLimit directive in the configuration file to zero you can run single-threaded.

See also the equivalent C simpleEgi sample.

Files

index.esp
simpleEgi.conf
simpleEgi.c

index.esp Web Page



Embedded Gateway Interface (EGI) Sample



Embedded Gateway Interface (EGI) Sample


action=/myEgi.egi method=POST>











Name:
Address:








Configuration File

simpleEgi.conf

DocumentRoot "."
Listen 8888
ThreadLimit 4

LoadModule ejs ../../../lib/libejsModule
LoadModule egi ../../../lib/libegiHandler
LoadModule esp ../../../lib/libespHandler
LoadModule static ../../../lib/libcopyHandler

AddHandler egiHandler .egi
AddHandler espHandler .esp
AddHandler copyHandler

This configuration file loads the embedded JavaScript module and the embedded server pages and embedded gateway interface, and static content handlers. It is configured to run with 4 pool threads. It assumes that the sample is being run from the samples C/simpleEgi directory and so the module paths are relative to the lib directory in the samples source tree. Modify these module paths to suit your installation.

You should modify the DocumentRoot and Listen directives to suit your application's needs.

Source Code

simpleEgi.c

/*
* Copyright (c) Mbedthis Software LLC, 2003-2004. All Rights Reserved.
*/
/*!
* @file simpleEgi.c
* @brief Demonstrate the use of the Embedded Gateway Interface (EGI)
* in a simple multi-threaded application.
*/

/******************************* Includes *****************************/

#include "appWeb/appWeb.h"

/********************************* Code *******************************/
#if MPR_FEATURE_C_API
/*
* This method is run when the EGI form is called from the web
* page. Rq is the request context. URI is the bare URL minus query.
* Query is the string after a "?" in the URL. Post data is posted
* HTTP form data.
*/

static void myEgi(MaRequest *rq, char *script, char *uri, char *query,
char *postData, int postLen)
{
/*
* For convenience, decode and convert each post data variable
* into the hashed environment
*/
if (postLen > 0) {
maCreateEnvVars(rq, postData, postLen);
}
maWriteStr(rq, "simpleEgi\r\n");
maWriteFmt(rq, "

Name: %s

\n", maGetVar(rq, "name", "-"));
maWriteFmt(rq, "

Address: %s

\n", maGetVar(rq, "address", "-"));
maWriteFmt(rq, "\r\n");

#if FUTURE
//
// Possible useful things to do in egi forms
//
maSetResponseCode(rq, 200);
maSetContentType(rq, "text/html");
maSetHeader(rq, MPR_HTTP_DONT_CACHE);
maRedirect(rq, "/myURl");
maRequestError(rq, 409, "My message : %d", 5);
#endif
}

/**********************************************************************/

int main(int argc, char** argv)
{
MaHttp *http; /* For the http service inside our app */
MaServer *server; /* For a HTTP server */

/*
* Initialize the run-time and give our app a name "simpleEgi"
*/
mprCreateMpr("simpleEgi");

/*
* Do the following two statements only if you want debug trace
*/
mprAddLogFileListener();
mprSetLogSpec("stdout:4");

/*
* Start run-time services
*/
mprStartMpr(0);

/*
* Create the HTTP and server objects. Give the server a name
* "default" and define "." as the default serverRoot, ie. the
* directory with the server configuration files.
*/
http = maCreateHttp();
server = maCreateServer(http, "default", ".");

/*
* Configure the server based on the directives in
* simpleEgi.conf.
*/
if (maConfigureServer(server, "simpleEgi.conf", 0) < 0) {
fprintf(stderr,
"Can't configure the server. Error on line %d\n",
maGetConfigErrorLine(server));
exit(2);
}

/*
* Define our EGI form
*/
maDefineEgiForm("/myEgi.egi", myEgi);

/*
* Start serving pages. After this we are live.
*/
if (maStartServers(http) < 0) {
fprintf(stderr, "Can't start the server\n");
exit(2);
}

/*
* Service events. This call will block until the server is exited
* Call mprTerminate() at any time to instruct the server to exit.
* The -1 is a timeout on the block. Useful if you use
* MPR_LOOP_ONCE and have a polling event loop.
*/
mprServiceEvents(MPR_LOOP_FOREVER, -1);

/*
* Stop all HTTP services
*/
maStopServers(http);

/*
* Delete the server and http objects
*/
maDeleteServer(server);
maDeleteHttp(http);

/*
* Stop and delete the run-time services
*/
mprStopMpr();
mprDeleteMpr();

return 0;
}

/**********************************************************************/
#else /* MPR_FEATURE_C_API */

int main()
{
fprintf(stderr, "MPR_FEATURE_C_API is not defined in config.h\n");
exit(2);
}
#endif /* MPR_FEATURE_C_API */



© Mbedthis Software LLC, 2003-2204. All rights reserved. Mbedthis is a trademark of Mbedthis Software LLC.