pefect / NetworkSocketAPI

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.

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

NetworkInterface.h@52:52a6c4ea7128, 2016-02-25 (annotated)

Committer:
Christopher Haster
Date:
Thu Feb 25 06:42:40 2016 -0600
Revision:
52:52a6c4ea7128
Parent:
46:ac37605ca91d
Child:
53:26b5f1c69822
Changed handling of DHCP to allow buffer reuse in implementations

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 0:d35446f60233 1 /* NetworkInterface Base Class
sam_grove 0:d35446f60233 2 * Copyright (c) 2015 ARM Limited
sam_grove 0:d35446f60233 3 *
sam_grove 0:d35446f60233 4 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 0:d35446f60233 5 * you may not use this file except in compliance with the License.
sam_grove 0:d35446f60233 6 * You may obtain a copy of the License at
sam_grove 0:d35446f60233 7 *
sam_grove 0:d35446f60233 8 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 0:d35446f60233 9 *
sam_grove 0:d35446f60233 10 * Unless required by applicable law or agreed to in writing, software
sam_grove 0:d35446f60233 11 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 0:d35446f60233 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 0:d35446f60233 13 * See the License for the specific language governing permissions and
sam_grove 0:d35446f60233 14 * limitations under the License.
sam_grove 0:d35446f60233 15 */
sam_grove 3:167dd63981b6 16
Christopher Haster 21:35ed15069189 17 #ifndef NETWORK_INTERFACE_H
Christopher Haster 21:35ed15069189 18 #define NETWORK_INTERFACE_H
bridadan 1:291a9d61e58a 19
Christopher Haster 42:49893d13c432 20 #include "SocketInterface.h"
sam_grove 7:b147c08301be 21 #include "stdint.h"
Christopher Haster 42:49893d13c432 22
Christopher Haster 21:35ed15069189 23
Christopher Haster 42:49893d13c432 24 /** Maximum storage needed for IP address and MAC addresses
Christopher Haster 42:49893d13c432 25 */
Christopher Haster 42:49893d13c432 26 #define NS_IP_SIZE 16
Christopher Haster 42:49893d13c432 27 #define NS_MAC_SIZE 18
Christopher Haster 28:163fbe3263f4 28
Christopher Haster 45:c8aca7c1e93f 29 /** Inexhaustive enum of standardized error codes
Christopher Haster 45:c8aca7c1e93f 30 */
Christopher Haster 45:c8aca7c1e93f 31 enum ns_error_t {
Christopher Haster 45:c8aca7c1e93f 32 NS_ERROR_TIMEOUT = -3001,
Christopher Haster 45:c8aca7c1e93f 33 NS_ERROR_NO_CONNECTION = -3002,
Christopher Haster 45:c8aca7c1e93f 34 NS_ERROR_NO_SOCKET = -3003,
Christopher Haster 45:c8aca7c1e93f 35 NS_ERROR_NO_ADDRESS = -3004,
Christopher Haster 45:c8aca7c1e93f 36 NS_ERROR_NO_MEMORY = -3005,
Christopher Haster 45:c8aca7c1e93f 37 NS_ERROR_DNS_FAILURE = -3006,
Christopher Haster 45:c8aca7c1e93f 38 NS_ERROR_DHCP_FAILURE = -3007,
Christopher Haster 46:ac37605ca91d 39 NS_ERROR_AUTH_FAILURE = -3008,
Christopher Haster 46:ac37605ca91d 40 NS_ERROR_DEVICE_ERROR = -3009
Christopher Haster 45:c8aca7c1e93f 41 };
Christopher Haster 45:c8aca7c1e93f 42
bridadan 11:47c32687a44c 43
Christopher Haster 21:35ed15069189 44 /** NetworkInterface class
Christopher Haster 21:35ed15069189 45 * Common interface that is shared between all hardware that
Christopher Haster 21:35ed15069189 46 * can connect to a network over IP.
bridadan 1:291a9d61e58a 47 */
sam_grove 3:167dd63981b6 48 class NetworkInterface
sam_grove 3:167dd63981b6 49 {
bridadan 1:291a9d61e58a 50 public:
Christopher Haster 52:52a6c4ea7128 51 /** Enables or disables DHCP
Christopher Haster 52:52a6c4ea7128 52 * @note DHCP resolution does not occur until connect
Christopher Haster 52:52a6c4ea7128 53 * @note DHCP is enabled by default
Christopher Haster 52:52a6c4ea7128 54 * @param enable Enables DHCP if true
Christopher Haster 21:35ed15069189 55 */
Christopher Haster 52:52a6c4ea7128 56 virtual void setDHCP(bool enable);
Christopher Haster 21:35ed15069189 57
Christopher Haster 21:35ed15069189 58 /** Set the static IP address of the network interface
Christopher Haster 21:35ed15069189 59 * @param ip Static IP address, copied internally
bridadan 1:291a9d61e58a 60 */
Christopher Haster 21:35ed15069189 61 virtual void setIPAddress(const char *ip);
Christopher Haster 21:35ed15069189 62
Christopher Haster 21:35ed15069189 63 /** Set the static network mask of the network interface
Christopher Haster 21:35ed15069189 64 * @param mask Static network mask, copied internally
Christopher Haster 21:35ed15069189 65 */
Christopher Haster 21:35ed15069189 66 virtual void setNetworkMask(const char *mask);
Christopher Haster 21:35ed15069189 67
Christopher Haster 21:35ed15069189 68 /** Set the static gateway of the network interface
Christopher Haster 21:35ed15069189 69 * @param gateway Gateway address, copied internally
Christopher Haster 21:35ed15069189 70 */
Christopher Haster 21:35ed15069189 71 virtual void setGateway(const char *gateway);
Christopher Haster 21:35ed15069189 72
Christopher Haster 52:52a6c4ea7128 73 /** Checks if DHCP is enabled
Christopher Haster 52:52a6c4ea7128 74 * @return True if DHCP is enabled
Christopher Haster 52:52a6c4ea7128 75 */
Christopher Haster 52:52a6c4ea7128 76 virtual bool getDHCP();
Christopher Haster 52:52a6c4ea7128 77
Christopher Haster 21:35ed15069189 78 /** Get the IP address
Christopher Haster 21:35ed15069189 79 * @return IP address of the interface
Christopher Haster 21:35ed15069189 80 */
Christopher Haster 21:35ed15069189 81 virtual const char *getIPAddress();
sam_grove 3:167dd63981b6 82
Christopher Haster 21:35ed15069189 83 /** Get the network mask
Christopher Haster 21:35ed15069189 84 * @return Network mask of the interface
sam_grove 3:167dd63981b6 85 */
Christopher Haster 21:35ed15069189 86 virtual const char *getNetworkMask();
Christopher Haster 21:35ed15069189 87
Christopher Haster 21:35ed15069189 88 /** Get the gateway
Christopher Haster 21:35ed15069189 89 * @return Gateway address of the interface
Christopher Haster 21:35ed15069189 90 */
Christopher Haster 21:35ed15069189 91 virtual const char *getGateway();
Christopher Haster 21:35ed15069189 92
Christopher Haster 21:35ed15069189 93 /** Get the current MAC address
Christopher Haster 21:35ed15069189 94 * @return String MAC address of the interface
Christopher Haster 21:35ed15069189 95 */
Christopher Haster 21:35ed15069189 96 virtual const char *getMACAddress() = 0;
sam_grove 3:167dd63981b6 97
Christopher Haster 21:35ed15069189 98 /** Get the current status of the interface
geky 31:7f15b95f2a1d 99 * @return true if connected
bridadan 1:291a9d61e58a 100 */
Christopher Haster 42:49893d13c432 101 virtual bool isConnected();
Christopher Haster 41:3ec1c97e9bbf 102
geky 31:7f15b95f2a1d 103 /** Looks up the specified host's IP address
geky 31:7f15b95f2a1d 104 * @param name URL of host
geky 31:7f15b95f2a1d 105 * @param ip Buffer to hold IP address, must be at least SOCK_IP_SIZE
geky 31:7f15b95f2a1d 106 * @return 0 on success
geky 31:7f15b95f2a1d 107 */
geky 31:7f15b95f2a1d 108 int32_t getHostByName(const char *name, char *ip);
Christopher Haster 21:35ed15069189 109
Christopher Haster 26:9774a2edad71 110 protected:
Christopher Haster 26:9774a2edad71 111 NetworkInterface();
Christopher Haster 21:35ed15069189 112
Christopher Haster 25:ed7b2a52e8ac 113 friend class Socket;
Christopher Haster 21:35ed15069189 114
Christopher Haster 21:35ed15069189 115 /** Internally create a socket
Christopher Haster 21:35ed15069189 116 * @param proto The type of socket to open, SOCK_TCP or SOCK_UDP
Christopher Haster 21:35ed15069189 117 * @return The allocated socket
Christopher Haster 21:35ed15069189 118 */
Christopher Haster 21:35ed15069189 119 virtual SocketInterface *createSocket(socket_protocol_t proto) = 0;
geky 30:3cc78f5db99d 120
Christopher Haster 21:35ed15069189 121 /** Internally destroy a socket
Christopher Haster 21:35ed15069189 122 * @param socket An allocated SocketInterface
Christopher Haster 21:35ed15069189 123 * @returns 0 on success
bridadan 11:47c32687a44c 124 */
Christopher Haster 21:35ed15069189 125 virtual void destroySocket(SocketInterface *socket) = 0;
Christopher Haster 21:35ed15069189 126
Christopher Haster 21:35ed15069189 127 private:
Christopher Haster 52:52a6c4ea7128 128 bool _dhcp_enabled;
Christopher Haster 42:49893d13c432 129 char _ip_address[NS_IP_SIZE];
Christopher Haster 42:49893d13c432 130 char _network_mask[NS_IP_SIZE];
Christopher Haster 42:49893d13c432 131 char _gateway[NS_IP_SIZE];
bridadan 1:291a9d61e58a 132 };
bridadan 1:291a9d61e58a 133
bridadan 1:291a9d61e58a 134 #endif