M3 Board Socket Communication
Dependencies: Socket lwip-eth lwip-sys lwip
Fork of EthernetInterface by
EthernetInterface.h@21:8cd2de462559, 2012-08-03 (annotated)
- Committer:
- emilmont
- Date:
- Fri Aug 03 14:43:57 2012 +0000
- Revision:
- 21:8cd2de462559
- Parent:
- 20:0d9ae7845bfe
- Child:
- 23:5d5b40c4378b
Add timeout to network initialization
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 | |
donatien | 3:f5776537f27f | 23 | #include "rtos.h" |
donatien | 3:f5776537f27f | 24 | #include "lwip/netif.h" |
donatien | 3:f5776537f27f | 25 | |
donatien | 4:9a52c802be61 | 26 | /** Interface using Ethernet to connect to an IP-based network |
donatien | 3:f5776537f27f | 27 | * |
donatien | 3:f5776537f27f | 28 | */ |
emilmont | 14:cec293071eed | 29 | class EthernetInterface { |
donatien | 3:f5776537f27f | 30 | public: |
donatien | 4:9a52c802be61 | 31 | /** Initialize the interface with DHCP. |
donatien | 4:9a52c802be61 | 32 | * Initialize the interface and configure it to use DHCP (no connection at this point). |
donatien | 4:9a52c802be61 | 33 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 34 | */ |
emilmont | 14:cec293071eed | 35 | static int init(); //With DHCP |
donatien | 3:f5776537f27f | 36 | |
donatien | 4:9a52c802be61 | 37 | /** Initialize the interface with a static IP address. |
donatien | 4:9a52c802be61 | 38 | * Initialize the interface and configure it with the following static configuration (no connection at this point). |
donatien | 4:9a52c802be61 | 39 | * \param ip the IP address to use |
donatien | 4:9a52c802be61 | 40 | * \param mask the IP address mask |
donatien | 4:9a52c802be61 | 41 | * \param gateway the gateway to use |
donatien | 4:9a52c802be61 | 42 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 43 | */ |
emilmont | 14:cec293071eed | 44 | static int init(const char* ip, const char* mask, const char* gateway); |
donatien | 3:f5776537f27f | 45 | |
donatien | 4:9a52c802be61 | 46 | /** Connect |
donatien | 4:9a52c802be61 | 47 | * Bring the interface up, start DHCP if needed. |
emilmont | 21:8cd2de462559 | 48 | * \param timeout_ms timeout in ms (default: (3)s). |
donatien | 4:9a52c802be61 | 49 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 50 | */ |
emilmont | 21:8cd2de462559 | 51 | static int connect(unsigned int timeout_ms=3000); |
donatien | 4:9a52c802be61 | 52 | |
donatien | 4:9a52c802be61 | 53 | /** Disconnect |
donatien | 4:9a52c802be61 | 54 | * Bring the interface down |
donatien | 4:9a52c802be61 | 55 | * \return 0 on success, a negative number on failure |
donatien | 4:9a52c802be61 | 56 | */ |
emilmont | 14:cec293071eed | 57 | static int disconnect(); |
donatien | 3:f5776537f27f | 58 | |
emilmont | 14:cec293071eed | 59 | static char* getIPAddress(); |
donatien | 3:f5776537f27f | 60 | }; |
donatien | 3:f5776537f27f | 61 | |
emilmont | 15:fd9597f1b81b | 62 | #include "TCPSocketConnection.h" |
emilmont | 15:fd9597f1b81b | 63 | #include "TCPSocketServer.h" |
emilmont | 17:b7a3766f6253 | 64 | |
emilmont | 20:0d9ae7845bfe | 65 | #include "Endpoint.h" |
donatien | 3:f5776537f27f | 66 | #include "UDPSocket.h" |
donatien | 3:f5776537f27f | 67 | |
donatien | 3:f5776537f27f | 68 | #endif /* ETHERNETINTERFACE_H_ */ |