第32章 RL-TCPnet之Telnet服务器

STM32

转最新网络教程
本章节为大家讲解RL-TCPnet的Telnet应用，学习本章节前，务必要优先学习第31章的Telnet基础知识。有了这些基础知识之后，再搞本章节会有事半功倍的效果。
本章教程含STM32F407开发板和STM32F429开发板。
32.1 初学者重要提示
32.2 Telnet函数
32.3 Telnet配置说明（Net_Config.c）
32.4 Telnet调试说明（Net_Debug.c）
32.5 Telnet访问方法和板子的操作步骤
32.6 实验例程说明（裸机）
32.7 实验例程说明（RTX）
32.8 总结

lee_st · 2017-12-10 08:54:23

32.1 初学者重要提示

1、学习本章节前，务必保证已经学习了第31章的基础知识。
2、对于初学者，务必要看本章节32.5小节的测试方法。

lee_st · 2017-12-10 08:54:48

32.2 Telnet函数

使用如下9个函数可以实现RL-TCPnet的Telnet：
（1）tnet_check_account
（2）tnet_accept_host
（3）tnet_cbfunc
（4）tnet_ccmp
（5）tnet_get_info
（6）tnet_get_user_id
（7）tnet_process_cmd
（8）tnet_set_delay
（9）tnet_msg_poll

lee_st · 2017-12-10 08:55:09

关于这9个函数的讲解及其使用方法可以看教程第 3 章 3.4 小节里面说的参考资料 rlarm.chm 文件：

lee_st · 2017-12-10 08:55:38

这里我们重点的说以下4个函数，因为本章节配套的例子使用的是这4个函数：
（1）tnet_cbfunc
（2）tnet_process_cmd
（3）tnet_ccmp
（4）tnet_get_info
关于这些函数注意以下一点：
1、Telnet的所有函数都不支持重入，也就是不支持多任务调用。

lee_st · 2017-12-10 08:56:32

32.2.1 函数tnet_cbfunc

函数原型：
U16 tnet_cbfunc (
    U8  code,        /* 消息类型 */
    U8* buf,         /* 输出缓冲区地址 */
U16 buflen );    /* 输出缓冲区大小 */

lee_st · 2017-12-10 08:56:47

函数描述：
函数tnet_cbfunc是Telnet服务器的回调函数，主要用于设置Telnet服务器给Telnet客户端发送连接和登录消息（为了更好理解此函数，实际操作一遍本章节配套的例子就明白了）。
1、第1个参数是消息类型，具体支持的消息类型如下：

lee_st · 2017-12-10 08:57:11

2、第2个参数是输出缓冲区地址，用于存储服务器返回给客户端的消息。
3、第3个参数是输出缓冲区大小，单位字节。
4、返回值，返回使用的输出缓冲区大小，单位字节。

lee_st · 2017-12-10 08:57:44

使用这个函数要注意以下问题：
1.    输出缓冲区的大小是由TCP Socket的MSS最大报文段大小决定的，局域网中一般是1400字节左右，但是也可减小到500字节，甚至更小。
2.    写到输出缓冲区的数据，不可以超过第三个参数buflen的大小，否则会造成内存指针链表的损坏，从而很容易造成系统崩溃。
3.    Telnet服务器不会自动扩展回车符，所以每个消息结束后务必自行加上回车和换行符。

lee_st · 2017-12-10 08:58:01

使用举例：
/*----------------------------------------------------------------------------
*      Telnet CallBack Functions
*---------------------------------------------------------------------------*/
/*--------------------------- tnet_cbfunc -----------------------------------*/

