Albin Sebastian / WIZnetInterface

Library for ethernet

Dependents:   VC0706_FTP_Client_Ethernet_MQTT

Fork of WIZnetInterface by Akshay Tom

EthernetInterface.h@0:6f28332c466f, 2015-06-15 (annotated)

Committer:
Soohwan Kim
Date:
Mon Jun 15 11:18:37 2015 +0900
Revision:
0:6f28332c466f
Child:
3:f8c6efc8bf83
initial version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Soohwan Kim 0:6f28332c466f 1 /* Copyright (C) 2012 mbed.org, MIT License
Soohwan Kim 0:6f28332c466f 2 *
Soohwan Kim 0:6f28332c466f 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Soohwan Kim 0:6f28332c466f 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Soohwan Kim 0:6f28332c466f 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Soohwan Kim 0:6f28332c466f 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Soohwan Kim 0:6f28332c466f 7 * furnished to do so, subject to the following conditions:
Soohwan Kim 0:6f28332c466f 8 *
Soohwan Kim 0:6f28332c466f 9 * The above copyright notice and this permission notice shall be included in all copies or
Soohwan Kim 0:6f28332c466f 10 * substantial portions of the Software.
Soohwan Kim 0:6f28332c466f 11 *
Soohwan Kim 0:6f28332c466f 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Soohwan Kim 0:6f28332c466f 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Soohwan Kim 0:6f28332c466f 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Soohwan Kim 0:6f28332c466f 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Soohwan Kim 0:6f28332c466f 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Soohwan Kim 0:6f28332c466f 17 */
Soohwan Kim 0:6f28332c466f 18
Soohwan Kim 0:6f28332c466f 19 #pragma once
Soohwan Kim 0:6f28332c466f 20 #include "eth_arch.h"
Soohwan Kim 0:6f28332c466f 21 /** Interface using Wiznet chip to connect to an IP-based network
Soohwan Kim 0:6f28332c466f 22 *
Soohwan Kim 0:6f28332c466f 23 */
Soohwan Kim 0:6f28332c466f 24 class EthernetInterface: public WIZnet_Chip {
Soohwan Kim 0:6f28332c466f 25 public:
Soohwan Kim 0:6f28332c466f 26
Soohwan Kim 0:6f28332c466f 27
Soohwan Kim 0:6f28332c466f 28 /** Initialize the interface with DHCP.
Soohwan Kim 0:6f28332c466f 29 * Initialize the interface and configure it to use DHCP (no connection at this point).
Soohwan Kim 0:6f28332c466f 30 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 31 */
Soohwan Kim 0:6f28332c466f 32 int init(uint8_t * mac); //With DHCP
Soohwan Kim 0:6f28332c466f 33
Soohwan Kim 0:6f28332c466f 34 /** Initialize the interface with a static IP address.
Soohwan Kim 0:6f28332c466f 35 * Initialize the interface and configure it with the following static configuration (no connection at this point).
Soohwan Kim 0:6f28332c466f 36 * \param ip the IP address to use
Soohwan Kim 0:6f28332c466f 37 * \param mask the IP address mask
Soohwan Kim 0:6f28332c466f 38 * \param gateway the gateway to use
Soohwan Kim 0:6f28332c466f 39 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 40 */
Soohwan Kim 0:6f28332c466f 41 int init(uint8_t * mac, const char* ip, const char* mask, const char* gateway);
Soohwan Kim 0:6f28332c466f 42
Soohwan Kim 0:6f28332c466f 43 /** Connect
Soohwan Kim 0:6f28332c466f 44 * Bring the interface up, start DHCP if needed.
Soohwan Kim 0:6f28332c466f 45 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 46 */
Soohwan Kim 0:6f28332c466f 47 int connect();
Soohwan Kim 0:6f28332c466f 48
Soohwan Kim 0:6f28332c466f 49 /** Disconnect
Soohwan Kim 0:6f28332c466f 50 * Bring the interface down
Soohwan Kim 0:6f28332c466f 51 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 52 */
Soohwan Kim 0:6f28332c466f 53 int disconnect();
Soohwan Kim 0:6f28332c466f 54
Soohwan Kim 0:6f28332c466f 55 /** Get IP address & MAC address
Soohwan Kim 0:6f28332c466f 56 *
Soohwan Kim 0:6f28332c466f 57 * @ returns ip address
Soohwan Kim 0:6f28332c466f 58 */
Soohwan Kim 0:6f28332c466f 59 char* getIPAddress();
Soohwan Kim 0:6f28332c466f 60 char* getNetworkMask();
Soohwan Kim 0:6f28332c466f 61 char* getGateway();
Soohwan Kim 0:6f28332c466f 62 char* getMACAddress();
Soohwan Kim 0:6f28332c466f 63
Soohwan Kim 0:6f28332c466f 64 int IPrenew(int timeout_ms = 15*1000);
Soohwan Kim 0:6f28332c466f 65
Soohwan Kim 0:6f28332c466f 66 private:
Soohwan Kim 0:6f28332c466f 67 char ip_string[20];
Soohwan Kim 0:6f28332c466f 68 char mask_string[20];
Soohwan Kim 0:6f28332c466f 69 char gw_string[20];
Soohwan Kim 0:6f28332c466f 70 char mac_string[20];
Soohwan Kim 0:6f28332c466f 71 bool ip_set;
Soohwan Kim 0:6f28332c466f 72 };
Soohwan Kim 0:6f28332c466f 73
Soohwan Kim 0:6f28332c466f 74 #include "TCPSocketConnection.h"
Soohwan Kim 0:6f28332c466f 75 #include "TCPSocketServer.h"
Soohwan Kim 0:6f28332c466f 76 #include "UDPSocket.h"