telnetd.h File Reference

Telnet Daemon Interface. More...

#include <rtems.h>
#include <rtems/shell.h>

Go to the source code of this file.

Data Structures
struct	rtems_telnetd_config_table
	Telnet configuration structure. More...

Typedefs
typedef void(*	rtems_telnetd_command) (char *, void *)
	Telnet command type.

Functions
bool	rtems_telnetd_login_check (const char *user, const char *passphrase)
	Standard Telnet login check that uses DES to encrypt the passphrase.
rtems_status_code	rtems_telnetd_start (const rtems_telnetd_config_table *config)
	Starts the Telnet server using the provided configuration.
rtems_status_code	rtems_telnetd_initialize (void)
	Initializes the Telnet subsystem.

Variables
rtems_telnetd_config_table	rtems_telnetd_config
	Telnet configuration.

Detailed Description

Telnet Daemon Interface.

Function Documentation

rtems_telnetd_initialize()

rtems_status_code rtems_telnetd_initialize

(

void

)

Initializes the Telnet subsystem.

Uses the application provided rtems_telnetd_config configuration table.

rtems_telnetd_login_check()

bool rtems_telnetd_login_check	(	const char *	user,
		const char *	passphrase
	)

Standard Telnet login check that uses DES to encrypt the passphrase.

Takes a passphrase, encrypts it and compares it to the encrypted passphrase in the TELNETD_PASSWD environment variable. No password is required if TELNETD_PASSWD is unset. The argument user is ignored.

rtems_telnetd_start()

rtems_status_code rtems_telnetd_start

(

const rtems_telnetd_config_table *

config

)

Starts the Telnet server using the provided configuration.

Return values

RTEMS_SUCCESSFUL	Successful operation.
RTEMS_INVALID_ADDRESS	The command function in the configuration is NULL.
RTEMS_RESOURCE_IN_USE	The server port is already in use.
RTEMS_NOT_IMPLEMENTED	The keep stdio configuration option is true.
RTEMS_UNSATISFIED	Not enough resources to start the Telnet server or task priority in configuration is invalid.

Variable Documentation

rtems_telnetd_config

rtems_telnetd_config_table rtems_telnetd_config

extern

Telnet configuration.

The application must provide this configuration table. It is used by rtems_telnetd_initialize() to configure the Telnet subsystem. Do not modify the entries after the intialization since it is used internally.