U16 tnet_cbfunc (U8 code, U8 *buf, U16 buflen)
{
     /* This function is called by the Telnet Client to get formated system    */
     /* messages for different code values.                                    */
     /* Values for 'code':                                                     */
     /*    0 - initial header                                                  */
     /*    1 - prompt string                                                   */
     /*    2 - header for login only if authorization is enabled               */
     /*    3 - string 'Username' for login                                     */
     /*    4 - string 'Password' for login                                     */
     /*    5 - message 'Login incorrect'                                       */
     /*    6 - message 'Login timeout'                                         */
     /*    7 - Unsolicited messages from Server (ie. Basic Interpreter)        */
     U16 len = 0;

     /* Make a reference to disable compiler warning. */
     buflen = buflen;

     switch (code)
     {
         case 0:
              /* Write initial header after login. */
              len = str_copy (buf, (U8 *)&tnet_header);
              break;

         case 1:
              /* Write a prompt string. */
              len = str_copy (buf, "rnarmfly> ");
              break;
         case 2:
              /* Write Login header. */
              len = str_copy (buf, CLS "rnRL-TCPnet之Telnet服务器,"
                                          " 请登录...rn");
              break;

         case 3:
              /* Write 'username' prompt. */
              len = str_copy (buf, "rn用户名: ");
              break;

         case 4:
              /* Write 'Password' prompt. */
              len = str_copy (buf, "rn密  码: ");
              break;

         case 5:
              /* Write 'Login incorrect'.message. */
              len = str_copy (buf, "rn登录失败");
              break;

         case 6:
              /* Write 'Login Timeout' message. */
              len = str_copy (buf, "rn120秒无操作，退出登录rn");
              break;
     }

     return (len);
}

lee_st · 2017-12-10 08:58:22

32.2.2 函数tnet_process_cmd

函数原型：
U16 tnet_process_cmd (
    U8*  cmd,       /* 指针变量，指向从Telnet客户端接收到的命令字符 */
    U8*  buf,       /* 输出缓冲区地址 */
    U16  buflen,    /* 输出缓冲区大小，单位字节 */
U32* pvar );    /* 指针变量，指向一个不会被改变的变量  */

lee_st · 2017-12-10 08:58:40

函数描述：
函数tnet_process_cmd用于处理Telnet客户端请求的命令。Telnet服务器从Telnet客户端收到连续的回车（CR）和换行（LF）字符序列时，会调用tnet_process_cmd函数（通常由用户在telnet客户端终端上按Enter键）。
1、第1个参数指向从Telnet客户端接收到的命令字符。
2、第2个参数是输出缓冲区地址，用于函数tnet_process_cmd执行过程中存储要返回给Telnet客户端的消息。
3、第3个参数是输出缓冲区的大小，单位字节。
4、第4个参数指向不会被Telnet服务器更改的变量。用户可以将其作为重复计数器，或者简单地区分tnet_process_cmd函数的不同调用，亦或者任何其它应用均可。

lee_st · 2017-12-10 08:59:47

5、返回值，返回写入到输出缓冲区的字节数。返回值是U16类型的，其中bit15和bit14还可以作为其它用途，而剩余的bit0-bit13表示的最大值是16383，足够表示TCP Socket的MSS最大报文段大小的1460字节。
（1）bit14作为函数tnet_process_cmd是否重复调用的标志，如果此位设置为1，表示退出函数后，依然保持第1个参数cmd和第4个参数*pvar的数值，并再次调用函数tnet_process_cmd。如果此位设置为0，将不再重复调用。
（2）bit15是断开连接标志，如果此位设置为1，Telnet服务器将断开客户端会话。如果此位是0，表示继续保证连接。

lee_st · 2017-12-10 09:00:06

使用这个函数要注意以下问题：
1.    输出缓冲区的大小是由TCP Socket的MSS最大报文段大小决定的，局域网中一般是1400字节左右，但是也可减小到500字节，甚至更小。
2.    写到输出缓冲区的数据，不可以超过第三个参数buflen的大小，否则会造成内存指针链表的损坏，从而很容易造成系统崩溃。
3.    Telnet服务器不会自动扩展回车符，所以每个消息结束后务必自行加上回车和换行符。
4.    对于每个Telnet会话，*pvar（注意，这里是指的指针变量pvar所指向的存储单元）变量都是独立的，也就是说新创建一个会话，都会有一个独立的*pvar变量。另外，每个会话首次调用函数tnet_process_cmd之前都会将变量*pvar清零（注意，这里是指的指针变量pvar所指向的存储单元清零）。

lee_st · 2017-12-10 09:00:29

使用举例：
/*--------------------------- tnet_process_cmd ------------------------------*/

