/doc/modules/mod_development/mod_development.html
http://github.com/zotonic/zotonic · HTML · 124 lines · 104 code · 20 blank · 0 comment · 0 complexity · bd3554f45068ed609e52cd0b1d710555 MD5 · raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html>
- <head>
- <title>Module mod_development</title>
- <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
- </head>
- <body bgcolor="white">
- <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
- <hr>
- <h1>Module mod_development</h1>
- <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Development server.
- <p>Copyright 2009 Marc Worrell
- Date: 2009-11-01</p>
- <p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
- <p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>), Bryan Fink (<a href="mailto:bryan@basho.com"><tt>bryan@basho.com</tt></a>).</p>
- <h2><a name="description">Description</a></h2>Development server. Periodically performs a "make" and loads new files.
- When new files are loaded the caches are emptied.
- <h2><a name="index">Function Index</a></h2>
- <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td>Convert process state when code is changed.</td></tr>
- <tr><td valign="top"><a href="#debug_stream-3">debug_stream/3</a></td><td>Stream specific debug information to an area on the current page.</td></tr>
- <tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td>Trap unknown calls.</td></tr>
- <tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
- <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td>Periodic check if the dev server is still running.</td></tr>
- <tr><td valign="top"><a href="#init-1">init/1</a></td><td>Initiates the server.</td></tr>
- <tr><td valign="top"><a href="#make-1">make/1</a></td><td></td></tr>
- <tr><td valign="top"><a href="#observe_debug_stream-2">observe_debug_stream/2</a></td><td>Stream all debug information of a certain kind to the target id on the user agent.</td></tr>
- <tr><td valign="top"><a href="#page_debug_stream-3">page_debug_stream/3</a></td><td>Process started and linked to the current page, subscribes to debug notifications.</td></tr>
- <tr><td valign="top"><a href="#page_debug_stream_loop-3">page_debug_stream_loop/3</a></td><td></td></tr>
- <tr><td valign="top"><a href="#pid_observe_development_make-3">pid_observe_development_make/3</a></td><td></td></tr>
- <tr><td valign="top"><a href="#pid_observe_development_reload-3">pid_observe_development_reload/3</a></td><td></td></tr>
- <tr><td valign="top"><a href="#reload-1">reload/1</a></td><td></td></tr>
- <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td>Starts the server.</td></tr>
- <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td>This function is called by a gen_server when it is about to
- terminate.</td></tr>
- </table>
- <h2><a name="functions">Function Details</a></h2>
- <h3 class="function"><a name="code_change-3">code_change/3</a></h3>
- <div class="spec">
- <p><tt>code_change(OldVsn, State, Extra) -> {ok, NewState}</tt></p>
- </div><p>Convert process state when code is changed</p>
- <h3 class="function"><a name="debug_stream-3">debug_stream/3</a></h3>
- <div class="spec">
- <p><tt>debug_stream(TargetId, What, Context) -> any()</tt></p>
- </div><p>Stream specific debug information to an area on the current page.</p>
- <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
- <div class="spec">
- <p><tt>handle_call(Message::Request, From, State) -> {reply, Reply, State} | {reply, Reply, State, Timeout} | {noreply, State} | {noreply, State, Timeout} | {stop, Reason, Reply, State} | {stop, Reason, State}</tt></p>
- </div><p>Trap unknown calls</p>
- <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
- <div class="spec">
- <p><tt>handle_cast(Message::Msg, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
- </div>
- <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
- <div class="spec">
- <p><tt>handle_info(Info, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
- </div><p>Periodic check if the dev server is still running.</p>
- <h3 class="function"><a name="init-1">init/1</a></h3>
- <div class="spec">
- <p><tt>init(Args) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p>
- </div><p>Initiates the server.</p>
- <h3 class="function"><a name="make-1">make/1</a></h3>
- <div class="spec">
- <p><tt>make(Context) -> any()</tt></p>
- </div>
- <h3 class="function"><a name="observe_debug_stream-2">observe_debug_stream/2</a></h3>
- <div class="spec">
- <p><tt>observe_debug_stream(Debug_stream, Context) -> any()</tt></p>
- </div><p>Stream all debug information of a certain kind to the target id on the user agent.</p>
- <h3 class="function"><a name="page_debug_stream-3">page_debug_stream/3</a></h3>
- <div class="spec">
- <p><tt>page_debug_stream(TargetId, What, Context) -> any()</tt></p>
- </div><p>Process started and linked to the current page, subscribes to debug notifications</p>
- <h3 class="function"><a name="page_debug_stream_loop-3">page_debug_stream_loop/3</a></h3>
- <div class="spec">
- <p><tt>page_debug_stream_loop(TargetId, What, Context) -> any()</tt></p>
- </div>
- <h3 class="function"><a name="pid_observe_development_make-3">pid_observe_development_make/3</a></h3>
- <div class="spec">
- <p><tt>pid_observe_development_make(Pid, X2, Context) -> any()</tt></p>
- </div>
- <h3 class="function"><a name="pid_observe_development_reload-3">pid_observe_development_reload/3</a></h3>
- <div class="spec">
- <p><tt>pid_observe_development_reload(Pid, X2, Context) -> any()</tt></p>
- </div>
- <h3 class="function"><a name="reload-1">reload/1</a></h3>
- <div class="spec">
- <p><tt>reload(Context) -> any()</tt></p>
- </div>
- <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
- <div class="spec">
- <p><tt>start_link(Args) -> {ok, Pid} | ignore | {error, Error}</tt></p>
- </div><p>Starts the server</p>
- <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
- <div class="spec">
- <p><tt>terminate(Reason, State) -> <a href="#type-void">void()</a></tt></p>
- </div><p>This function is called by a gen_server when it is about to
- terminate. It should be the opposite of Module:init/1 and do any necessary
- cleaning up. When it returns, the gen_server terminates with Reason.
- The return value is ignored.</p>
- <hr>
- <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
- <p><i>Generated by EDoc, Oct 13 2011, 14:45:57.</i></p>
- </body>
- </html>