VZTECH / Mbed 2 deprecated main_src

Modularizando o src

Dependencies:   EALib EthernetInterface_vz mbed-rtos mbed

Fork of header_main_colinas_V0-20-09-14 by VZTECH

prompt.h@121:ee02790d00b7, 2015-05-08 (annotated)

Committer:
klauss
Date:
Fri May 08 04:15:23 2015 +0000
Revision:
121:ee02790d00b7
Parent:
119:ee6a53069455
Child:
126:1f90756250fb
compiling

Who changed what in which revision?

UserRevisionLine numberNew contents of line
klauss 69:65665afbad5d 1 /**
klauss 69:65665afbad5d 2 * @file prompt.h
klauss 69:65665afbad5d 3 * @Synopsis Implementa as funcionalidades de prompt/prompt-eth da Header.
klauss 69:65665afbad5d 4 * @author Fernando Cola / Jhontan Casale
klauss 69:65665afbad5d 5 * @version 1
klauss 69:65665afbad5d 6 * @date 2014-11-05
klauss 69:65665afbad5d 7 */
klauss 69:65665afbad5d 8
klauss 17:67a6b557eda5 9 #ifndef _PROMPT_H
klauss 17:67a6b557eda5 10 #define _PROMPT_H
klauss 17:67a6b557eda5 11
klauss 44:cc4996469404 12 #include "mbed.h"
klauss 74:81c47fff88a5 13 #include "shared_variables.h"
klauss 74:81c47fff88a5 14 #include "debug.h"
klauss 121:ee02790d00b7 15 #include "bits.h"
klauss 121:ee02790d00b7 16 #include "flood.h"
klauss 44:cc4996469404 17
klauss 119:ee6a53069455 18 const uint8_t PVERSION = 25;
klauss 119:ee6a53069455 19 const uint8_t PROMPT_UDP_COMMAND_SIZE = 64;
klauss 119:ee6a53069455 20 const uint8_t PERSISTENT_TCP_IDLE_MAX_TIME = 30;
klauss 81:3656f00ab3db 21
klauss 119:ee6a53069455 22 const uint16_t TCP_IDLE_MAX_TIME = 360;
klauss 78:1353744f01e1 23 ///< Define o tempo maximo de espera por um novo comando via eth, dado que já estamos em uma sessão TCP.
klauss 78:1353744f01e1 24
klauss 119:ee6a53069455 25 const uint16_t TCP_ALIVE_IDLE_MAX_TIME = 360;
klauss 78:1353744f01e1 26 ///< Define o tempo maximo de espera por um novo comando via eth dado que já estamos em uma sessão TCP e a flag tcp_alive esta on.
klauss 69:65665afbad5d 27
klauss 121:ee02790d00b7 28 const uint16_t PROMPT_ETH_BUFFER_SIZE = 1024;
klauss 121:ee02790d00b7 29 ///< Representa o tamanho máximo do pacote recebido pelo prompt da Header.
klauss 121:ee02790d00b7 30
klauss 121:ee02790d00b7 31 const uint16_t DEBUGBUFSIZE = PROMPT_ETH_BUFFER_SIZE;
klauss 69:65665afbad5d 32 ///< Define o tamanho do buffer de entrada de dados.
klauss 44:cc4996469404 33
klauss 17:67a6b557eda5 34 extern uint8_t dog;
klauss 69:65665afbad5d 35 ///< Variável de controle que ativa a mensagem de boas vindas.
klauss 69:65665afbad5d 36
klauss 121:ee02790d00b7 37 extern bool flood_silence;
klauss 69:65665afbad5d 38
klauss 74:81c47fff88a5 39 extern bool delayed_flood;
klauss 74:81c47fff88a5 40 ///< Variável de controle do envio de pacotes de flood off
klauss 74:81c47fff88a5 41
klauss 78:1353744f01e1 42 extern bool tcp_alive;
klauss 78:1353744f01e1 43 ///< Flag que indica para não dar timeout na conexão tcp
klauss 78:1353744f01e1 44
klauss 114:472502b31a12 45 extern Timer tcp_timer;
klauss 78:1353744f01e1 46 ///< Timer responsavel por dar timeout por não utilização de recurso.
klauss 78:1353744f01e1 47
klauss 69:65665afbad5d 48 /**
klauss 69:65665afbad5d 49 * @Synopsis Principal função de processamento de comandos.
klauss 69:65665afbad5d 50 *
klauss 69:65665afbad5d 51 * \note Apesar de formalmente receber apenas um parâmetro, esta função verifica uma porta TCP para verificar eventual
klauss 69:65665afbad5d 52 * envio de comandos, processando qualquer comando enviado por um usuário ligado na rede.
klauss 69:65665afbad5d 53 *
klauss 69:65665afbad5d 54 * @param ethernet_pkg Uma string de comando que será analisada, caso seja um comando válido, executa-o.
klauss 69:65665afbad5d 55 *
klauss 69:65665afbad5d 56 * @return NULL, sempre retorna NULL.
klauss 69:65665afbad5d 57 *
klauss 69:65665afbad5d 58 * Exemplo:
klauss 69:65665afbad5d 59 * @code
klauss 69:65665afbad5d 60 * ...
klauss 69:65665afbad5d 61 * char * returned_prompt = prompt_process( NULL );
klauss 69:65665afbad5d 62 * ...
klauss 69:65665afbad5d 63 * @endcode
klauss 69:65665afbad5d 64 */
klauss 121:ee02790d00b7 65 char * prompt_process ( char * msg_from_cb, int length );
klauss 28:94aec56c6329 66
klauss 69:65665afbad5d 67 /**
klauss 69:65665afbad5d 68 * @Synopsis Inicializa o prompt e os sockets de conexão eth
klauss 69:65665afbad5d 69 *
klauss 69:65665afbad5d 70 * Exemplo:
klauss 69:65665afbad5d 71 * @code
klauss 69:65665afbad5d 72 * ...
klauss 69:65665afbad5d 73 * init_prompt();
klauss 69:65665afbad5d 74 * ...
klauss 69:65665afbad5d 75 * @endcode
klauss 69:65665afbad5d 76 */
klauss 121:ee02790d00b7 77 int init_prompt_eth ( void );
klauss 69:65665afbad5d 78
klauss 44:cc4996469404 79 extern char * debug_buf;
klauss 69:65665afbad5d 80 ///< Buffer de entrada dos dados via serial.
klauss 17:67a6b557eda5 81
klauss 119:ee6a53069455 82 inline void reconnect_udp_prompt_process( void )
klauss 119:ee6a53069455 83 {
klauss 119:ee6a53069455 84 udp_client.close();
klauss 119:ee6a53069455 85 udp_client.set_blocking( false, 0 );
klauss 119:ee6a53069455 86 udp_client.bind( UDP_PORT_LISTENER );
klauss 119:ee6a53069455 87 }
klauss 119:ee6a53069455 88
klauss 17:67a6b557eda5 89 #endif