pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

NetworkInterface.h@57:3c873fab4207, 2016-02-25 (annotated)

Committer:
Christopher Haster
Date:
Thu Feb 25 19:00:39 2016 -0600
Revision:
57:3c873fab4207
Parent:
55:7ff3586d7af4
Child:
59:badee747a030
Standardized prefix to NS for enums and constants

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 53:26b5f1c69822 51 virtual ~NetworkInterface() {};
Christopher Haster 53:26b5f1c69822 52
Christopher Haster 52:52a6c4ea7128 53 /** Enables or disables DHCP
Christopher Haster 52:52a6c4ea7128 54 * @note DHCP resolution does not occur until connect
Christopher Haster 52:52a6c4ea7128 55 * @note DHCP is enabled by default
Christopher Haster 52:52a6c4ea7128 56 * @param enable Enables DHCP if true
Christopher Haster 21:35ed15069189 57 */
Christopher Haster 52:52a6c4ea7128 58 virtual void setDHCP(bool enable);
Christopher Haster 21:35ed15069189 59
Christopher Haster 21:35ed15069189 60 /** Set the static IP address of the network interface
Christopher Haster 21:35ed15069189 61 * @param ip Static IP address, copied internally
bridadan 1:291a9d61e58a 62 */
Christopher Haster 21:35ed15069189 63 virtual void setIPAddress(const char *ip);
Christopher Haster 21:35ed15069189 64
Christopher Haster 21:35ed15069189 65 /** Set the static network mask of the network interface
Christopher Haster 21:35ed15069189 66 * @param mask Static network mask, copied internally
Christopher Haster 21:35ed15069189 67 */
Christopher Haster 21:35ed15069189 68 virtual void setNetworkMask(const char *mask);
Christopher Haster 21:35ed15069189 69
Christopher Haster 21:35ed15069189 70 /** Set the static gateway of the network interface
Christopher Haster 21:35ed15069189 71 * @param gateway Gateway address, copied internally
Christopher Haster 21:35ed15069189 72 */
Christopher Haster 21:35ed15069189 73 virtual void setGateway(const char *gateway);
Christopher Haster 21:35ed15069189 74
Christopher Haster 52:52a6c4ea7128 75 /** Checks if DHCP is enabled
Christopher Haster 52:52a6c4ea7128 76 * @return True if DHCP is enabled
Christopher Haster 52:52a6c4ea7128 77 */
Christopher Haster 52:52a6c4ea7128 78 virtual bool getDHCP();
Christopher Haster 52:52a6c4ea7128 79
Christopher Haster 21:35ed15069189 80 /** Get the IP address
Christopher Haster 21:35ed15069189 81 * @return IP address of the interface
Christopher Haster 21:35ed15069189 82 */
Christopher Haster 21:35ed15069189 83 virtual const char *getIPAddress();
sam_grove 3:167dd63981b6 84
Christopher Haster 21:35ed15069189 85 /** Get the network mask
Christopher Haster 21:35ed15069189 86 * @return Network mask of the interface
sam_grove 3:167dd63981b6 87 */
Christopher Haster 21:35ed15069189 88 virtual const char *getNetworkMask();
Christopher Haster 21:35ed15069189 89
Christopher Haster 21:35ed15069189 90 /** Get the gateway
Christopher Haster 21:35ed15069189 91 * @return Gateway address of the interface
Christopher Haster 21:35ed15069189 92 */
Christopher Haster 21:35ed15069189 93 virtual const char *getGateway();
Christopher Haster 21:35ed15069189 94
Christopher Haster 21:35ed15069189 95 /** Get the current MAC address
Christopher Haster 21:35ed15069189 96 * @return String MAC address of the interface
Christopher Haster 21:35ed15069189 97 */
Christopher Haster 21:35ed15069189 98 virtual const char *getMACAddress() = 0;
sam_grove 3:167dd63981b6 99
Christopher Haster 21:35ed15069189 100 /** Get the current status of the interface
geky 31:7f15b95f2a1d 101 * @return true if connected
bridadan 1:291a9d61e58a 102 */
Christopher Haster 42:49893d13c432 103 virtual bool isConnected();
Christopher Haster 41:3ec1c97e9bbf 104
geky 31:7f15b95f2a1d 105 /** Looks up the specified host's IP address
geky 31:7f15b95f2a1d 106 * @param name URL of host
geky 31:7f15b95f2a1d 107 * @param ip Buffer to hold IP address, must be at least SOCK_IP_SIZE
geky 31:7f15b95f2a1d 108 * @return 0 on success
geky 31:7f15b95f2a1d 109 */
Christopher Haster 55:7ff3586d7af4 110 virtual int32_t getHostByName(const char *name, char *ip);
Christopher Haster 21:35ed15069189 111
Christopher Haster 26:9774a2edad71 112 protected:
Christopher Haster 26:9774a2edad71 113 NetworkInterface();
Christopher Haster 21:35ed15069189 114
Christopher Haster 25:ed7b2a52e8ac 115 friend class Socket;
Christopher Haster 21:35ed15069189 116
Christopher Haster 21:35ed15069189 117 /** Internally create a socket
Christopher Haster 57:3c873fab4207 118 * @param proto The type of socket to open, NS_TCP or NS_UDP
Christopher Haster 21:35ed15069189 119 * @return The allocated socket
Christopher Haster 21:35ed15069189 120 */
Christopher Haster 57:3c873fab4207 121 virtual SocketInterface *createSocket(ns_protocol_t proto) = 0;
geky 30:3cc78f5db99d 122
Christopher Haster 21:35ed15069189 123 /** Internally destroy a socket
Christopher Haster 21:35ed15069189 124 * @param socket An allocated SocketInterface
Christopher Haster 21:35ed15069189 125 * @returns 0 on success
bridadan 11:47c32687a44c 126 */
Christopher Haster 21:35ed15069189 127 virtual void destroySocket(SocketInterface *socket) = 0;
Christopher Haster 21:35ed15069189 128
Christopher Haster 21:35ed15069189 129 private:
Christopher Haster 52:52a6c4ea7128 130 bool _dhcp_enabled;
Christopher Haster 42:49893d13c432 131 char _ip_address[NS_IP_SIZE];
Christopher Haster 42:49893d13c432 132 char _network_mask[NS_IP_SIZE];
Christopher Haster 42:49893d13c432 133 char _gateway[NS_IP_SIZE];
bridadan 1:291a9d61e58a 134 };
bridadan 1:291a9d61e58a 135
bridadan 1:291a9d61e58a 136 #endif