130 lines
10 KiB
HTML
130 lines
10 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>uIP 1.0: apps/telnetd/shell.h Source File</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.6 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structures</span></a></li>
|
|
<li id="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul></div>
|
|
<h1>apps/telnetd/shell.h</h1><a href="a00107.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * \file</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> * Interface for the Contiki shell.</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * \author Adam Dunkels <adam@dunkels.com></span>
|
|
<a name="l00005"></a>00005 <span class="comment"> *</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * Some of the functions declared in this file must be implemented as</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * a shell back-end in the architecture specific files of a Contiki</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * port.</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> */</span>
|
|
<a name="l00010"></a>00010
|
|
<a name="l00011"></a>00011
|
|
<a name="l00012"></a>00012 <span class="comment">/*</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> * Copyright (c) 2003, Adam Dunkels.</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * All rights reserved.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> *</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * modification, are permitted provided that the following conditions</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * are met:</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span>
|
|
<a name="l00025"></a>00025 <span class="comment"> * products derived from this software without specific prior</span>
|
|
<a name="l00026"></a>00026 <span class="comment"> * written permission.</span>
|
|
<a name="l00027"></a>00027 <span class="comment"> *</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
|
|
<a name="l00039"></a>00039 <span class="comment"> *</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * This file is part of the Contiki desktop OS.</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> *</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * $Id: shell.h,v 1.1 2006/06/07 09:43:54 adam Exp $</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> *</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> */</span>
|
|
<a name="l00045"></a>00045 <span class="preprocessor">#ifndef __SHELL_H__</span>
|
|
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#define __SHELL_H__</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00048"></a>00048 <span class="comment">/**</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> * Initialize the shell.</span>
|
|
<a name="l00050"></a>00050 <span class="comment"> *</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> * Called when the shell front-end process starts. This function may</span>
|
|
<a name="l00052"></a>00052 <span class="comment"> * be used to start listening for signals.</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> */</span>
|
|
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="a00107.html#69b075ef7e4d7bcf5a903d3d75baac02">shell_init</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00055"></a>00055 <span class="comment"></span>
|
|
<a name="l00056"></a>00056 <span class="comment">/**</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * Start the shell back-end.</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> *</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> * Called by the front-end when a new shell is started.</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> */</span>
|
|
<a name="l00061"></a>00061 <span class="keywordtype">void</span> <a class="code" href="a00107.html#d1f18f739da7703628c3663209463a0d">shell_start</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00062"></a>00062 <span class="comment"></span>
|
|
<a name="l00063"></a>00063 <span class="comment">/**</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * Process a shell command.</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> *</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * This function will be called by the shell GUI / telnet server whan</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * a command has been entered that should be processed by the shell</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * back-end.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> *</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * \param command The command to be processed.</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> */</span>
|
|
<a name="l00072"></a>00072 <span class="keywordtype">void</span> <a class="code" href="a00107.html#86beee1f69d05b16022dfb430470e9ce">shell_input</a>(<span class="keywordtype">char</span> *command);
|
|
<a name="l00073"></a>00073 <span class="comment"></span>
|
|
<a name="l00074"></a>00074 <span class="comment">/**</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> * Quit the shell.</span>
|
|
<a name="l00076"></a>00076 <span class="comment"> *</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> */</span>
|
|
<a name="l00078"></a>00078 <span class="keywordtype">void</span> shell_quit(<span class="keywordtype">char</span> *);
|
|
<a name="l00079"></a>00079
|
|
<a name="l00080"></a>00080 <span class="comment"></span>
|
|
<a name="l00081"></a>00081 <span class="comment">/**</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> * Print a string to the shell window.</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> *</span>
|
|
<a name="l00084"></a>00084 <span class="comment"> * This function is implemented by the shell GUI / telnet server and</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * can be called by the shell back-end to output a string in the</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> * shell window. The string is automatically appended with a linebreak.</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> *</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * \param str1 The first half of the string to be output.</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * \param str2 The second half of the string to be output.</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> */</span>
|
|
<a name="l00091"></a>00091 <span class="keywordtype">void</span> shell_output(<span class="keywordtype">char</span> *str1, <span class="keywordtype">char</span> *str2);
|
|
<a name="l00092"></a>00092 <span class="comment"></span>
|
|
<a name="l00093"></a>00093 <span class="comment">/**</span>
|
|
<a name="l00094"></a>00094 <span class="comment"> * Print a prompt to the shell window.</span>
|
|
<a name="l00095"></a>00095 <span class="comment"> *</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> * This function can be used by the shell back-end to print out a</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * prompt to the shell window.</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> *</span>
|
|
<a name="l00099"></a>00099 <span class="comment"> * \param prompt The prompt to be printed.</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> *</span>
|
|
<a name="l00101"></a>00101 <span class="comment"> */</span>
|
|
<a name="l00102"></a>00102 <span class="keywordtype">void</span> shell_prompt(<span class="keywordtype">char</span> *prompt);
|
|
<a name="l00103"></a>00103
|
|
<a name="l00104"></a>00104 <span class="preprocessor">#endif </span><span class="comment">/* __SHELL_H__ */</span>
|
|
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
</body>
|
|
</html>
|