C:/asm/STM32-ethernet/ENC28J60prj/uip-master/apps/telnetd/shell.h

См. документацию.

/**
 * \file
 * Интерфейс шелла Contiki.
 * \author Adam Dunkels <adam@dunkels.com>
 *
 * Некоторые функции, декларированые в этом файле, должны быть
 * релаизиваны как фоновая среда поддержки шелла (shell back-end)
 * в файлах, специфичных для архитектуры порта Contiki.
 */


/*
 * Copyright (c) 2003, Adam Dunkels.
 * Все права зарезервированы.
 *
 * Повторное распространение, использование в исходном и двоичном виде,
 * с модификацией или без - разрешается, если выполняются следующие
 * условия:
 * 1. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку.
 * 2. Распространение исходного кода должно сохранить вышеуказанную пометку
 *    копирайта, этот список условий и следующую правовую оговорку в
 *    документации и/или других материалах, которые будут предоставлены
 *    вместе с распространяемыми материалами.
 * 3. Имя автора не может использоваться, чтобы подтвердить или продвинуть
 *    продукты, написанные с использованием этого программного обеспечения
 *    без специального на то разрешения.
 *
 * ЭТО ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ АВТОРОМ ``КАК ЕСТЬ'', БЕЗ
 * КАКОЙ-ЛИБО ЛЮБОЙ РАСШИРЕННОЙ ИЛИ ПОДРАЗУМЕВАЕМОЙ ГАРАНТИИ, ВКЛЮЧАЯ,
 * НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ГАРАНТИИ ВЫСОКОГО СПРОСА И ПРИГОДНОСТИ
 * ДЛЯ КОНКРЕТНОЙ ЦЕЛИ. АВТОР НИ ПРИ КАКИХ УСЛОВИЯХ НЕ ОТВЕТСТВЕНЕН
 * ЗА ЛЮБЫЕ УБЫТКИ - ПРЯМЫЕ, КОСВЕННЫЕ, СЛУЧАЙНЫЕ, СПЕЦИАЛЬНЫЕ, ОБРАЗЦОВЫЕ
 * ИЛИ ПОСЛЕДОВАТЕЛЬНЫЕ (ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ЭТИМ, ТРЕБОВАНИЯ
 * ЗАМЕНЫ ТОВАРА ИЛИ СЕРВИСА; ПОТЕРИ ИСПОЛЬЗОВАНИЯ, ДАННЫХ ИЛИ ВЫГОДЫ;
 * ИЛИ ПРЕКРАЩЕНИЕ БИЗНЕСА), ОДНАКО ВЫЗВАННЫЕ ПО ЛЮБОЙ ТЕОРИИ ОТВЕТСТВЕННОСТИ,
 * ЛИБО В КОНТРАКТЕ, ПРЯМОЙ ОТВЕТСТВЕННОСТИ, ЛИБО В НАРУШЕНИИ ЗАКОННЫХ ПРАВ
 * (ВКЛЮЧАЯ ТАК ИЛИ ИНАЧЕ НЕБРЕЖНОСТЬ), ВОЗНИКАЮЩИЕ ВСЕГДА ИЗ ИСПОЛЬЗОВАНИЯ
 * ЭТОГО ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ, ДАЖЕ ЕСЛИ БЫЛО ПРЕДУПРЕЖДЕНИЕ О ВОЗМОЖНОСТИ
 * ТАКОГО ПОВРЕЖДЕНИЯ.
 *
 * Этот файл является частью Contiki desktop OS.
 *
 * $Id: shell.h,v 1.1 2006/06/07 09:43:54 adam Exp $
 *
 */
#ifndef __SHELL_H__
#define __SHELL_H__

/**
 * Инициализирует шелл.
 *
 * Вызывается, когда запускается процесс внешнего интерфейса с пользователем
 * шелла (shell front-end). Эта функция может использоваться для запуска
 * прослушивания сигналов.
 */
void shell_init(void);

/**
 * Запускает фоновую поддержку шелла (shell back-end).
 *
 * Вызывается внешним интерфейсом (front-end), когда запускается новый шелл.
 */
void shell_start(void);

/**
 * Обрабатывает команды шелла.
 *
 * Эта функция вызывается из графического интерфейса пользователя шелла
 * (shell GUI) / сервера telnet, где введенная команда должна быть
 * обработана фоновой поддержкой шелла (shell back-end).
 *
 * \param command Обрабатываемая команда.
 */
void shell_input(char *command);

/**
 * Выход из шелла.
 *
 */
void shell_quit(char *);


/**
 * Печатает строку в окне шелла.
 *
 * Эта функция реализована в shell GUI / сервере telnet, и может быть
 * вызвана фоновой поддержкой шелла (shell back-end) для вывода строки
 * в рабочем окне шелла. К строке будет автоматически добавлен символ
 * завершения строки (linebreak).
 *
 * \param str1 Первая половина строки для вывода.
 * \param str2 Вторая половина строки для вывода.
 */
void shell_output(char *str1, char *str2);

/**
 * Печатает приглашение (prompt) в окно шелла.
 *
 * Эта функция может использоваться фоновой поддержкой шелла (shell
 * back-end) для вывовда строки приглашения в окно шелла.
 *
 * \param prompt Печатаемое приглашение.
 *
 */
void shell_prompt(char *prompt);

#endif /* __SHELL_H__ */