Daiki Kato
/
DhcpServer
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: GR-PEACH_WebCamera_AP
Revision 1:14ee6da645a9, committed 2016-04-06
- Comitter:
- dkato
- Date:
- Wed Apr 06 03:11:10 2016 +0000
- Parent:
- 0:1c2747611cab
- Commit message:
- Add documents
Changed in this revision
| DhcpServer.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/DhcpServer.h Fri Mar 25 05:00:52 2016 +0000
+++ b/DhcpServer.h Wed Apr 06 03:11:10 2016 +0000
@@ -1,10 +1,27 @@
+/**************************************************************************//**
+* @file DhcpServer.h
+* @brief DhcpServer API
+******************************************************************************/
#ifndef DHCP_SERVER_H_
#define DHCP_SERVER_H_
+/** This class is intended for use the mbed board as a DHCP server.
+ * This class can be allocated five IP addresses.
+ * Top 3byte of IP address is the same as the server address, the lower 1byte is 10-14 is allocated.
+ * For example, if the server address is "192.168.0.1", IP address will be allocated "192.168.0.10" ~ "192.168.0.14".
+ */
class DhcpServer {
public:
+ /** Constructor: Initializes DhcpServer.
+ *
+ * @param name a pointer to a string containing the server name. (e.g."ServerName")
+ * @param ipadder a pointer to a string containing the server IP address. (e.g."192.168.0.1")
+ */
DhcpServer(char * name, char * ipadder);
+
+ /** Destructor
+ *
+ */
virtual ~DhcpServer();
};
-
-#endif
+#endif /* DHCP_SERVER_H_ */