123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <title>Embedding GoAhead</title>
-
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
- <meta name="description" content="GoAhead web server">
- <link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700|Open+Sans:300italic,400,300,700' rel='stylesheet' type='text/css'>
- <link href='https://fonts.googleapis.com/css?family=Julius+Sans+One' rel='stylesheet' type='text/css'>
-
- <link href="../images/favicon.ico" rel="shortcut icon">
- <link href="../lib/semantic-ui/semantic.min.css" rel="stylesheet" type="text/css">
- <link href="../css/all.min.css" rel="stylesheet" type="text/css">
- <link href="../css/api.min.css" rel="stylesheet" type="text/css">
-
- </head>
- <body class="show-sidebar">
- <div class="sidebar">
- <div class="ui large left vertical inverted labeled menu">
- <div class="item">
- <a href="../" class="logo">GoAhead Docs</a>
- </div>
- <div class="item">
- <a href="../">
- <b>General</b>
- </a>
- <div class="menu">
- <a class="item" href="../">GoAhead Overview</a>
- <a class="item" href="../users/features.html">GoAhead Features</a>
- <a class="item" href="https://embedthis.com/goahead/download.html">Download</a>
- <a class="item" href="../licensing/">Licensing</a>
- </div>
- </div>
- <div class="item">
- <a href="../start/">
- <b>Getting Started</b>
- </a>
- <div class="menu">
- <a class="item" href="../start/quick.html">Quick Start</a>
- <a class="item" href="../start/installing.html">Installing GoAhead</a>
- <a class="item" href="../start/running.html">Running GoAhead</a>
- <a class="item" href="../start/releaseNotes.html">Release Notes</a>
- <a class="item" href="../start/faq.html">GoAhead FAQ</a>
- <a class="item" href="../start/source.html">Building from Source</a>
- </div>
- </div>
- <div class="item">
- <a href="../users/"><b>User's Guide</b></a>
- <div class="menu">
- <a class="item" href="../users/ports.html">Ports and Binding</a>
- <a class="item" href="../users/routing.html">Routing Requests</a>
- <a class="item" href="../users/handlers.html">Request Handlers</a>
- <a class="item" href="../users/js.html">Embedded Javascript</a>
- <a class="item" href="../users/jst.html">Javascript Templates</a>
- <a class="item" href="../users/goactions.html">GoActions</a>
- <a class="item" href="../users/cgi.html">CGI Programs</a>
- <a class="item" href="../users/authentication.html">User Authentication</a>
- <a class="item" href="../users/logFiles.html">Log Files</a>
- <a class="item" href="../users/ssl.html">Secure Sockets (SSL)</a>
- <a class="item" href="../users/security.html">Security Considerations</a>
- <a class="item" href="../users/man.html">Man Pages</a>
- </div>
- </div>
- <div class="item">
- <a href="../developers/">Developer's Guide</a>
- <div class="menu">
- <a class="item" href="../developers/embedding.html">Embedding GoAhead</a>
- <a class="item" href="../developers/handlers.html">Creating GoAhead Handlers</a>
- <a class="item" href="../developers/authstore.html">Creating Password Verifiers</a>
- <a class="item" href="../developers/migrating.html">Migrating to GoAhead 3/4</a>
- <a class="item" href="../developers/rom.html">Serving Pages from ROM</a>
- </div>
- </div>
- <div class="item">
- <a href="../ref/">Reference Guide</a>
- <div class="menu">
- <a class="item" href="../ref/compatibility.html">Compatibility</a>
- <a class="item" href="../ref/native.html">API Library</a>
- <a class="item" href="../ref/architecture.html">GoAhead Architecture</a>
- <a class="item" href="../standards/http.html">HTTP References</a>
- </div>
- </div>
- <div class="item">
- <a href="../developers/project.html">Project Resources</a>
- <div class="menu">
- <a class="item" href="https://embedthis.com/blog/categories/GoAhead/">GoAhead News</a>
- <a class="item" href="https://embedthis.com/goahead/">GoAhead Web Site</a>
- <a class="item" href="https://github.com/embedthis/goahead">Source Code Repository</a>
- <a class="item" href="https://github.com/embedthis/goahead/issues/99">GoAhead Security Alerts</a>
- <a class="item" href="https://github.com/embedthis/goahead/issues">Project Issue Database</a>
- <a class="item" href="https://github.com/embedthis/goahead/releases">Change Log</a>
- <a class="item" href="https://github.com/embedthis/goahead/milestones">Roadmap</a>
- <a class="item" href="https://embedthis.com/developers/contributors.html">Contributors Agreement</a>
- </div>
- </div>
- <div class="item">
- <b>Links</b>
- <div class="menu">
- <a class="item" href="https://embedthis.com/">Embedthis Web Site</a>
- <a class="item" href="https://embedthis.com/blog/">Embedthis Blog</a>
- <a class="item" href="http://twitter.com/embedthat">Twitter</a>
- </div>
- </div>
- </div>
- </div>
- <div class="ui inverted masthead">
- <div class="ui fixed inverted menu">
- <div class="ui sidebar-launch button">
- <i class="icon list layout"></i>
- </div>
- <div class="right menu">
- <a class="item" href="https://embedthis.com/">Embedthis</a>
- <a class="item" href="https://embedthis.com/goahead/">GoAhead Site</a>
- <span class="desktop-only">
- <a class="item" href="https://embedthis.com/blog/categories/GoAhead/">GoAhead News</a>
- <a class="item" href="https://github.com/embedthis/goahead">Repository</a>
- <a class="item" href="https://embedthis.com/blog/">Blog</a>
- <a class="item" href="https://twitter.com/embedthat">Twitter</a>
- </span>
- </div>
- </div>
-
- <div class="ui breadcrumb">
- <a class="section" href="../">Home</a>
-
- <div class="divider">/</div>
- <a class="section" href="../developers/">
- Developer's Guide
- </a>
-
-
- <div class="divider">/</div>
- <a class="active section" href="embedding.html">Embedding GoAhead</a>
-
- </div>
-
- <iframe class="version desktop-only" src="../version.html"></iframe>
- </div>
- <div class="content">
- <h1 class="title">Embedding GoAhead</h1>
- <p>When embedding GoAhead in your application or system, you have two alternatives:</p>
- <ol>
- <li>Use the existing GoAhead main program and extend GoAhead via Javascript and goforms.</li>
- <li>Link the GoAhead library with a custom main program.</li>
- </ol>
- <a id="goaheadProgram"></a>
- <h2>The GoAhead Program</h2>
- <p>The GoAhead product includes a fully-featured HTTP server program called <em>goahead</em> that uses the GoAhead HTTP library.
- You can also modify the <em>goahead.c</em> main program to customize according to your specific requirements.
- line of code.</p>
-
- <a name="library"></a>
- <h2>Embed the GoAhead Library</h2>
- <p>You can link the GoAhead library with your application to enable it to listen for HTTP requests and thus
- become a HTTP server itself. Embedding the GoAhead library is easy and can be done with as little as one
- line of code.</p>
- <h3>Linking with the GoAhead Library</h3>
- <p>To include the GoAhead library in your program you need to do the following things:</p>
- <ol>
- <li>Add <b>#include "goahead.h"</b> in your source files.</li>
- <li>Add the GoAhead library to your Makefiles or Windows project files. This will mean adding
- libgo.lib on Windows or libgo.a on Unix.</li>
- <li>Use one of the embedding APIs to create the HTTP server.</li>
- </ol>
- <h3>Full Control API</h3>
- <p>The GoAhead library also provides an extensive API so you can precisely control how
- the web server is created and configured.</p>
- <p>This example creates a web server using the "server.conf" configuration file and will service events
- until terminated.</p>
- <pre class="ui code segment">
- #include "goahead.h"
- int main(int argc, char **argv)
- {
- if (websOpen("web", "route.txt") < 0) {
- error("Can't open the web server runtime");
- return 0;
- }
- if (websListen(":80") < 0) {
- mprError("Can't listen on port 80");
- return 0;
- }
- websServiceEvents(NULL);
- websClose();
- return 0;
- }
- </pre>
- <a name="javascript"></a>
- <h2>Extending via Javascript</h2>
- <p>The GoAhead Javascript web framework allows customization by direct embedding of Javascript code in
- HTML web pages. This code runs on the server-side before rendering the page to the client.
- <h3>API Details</h3>
- <p>For more details about the embedding API, please consult the <a href="../ref/api/goahead.html">GoAhead
- API</a>.</p>
- </div>
- <div class="terms ui basic center aligned segment">
- <p>© Embedthis Software. All rights reserved.</p>
- </div>
- <script src="../lib/jquery/jquery.min.js"></script>
- <script src="../lib/semantic-ui/semantic.min.js"></script>
- <script src="../scripts/sidebar.min.js"></script>
-
-
|