U16 tnet_process_cmd (U8 *cmd, U8 *buf, U16 buflen, U32 *pvar)
{
     /* This is a Telnet Client callback function to make a formatted output   */
     /* for 'stdout'. It returns the number of bytes written to the out buffer.*/
     /* Hi-bit of return value (len is or-ed with 0x8000) is a disconnect flag.*/
     /* Bit 14 (len is or-ed with 0x4000) is a repeat flag for the Tnet client.*/
     /* If this bit is set to 1, the system will call the 'tnet_process_cmd()' */
     /* again with parameter 'pvar' pointing to a 4-byte buffer. This buffer   */
     /* can be used for storing different status variables for this function.  */
     /* It is set to 0 by Telnet server on first call and is not altered by    */
     /* Telnet server for repeated calls. This function should NEVER write     */
     /* more than 'buflen' bytes to the buffer.                                */
     /* Parameters:                                                            */
     /*   cmd    - telnet received command string                              */
     /*   buf    - Telnet transmit buffer                                      */
     /*   buflen - length of this buffer (500-1400 bytes - depends on MSS)     */
     /*   pvar   - pointer to local storage buffer used for repeated loops     */
     /*            This is a U32 variable - size is 4 bytes. Value is:         */
     /*            - on 1st call = 0                                           */
     /*            - 2nd call    = as set by this function on first call       */
     REMOTEM rm;
     U16 len = 0;


     switch (MYBUF(pvar)->id)
     {
         case 0:
              /* First call to this function, the value of '*pvar' is 0 */
              break;

         case 1:
              /* Request a repeated call, bit 14 is a repeat flag. */
              return (len | 0x4000);

         case 2:
              /* Request a repeated call, bit 14 is a repeat flag. */
              return (len |= 0x4000);
     }

     /* Simple Command line parser */
     len = strlen ((const char *)cmd);

     if (tnet_ccmp (cmd, "LEDON") == __TRUE)
     {
          /* 'LED4' command received */
         len = str_copy (buf,"rn=====>LED4 Lights ON");
         bsp_LedOn(4);
         return (len);
     }

     if (tnet_ccmp (cmd, "LEDOFF") == __TRUE)
     {
         /* 'LED4' command received */
          len = str_copy (buf,"rn=====>LED4 Lights OFF");
         bsp_LedOff(4);
         return (len);
     }

     if (tnet_ccmp (cmd, "BYE") == __TRUE)
     {
          /* 'BYE' command, send message and disconnect */
         len = str_copy (buf, "rnDisconnect...rn");
         /* Hi bit of return value is a disconnect flag */
         return (len | 0x8000);
     }

     if (tnet_ccmp (cmd, "RINFO") == __TRUE)
     {
          /* Display Remote Machine IP and MAC address. */
         tnet_get_info (&rm);
         len  = sprintf ((char *)buf,"rn Remote IP : %d.%d.%d.%d",
         rm.IpAdr[0],rm.IpAdr[1],rm.IpAdr[2],rm.IpAdr[3]);
         len += sprintf ((char *)(buf+len),
         "rn Remote MAC: %02X-%02X-%02X-%02X-%02X-%02X",
         rm.HwAdr[0],rm.HwAdr[1],rm.HwAdr[2],
         rm.HwAdr[3],rm.HwAdr[4],rm.HwAdr[5]);
         return (len);
     }

     if (tnet_ccmp (cmd, "HELP") == __TRUE || tnet_ccmp (cmd, "?") == __TRUE)
     {
          /* 'HELP' command, display help text */
         len = str_copy (buf,(U8 *)tnet_help1);
         len += str_copy (buf+len,(U8 *)tnet_help2);
         return (len);
     }

     /* Unknown command, display message */
     len = str_copy  (buf, "rn==> Unknown Command: ");
     len += str_copy (buf+len, cmd);
     return (len);
}

lee_st · 2017-12-10 09:00:50

32.2.3 函数tnet_ccmp

函数原型：
BOOL tnet_ccmp (
U8* buf, /* 字符串地址 */
U8* cmd ); /* 要比较的字符串地址 */

lee_st · 2017-12-10 09:01:23

函数描述：
函数tnet_ccmp用于查询字符串中是否有要找的字符。
1、第1个参数是字符串地址。
2、第2个参数是要比较的字符串，即判断第1个参数的字符串里面是否有要查找的字符。
3、返回值，如果字符串中含有要查找的字符，返回__TRUE。如果没有，返回__FALSE。

lee_st · 2017-12-10 09:01:43

