Add new psock layer; telnet session is now wrapped in a character device

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4347 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 88 insertions, 30 deletions

diff --git a/apps/include/netutils/telnetd.h b/apps/include/netutils/telnetd.h
index 9d3d6feaf..37e7dfd4f 100644
--- a/apps/include/netutils/telnetd.h
+++ b/apps/include/netutils/telnetd.h
@@ -1,14 +1,8 @@
 /****************************************************************************
  * include/apps/netutils/telnetd.h
  *
- *   Copyright (C) 2007, 2011 Gregory Nutt. All rights reserved.
- *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
- *
- * This is a leverage of similar logic from uIP:
- *
- *   Author: Adam Dunkels <adam@sics.se>
- *   Copyright (c) 2003, Adam Dunkels.
- *   All rights reserved.
+ *   Copyright (C) 2007, 2011-2012 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -17,35 +11,83 @@
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 3. Neither the name of the Institute nor the names of its contributors
- *    may be used to endorse or promote products derived from this software
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name Gregory Nutt nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
  *    without specific prior written permission.
  *
- * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
  ****************************************************************************/
 
-#ifndef __APPS_NETUTILS_TELNETD_H
-#define __APPS_NETUTILS_TELNETD_H
+#ifndef __APPS_INCLUDE_NETUTILS_TELNETD_H
+#define __APPS_INCLUDE_NETUTILS_TELNETD_H
 
 /****************************************************************************
  * Included Files
  ****************************************************************************/
 
+#include <nuttx/config.h>
+
 /****************************************************************************
- * Included Files
+ * Pre-processor Definitions
  ****************************************************************************/
+/* CONFIG_TELNETD_CONSOLE - Use the first telnet session as the default
+ *   console.
+ * CONFIG_TELNETD_NPOLLWAITERS - If the poll method is enabled, then this
+ *   value will defined the maximum number of threads that can be waiting
+ *   for events.  Default: 1
+ * CONFIG_TELNETD_DUMPBUFFER - dumping of all input/output buffers.
+ */
+
+#ifndef CONFIG_TELNETD_NPOLLWAITERS
+#  define CONFIG_TELNETD_NPOLLWAITERS 1
+#endif
+
+/* Configurable settings */
+
+#ifndef CONFIG_TELNETD_IOBUFFER_SIZE
+# define CONFIG_TELNETD_IOBUFFER_SIZE 512
+#endif
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+ /* An instance of the struct telnetd_config_s structure must be passed to
+ * telnetd_start in order to configure the new telnet daemon.
+ */
+
+struct telnetd_config_s
+{
+  /* These fields describe the telnet daemon */
+
+  int    d_port;      /* The port to listen on (in network byte order) */
+  int    d_priority;  /* The execution priority of the telnet daemon task */
+  int    d_stacksize; /* The stack size needed by the telnet daemon task */
+
+  /* These fields describe the priority of each thread created by the telnet
+   * daemon.
+   */
+
+  int    t_priority;  /* The execution priority of the spawned task, */
+  int    t_stacksize; /* The stack size needed by the spawned task */
+  main_t t_entry;     /* The entrypoint of the task to spawn when a new
+                       * connection is accepted. */
+};
 
 /****************************************************************************
  * Public Function Prototypes
@@ -58,13 +100,29 @@ extern "C" {
 #define EXTERN extern
 #endif
 
-/* Start the telnet server -- does not return unless an error occurs */
+/****************************************************************************
+ * Name: telnetd_start
+ *
+ * Description:
+ *   Start the telnet daemon.
+ *
+ * Parameters:
+ *   config    A pointer to a configuration structure that characterizes the
+ *             telnet daemon.  This configuration structure may be defined
+ *             on the caller's stack because it is not retained by the
+ *             daemon.
+ *
+ * Return:
+ *   The process ID (pid) of the new telnet daemon is returned on
+ *   success; A negated errno is returned if the daemon was not successfully
+ *   started.
+ *
+ ****************************************************************************/
 
-EXTERN void telnetd_init(void);
+EXTERN int telnetd_start(FAR struct telnetd_config_s *config);
 
 #undef EXTERN
 #ifdef __cplusplus
 }
 #endif
-
-#endif /* __APPS_NETUTILS_TELNETD_H */
+#endif /* __APPS_INCLUDE_NETUTILS_TELNETD_H */