Ivan Shindev / TCPDebug

TCP Server that can be used as a debug interface

Dependents:   ThreadServer

Fork of TCPDebug by Ivan Shindev

Debug.h@0:c2bfbcc99b65, 2013-06-13 (annotated)

Committer:
lemniskata
Date:
Thu Jun 13 20:01:01 2013 +0000
Revision:
0:c2bfbcc99b65
V1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
lemniskata 0:c2bfbcc99b65 1 /*
lemniskata 0:c2bfbcc99b65 2 ** File name: Debug.h
lemniskata 0:c2bfbcc99b65 3 ** Descriptions: TCP Server that sends debug messages to a connected client
lemniskata 0:c2bfbcc99b65 4 **
lemniskata 0:c2bfbcc99b65 5 **------------------------------------------------------------------------------------------------------
lemniskata 0:c2bfbcc99b65 6 ** Created by: Ivan Shindev
lemniskata 0:c2bfbcc99b65 7 ** Created date: 06/11/2013
lemniskata 0:c2bfbcc99b65 8 ** Version: 1.0
lemniskata 0:c2bfbcc99b65 9 ** Descriptions: The original version
lemniskata 0:c2bfbcc99b65 10 **
lemniskata 0:c2bfbcc99b65 11 **------------------------------------------------------------------------------------------------------
lemniskata 0:c2bfbcc99b65 12 ** Modified by:
lemniskata 0:c2bfbcc99b65 13 ** Modified date:
lemniskata 0:c2bfbcc99b65 14 ** Version:
lemniskata 0:c2bfbcc99b65 15 ** Descriptions:
lemniskata 0:c2bfbcc99b65 16 ********************************************************************************************************/
lemniskata 0:c2bfbcc99b65 17 /* How to use the library
lemniskata 0:c2bfbcc99b65 18 Include Debug.h in any file that sends debugging messages
lemniskata 0:c2bfbcc99b65 19
lemniskata 0:c2bfbcc99b65 20 Start the debugging server in the main
lemniskata 0:c2bfbcc99b65 21 initDebug(); //initialize Debug server
lemniskata 0:c2bfbcc99b65 22 startDebug(debug_port); //start the Debug server
lemniskata 0:c2bfbcc99b65 23 while(!isDebugConnected()) //do nothing until a debug client is connected (optional)
lemniskata 0:c2bfbcc99b65 24 {
lemniskata 0:c2bfbcc99b65 25
lemniskata 0:c2bfbcc99b65 26 }
lemniskata 0:c2bfbcc99b65 27
lemniskata 0:c2bfbcc99b65 28 Send a debugging message to the connected client using sendDebugMessage(char *message)
lemniskata 0:c2bfbcc99b65 29 Example: sendDebugMessage("Initialization failed");
lemniskata 0:c2bfbcc99b65 30
lemniskata 0:c2bfbcc99b65 31
lemniskata 0:c2bfbcc99b65 32 */
lemniskata 0:c2bfbcc99b65 33 #include "EthernetInterface.h"
lemniskata 0:c2bfbcc99b65 34 #include "mbed.h"
lemniskata 0:c2bfbcc99b65 35
lemniskata 0:c2bfbcc99b65 36 #ifndef __DEBUG_H
lemniskata 0:c2bfbcc99b65 37 #define __DEBUG_H
lemniskata 0:c2bfbcc99b65 38
lemniskata 0:c2bfbcc99b65 39
lemniskata 0:c2bfbcc99b65 40 /* connectDebug(void const *port) is the main Debug server Thread
lemniskata 0:c2bfbcc99b65 41
lemniskata 0:c2bfbcc99b65 42 */
lemniskata 0:c2bfbcc99b65 43 void connectDebug(void const *port);
lemniskata 0:c2bfbcc99b65 44
lemniskata 0:c2bfbcc99b65 45 /* sendDebugMessage(char *message) sends a message to the connected client
lemniskata 0:c2bfbcc99b65 46
lemniskata 0:c2bfbcc99b65 47 */
lemniskata 0:c2bfbcc99b65 48 void sendDebugMessage(char *message);
lemniskata 0:c2bfbcc99b65 49
lemniskata 0:c2bfbcc99b65 50 /* startDebug(int port) starts the debugging server in a new Thread
lemniskata 0:c2bfbcc99b65 51
lemniskata 0:c2bfbcc99b65 52 */
lemniskata 0:c2bfbcc99b65 53 void startDebug(int port);
lemniskata 0:c2bfbcc99b65 54
lemniskata 0:c2bfbcc99b65 55 /* initDebug() initializes the _debug_connected variable
lemniskata 0:c2bfbcc99b65 56
lemniskata 0:c2bfbcc99b65 57 */
lemniskata 0:c2bfbcc99b65 58 void initDebug();
lemniskata 0:c2bfbcc99b65 59
lemniskata 0:c2bfbcc99b65 60
lemniskata 0:c2bfbcc99b65 61 int isDebugConnected();
lemniskata 0:c2bfbcc99b65 62 #endif