DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

NetworkInterface.h@46:ac37605ca91d, 2016-02-24 (annotated)

Committer:
Christopher Haster
Date:
Wed Feb 24 23:12:35 2016 -0600
Branch:
api-changes
Revision:
46:ac37605ca91d
Parent:
45:c8aca7c1e93f
Child:
52:52a6c4ea7128
Added more error codes

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