libs/rt-thread
libs
/
rt-thread
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
rt-thread/components/net/uip/doc/html/a00107.html

269 lines
12 KiB
HTML
Raw Blame History

<!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 File Reference</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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>apps/telnetd/shell.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for the Contiki shell.
<p>
<dl compact><dt><b>Author:</b></dt><dd>Adam Dunkels &lt;<a href="mailto:adam@dunkels.com">adam@dunkels.com</a>&gt;</dd></dl>
Some of the functions declared in this file must be implemented as a shell back-end in the architecture specific files of a Contiki port.
<p>
Definition in file <a class="el" href="a00177.html">shell.h</a>.
<p>
<p>
<a href="a00177.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#69b075ef7e4d7bcf5a903d3d75baac02">shell_init</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the shell. <a href="#69b075ef7e4d7bcf5a903d3d75baac02"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#d1f18f739da7703628c3663209463a0d">shell_start</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start the shell back-end. <a href="#d1f18f739da7703628c3663209463a0d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#86beee1f69d05b16022dfb430470e9ce">shell_input</a> (char *command)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process a shell command. <a href="#86beee1f69d05b16022dfb430470e9ce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="984c4a8b65a3cb35460b073a40568c25"></a><!-- doxytag: member="shell.h::shell_quit" ref="984c4a8b65a3cb35460b073a40568c25" args="(char *)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#984c4a8b65a3cb35460b073a40568c25">shell_quit</a> (char *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Quit the shell. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#f11c966b0e4f4ecaa73deb14bfb6830f">shell_output</a> (char *str1, char *str2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a string to the shell window. <a href="#f11c966b0e4f4ecaa73deb14bfb6830f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html#123c95a7bb55143cabba92446ce8f513">shell_prompt</a> (char *prompt)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print a prompt to the shell window. <a href="#123c95a7bb55143cabba92446ce8f513"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="69b075ef7e4d7bcf5a903d3d75baac02"></a><!-- doxytag: member="shell.h::shell_init" ref="69b075ef7e4d7bcf5a903d3d75baac02" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void shell_init </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Initialize the shell.
<p>
Called when the shell front-end process starts. This function may be used to start listening for signals. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="a00044.html#a221">telnetd.c</a>.</dl>
<p>
Definition at line <a class="el" href="a00176.html#l00105">105</a> of file <a class="el" href="a00176.html">shell.c</a>.
<p>
References <a class="el" href="a00176.html#l00105">shell_init()</a>.
<p>
Referenced by <a class="el" href="a00176.html#l00105">shell_init()</a>. </td>
</tr>
</table>
<a class="anchor" name="86beee1f69d05b16022dfb430470e9ce"></a><!-- doxytag: member="shell.h::shell_input" ref="86beee1f69d05b16022dfb430470e9ce" args="(char *command)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void shell_input </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>command</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Process a shell command.
<p>
This function will be called by the shell GUI / telnet server whan a command has been entered that should be processed by the shell back-end.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>command</em>&nbsp;</td><td>The command to be processed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="a00044.html#a229">telnetd.c</a>.</dl>
<p>
Definition at line <a class="el" href="a00176.html#l00118">118</a> of file <a class="el" href="a00176.html">shell.c</a>.
<p>
References <a class="el" href="a00176.html#l00118">shell_input()</a>.
<p>
Referenced by <a class="el" href="a00176.html#l00118">shell_input()</a>. </td>
</tr>
</table>
<a class="anchor" name="f11c966b0e4f4ecaa73deb14bfb6830f"></a><!-- doxytag: member="shell.h::shell_output" ref="f11c966b0e4f4ecaa73deb14bfb6830f" args="(char *str1, char *str2)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void shell_output </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">char *&nbsp;</td>
<td class="mdname" nowrap> <em>str1</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char *&nbsp;</td>
<td class="mdname" nowrap> <em>str2</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Print a string to the shell window.
<p>
This function is implemented by the shell GUI / telnet server and can be called by the shell back-end to output a string in the shell window. The string is automatically appended with a linebreak.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str1</em>&nbsp;</td><td>The first half of the string to be output. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str2</em>&nbsp;</td><td>The second half of the string to be output. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="a00044.html#a215">telnetd.c</a>.</dl>
<p>
Definition at line <a class="el" href="a00178.html#l00113">113</a> of file <a class="el" href="a00178.html">telnetd.c</a>.
<p>
References <a class="el" href="a00174.html#l00071">ISO_cr</a>, <a class="el" href="a00174.html#l00070">ISO_nl</a>, and <a class="el" href="a00172.html#l00069">NULL</a>. </td>
</tr>
</table>
<a class="anchor" name="123c95a7bb55143cabba92446ce8f513"></a><!-- doxytag: member="shell.h::shell_prompt" ref="123c95a7bb55143cabba92446ce8f513" args="(char *prompt)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void shell_prompt </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">char *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>prompt</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Print a prompt to the shell window.
<p>
This function can be used by the shell back-end to print out a prompt to the shell window.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prompt</em>&nbsp;</td><td>The prompt to be printed. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="a00044.html#a214">telnetd.c</a>.</dl>
<p>
Definition at line <a class="el" href="a00178.html#l00101">101</a> of file <a class="el" href="a00178.html">telnetd.c</a>.
<p>
References <a class="el" href="a00172.html#l00069">NULL</a>. </td>
</tr>
</table>
<a class="anchor" name="d1f18f739da7703628c3663209463a0d"></a><!-- doxytag: member="shell.h::shell_start" ref="d1f18f739da7703628c3663209463a0d" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void shell_start </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Start the shell back-end.
<p>
Called by the front-end when a new shell is started. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="a00044.html#a233">telnetd.c</a>.</dl>
<p>
Definition at line <a class="el" href="a00176.html#l00110">110</a> of file <a class="el" href="a00176.html">shell.c</a>.
<p>
References <a class="el" href="a00176.html#l00110">shell_start()</a>.
<p>
Referenced by <a class="el" href="a00176.html#l00110">shell_start()</a>. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
<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>
View Git Blame Copy Permalink