使用这个函数要注意以下问题：
1. 此函数类似C标准库函数strcmp，区别是tnet_ccmp仅比较第一个字符串，即在第1个参数buf中，该字符串由NULL字符终止，或后跟空格字符。
2. 字符串cmd中的所有字符必须大写，因为参数buf中的字符串也只有大写字母。这是因为在调用tnet_ccmp函数之前进行了内部转换。

lee_st · 2017-12-10 09:01:58

使用举例：
/*--------------------------- tnet_process_cmd ------------------------------*/

U16 tnet_process_cmd (U8 *cmd, U8 *buf, U16 buflen, U32 *pvar)
{
     /* This is a Telnet Client callback function to make a formatted output   */
     /* for 'stdout'. It returns the number of bytes written to the out buffer.*/
     /* Hi-bit of return value (len is or-ed with 0x8000) is a disconnect flag.*/
     /* Bit 14 (len is or-ed with 0x4000) is a repeat flag for the Tnet client.*/
     /* If this bit is set to 1, the system will call the 'tnet_process_cmd()' */
     /* again with parameter 'pvar' pointing to a 4-byte buffer. This buffer   */
     /* can be used for storing different status variables for this function.  */
     /* It is set to 0 by Telnet server on first call and is not altered by    */
     /* Telnet server for repeated calls. This function should NEVER write     */
     /* more than 'buflen' bytes to the buffer.                                */
     /* Parameters:                                                            */
     /*   cmd    - telnet received command string                              */
     /*   buf    - Telnet transmit buffer                                      */
     /*   buflen - length of this buffer (500-1400 bytes - depends on MSS)     */
     /*   pvar   - pointer to local storage buffer used for repeated loops     */
     /*            This is a U32 variable - size is 4 bytes. Value is:         */
     /*            - on 1st call = 0                                           */
     /*            - 2nd call    = as set by this function on first call       */
     REMOTEM rm;
     U16 len = 0;


     switch (MYBUF(pvar)->id)
     {
         case 0:
              /* First call to this function, the value of '*pvar' is 0 */
              break;

         case 1:
              /* Request a repeated call, bit 14 is a repeat flag. */
              return (len | 0x4000);

         case 2:
              /* Request a repeated call, bit 14 is a repeat flag. */
              return (len |= 0x4000);
     }

     /* Simple Command line parser */
     len = strlen ((const char *)cmd);

     if (tnet_ccmp (cmd, "LEDON") == __TRUE)
     {
          /* 'LED4' command received */
         len = str_copy (buf,"rn=====>LED4 Lights ON");
         bsp_LedOn(4);
         return (len);
     }

     if (tnet_ccmp (cmd, "LEDOFF") == __TRUE)
     {
         /* 'LED4' command received */
          len = str_copy (buf,"rn=====>LED4 Lights OFF");
         bsp_LedOff(4);
         return (len);
     }

     if (tnet_ccmp (cmd, "BYE") == __TRUE)
     {
          /* 'BYE' command, send message and disconnect */
         len = str_copy (buf, "rnDisconnect...rn");
         /* Hi bit of return value is a disconnect flag */
         return (len | 0x8000);
     }

     if (tnet_ccmp (cmd, "RINFO") == __TRUE)
     {
          /* Display Remote Machine IP and MAC address. */
         tnet_get_info (&rm);
         len  = sprintf ((char *)buf,"rn Remote IP : %d.%d.%d.%d",
         rm.IpAdr[0],rm.IpAdr[1],rm.IpAdr[2],rm.IpAdr[3]);
         len += sprintf ((char *)(buf+len),
         "rn Remote MAC: %02X-%02X-%02X-%02X-%02X-%02X",
         rm.HwAdr[0],rm.HwAdr[1],rm.HwAdr[2],
         rm.HwAdr[3],rm.HwAdr[4],rm.HwAdr[5]);
         return (len);
     }

     if (tnet_ccmp (cmd, "HELP") == __TRUE || tnet_ccmp (cmd, "?") == __TRUE)
     {
          /* 'HELP' command, display help text */
         len = str_copy (buf,(U8 *)tnet_help1);
         len += str_copy (buf+len,(U8 *)tnet_help2);
         return (len);
     }

     /* Unknown command, display message */
     len = str_copy  (buf, "rn==> Unknown Command: ");
     len += str_copy (buf+len, cmd);
     return (len);
}