M3 Board Socket Communication
Dependencies: Socket lwip-eth lwip-sys lwip
Fork of EthernetInterface by
EthernetInterface.h@55:f42b26560a20, 2016-06-16 (annotated)
- Committer:
- bulmecisco
- Date:
- Thu Jun 16 16:49:57 2016 +0000
- Revision:
- 55:f42b26560a20
- Parent:
- 52:f81b90d9a441
M3 Board Socket Communication
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
donatien | 3:f5776537f27f | 1 | /* EthernetInterface.h */ |
donatien | 3:f5776537f27f | 2 | /* Copyright (C) 2012 mbed.org, MIT License |
donatien | 3:f5776537f27f | 3 | * |
donatien | 3:f5776537f27f | 4 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
donatien | 3:f5776537f27f | 5 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
donatien | 3:f5776537f27f | 6 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
donatien | 3:f5776537f27f | 7 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
donatien | 3:f5776537f27f | 8 | * furnished to do so, subject to the following conditions: |
donatien | 3:f5776537f27f | 9 | * |
donatien | 3:f5776537f27f | 10 | * The above copyright notice and this permission notice shall be included in all copies or |
donatien | 3:f5776537f27f | 11 | * substantial portions of the Software. |
donatien | 3:f5776537f27f | 12 | * |
donatien | 3:f5776537f27f | 13 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
donatien | 3:f5776537f27f | 14 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
donatien | 3:f5776537f27f | 15 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
donatien | 3:f5776537f27f | 16 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
donatien | 3:f5776537f27f | 17 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
donatien | 3:f5776537f27f | 18 | */ |
donatien | 3:f5776537f27f | 19 | |
donatien | 3:f5776537f27f | 20 | #ifndef ETHERNETINTERFACE_H_ |
donatien | 3:f5776537f27f | 21 | #define ETHERNETINTERFACE_H_ |
donatien | 3:f5776537f27f | 22 | |
mbed_official | 52:f81b90d9a441 | 23 | #if !defined(TARGET_LPC1768) && !defined(TARGET_LPC4088) && !defined(TARGET_LPC4088_DM) && !defined(TARGET_K64F) && !defined(TARGET_RZ_A1H) && !defined(TARGET_VK_RZ_A1H) && !defined(TARGET_STM32F4) |
mbed_official | 37:926eb6517318 | 24 | #error The Ethernet Interface library is not supported on this target |
emilmont | 23:5d5b40c4378b | 25 | #endif |
emilmont | 23:5d5b40c4378b | 26 | |
donatien | 3:f5776537f27f | 27 | #include "rtos.h" |
donatien | 3:f5776537f27f | 28 | #include "lwip/netif.h" |
donatien | 3:f5776537f27f | 29 | |
donatien | 4:9a52c802be61 | 30 | /** Interface using Ethernet to connect to an IP-based network |
donatien | 3:f5776537f27f | 31 | * |
donatien | 3:f5776537f27f | 32 | */ |
emilmont | 14:cec293071eed | 33 | class EthernetInterface { |
donatien | 3:f5776537f27f | 34 | public: |
donatien | 4:9a52c802be61 | 35 | /** Initialize the interface with DHCP. |
donatien | 4:9a52c802be61 | 36 | * Initialize the interface and configure it to use DHCP (no connection at this point). |
donatien | 4:9a52c802be61 | 37 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 38 | */ |
emilmont | 14:cec293071eed | 39 | static int init(); //With DHCP |
donatien | 3:f5776537f27f | 40 | |
donatien | 4:9a52c802be61 | 41 | /** Initialize the interface with a static IP address. |
donatien | 4:9a52c802be61 | 42 | * Initialize the interface and configure it with the following static configuration (no connection at this point). |
donatien | 4:9a52c802be61 | 43 | * \param ip the IP address to use |
donatien | 4:9a52c802be61 | 44 | * \param mask the IP address mask |
donatien | 4:9a52c802be61 | 45 | * \param gateway the gateway to use |
donatien | 4:9a52c802be61 | 46 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 47 | */ |
emilmont | 14:cec293071eed | 48 | static int init(const char* ip, const char* mask, const char* gateway); |
donatien | 3:f5776537f27f | 49 | |
donatien | 4:9a52c802be61 | 50 | /** Connect |
donatien | 4:9a52c802be61 | 51 | * Bring the interface up, start DHCP if needed. |
emilmont | 30:4d7d7dc8485f | 52 | * \param timeout_ms timeout in ms (default: (15)s). |
donatien | 4:9a52c802be61 | 53 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 54 | */ |
emilmont | 27:2124eae946f3 | 55 | static int connect(unsigned int timeout_ms=15000); |
donatien | 4:9a52c802be61 | 56 | |
donatien | 4:9a52c802be61 | 57 | /** Disconnect |
donatien | 4:9a52c802be61 | 58 | * Bring the interface down |
donatien | 4:9a52c802be61 | 59 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 60 | */ |
emilmont | 14:cec293071eed | 61 | static int disconnect(); |
donatien | 3:f5776537f27f | 62 | |
emilmont | 27:2124eae946f3 | 63 | /** Get the MAC address of your Ethernet interface |
emilmont | 27:2124eae946f3 | 64 | * \return a pointer to a string containing the MAC address |
emilmont | 27:2124eae946f3 | 65 | */ |
emilmont | 27:2124eae946f3 | 66 | static char* getMACAddress(); |
emilmont | 27:2124eae946f3 | 67 | |
emilmont | 27:2124eae946f3 | 68 | /** Get the IP address of your Ethernet interface |
emilmont | 27:2124eae946f3 | 69 | * \return a pointer to a string containing the IP address |
emilmont | 27:2124eae946f3 | 70 | */ |
emilmont | 14:cec293071eed | 71 | static char* getIPAddress(); |
mbed_official | 35:cba86db5ab96 | 72 | |
mbed_official | 35:cba86db5ab96 | 73 | /** Get the Gateway address of your Ethernet interface |
mbed_official | 35:cba86db5ab96 | 74 | * \return a pointer to a string containing the Gateway address |
mbed_official | 35:cba86db5ab96 | 75 | */ |
mbed_official | 35:cba86db5ab96 | 76 | static char* getGateway(); |
mbed_official | 35:cba86db5ab96 | 77 | |
mbed_official | 35:cba86db5ab96 | 78 | /** Get the Network mask of your Ethernet interface |
mbed_official | 35:cba86db5ab96 | 79 | * \return a pointer to a string containing the Network mask |
mbed_official | 35:cba86db5ab96 | 80 | */ |
mbed_official | 35:cba86db5ab96 | 81 | static char* getNetworkMask(); |
donatien | 3:f5776537f27f | 82 | }; |
donatien | 3:f5776537f27f | 83 | |
emilmont | 15:fd9597f1b81b | 84 | #include "TCPSocketConnection.h" |
emilmont | 15:fd9597f1b81b | 85 | #include "TCPSocketServer.h" |
emilmont | 17:b7a3766f6253 | 86 | |
emilmont | 20:0d9ae7845bfe | 87 | #include "Endpoint.h" |
donatien | 3:f5776537f27f | 88 | #include "UDPSocket.h" |
donatien | 3:f5776537f27f | 89 | |
donatien | 3:f5776537f27f | 90 | #endif /* ETHERNETINTERFACE_H_ */ |