DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

NetworkInterface.h@21:35ed15069189, 2016-02-18 (annotated)

Committer:
Christopher Haster
Date:
Thu Feb 18 03:11:58 2016 -0600
Branch:
api-changes
Revision:
21:35ed15069189
Parent:
15:e657a90d9511
Child:
23:1e86d9fb3d86
Added UDPSocket and TCPSocket API and changes to core API

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
sam_grove 7:b147c08301be 20 #include "stdint.h"
bridadan 11:47c32687a44c 21 #include "SocketInterface.h"
Christopher Haster 21:35ed15069189 22
bridadan 11:47c32687a44c 23
Christopher Haster 21:35ed15069189 24 /** NetworkInterface class
Christopher Haster 21:35ed15069189 25 * Common interface that is shared between all hardware that
Christopher Haster 21:35ed15069189 26 * can connect to a network over IP.
bridadan 1:291a9d61e58a 27 */
sam_grove 3:167dd63981b6 28 class NetworkInterface
sam_grove 3:167dd63981b6 29 {
bridadan 1:291a9d61e58a 30 public:
Christopher Haster 21:35ed15069189 31 virtual ~NetworkInterface() = default;
sam_grove 3:167dd63981b6 32
sam_grove 3:167dd63981b6 33
Christopher Haster 21:35ed15069189 34 /** Enables DHCP and clears any static address
Christopher Haster 21:35ed15069189 35 * DHCP is enabled by default
Christopher Haster 21:35ed15069189 36 * @return 0 on success
Christopher Haster 21:35ed15069189 37 */
Christopher Haster 21:35ed15069189 38 virtual int32_t useDHCP() = 0;
Christopher Haster 21:35ed15069189 39
Christopher Haster 21:35ed15069189 40 /** Set the static IP address of the network interface
Christopher Haster 21:35ed15069189 41 * @param ip Static IP address, copied internally
bridadan 1:291a9d61e58a 42 */
Christopher Haster 21:35ed15069189 43 virtual void setIPAddress(const char *ip);
Christopher Haster 21:35ed15069189 44
Christopher Haster 21:35ed15069189 45 /** Set the static network mask of the network interface
Christopher Haster 21:35ed15069189 46 * @param mask Static network mask, copied internally
Christopher Haster 21:35ed15069189 47 */
Christopher Haster 21:35ed15069189 48 virtual void setNetworkMask(const char *mask);
Christopher Haster 21:35ed15069189 49
Christopher Haster 21:35ed15069189 50 /** Set the static gateway of the network interface
Christopher Haster 21:35ed15069189 51 * @param gateway Gateway address, copied internally
Christopher Haster 21:35ed15069189 52 */
Christopher Haster 21:35ed15069189 53 virtual void setGateway(const char *gateway);
Christopher Haster 21:35ed15069189 54
Christopher Haster 21:35ed15069189 55 /** Get the IP address
Christopher Haster 21:35ed15069189 56 * @return IP address of the interface
Christopher Haster 21:35ed15069189 57 */
Christopher Haster 21:35ed15069189 58 virtual const char *getIPAddress();
sam_grove 3:167dd63981b6 59
Christopher Haster 21:35ed15069189 60 /** Get the network mask
Christopher Haster 21:35ed15069189 61 * @return Network mask of the interface
sam_grove 3:167dd63981b6 62 */
Christopher Haster 21:35ed15069189 63 virtual const char *getNetworkMask();
Christopher Haster 21:35ed15069189 64
Christopher Haster 21:35ed15069189 65 /** Get the gateway
Christopher Haster 21:35ed15069189 66 * @return Gateway address of the interface
Christopher Haster 21:35ed15069189 67 */
Christopher Haster 21:35ed15069189 68 virtual const char *getGateway();
Christopher Haster 21:35ed15069189 69
Christopher Haster 21:35ed15069189 70 /** Get the current MAC address
Christopher Haster 21:35ed15069189 71 * @return String MAC address of the interface
Christopher Haster 21:35ed15069189 72 */
Christopher Haster 21:35ed15069189 73 virtual const char *getMACAddress() = 0;
sam_grove 3:167dd63981b6 74
Christopher Haster 21:35ed15069189 75 /** Get the current status of the interface
Christopher Haster 21:35ed15069189 76 @return true if connected
bridadan 1:291a9d61e58a 77 */
Christopher Haster 21:35ed15069189 78 virtual bool isConnected(void) = 0;
Christopher Haster 21:35ed15069189 79
Christopher Haster 21:35ed15069189 80
Christopher Haster 21:35ed15069189 81 private:
Christopher Haster 21:35ed15069189 82 friend class TCPSocket;
Christopher Haster 21:35ed15069189 83 friend class UDPSocket;
Christopher Haster 21:35ed15069189 84
Christopher Haster 21:35ed15069189 85 /** Internally create a socket
Christopher Haster 21:35ed15069189 86 * @param proto The type of socket to open, SOCK_TCP or SOCK_UDP
Christopher Haster 21:35ed15069189 87 * @return The allocated socket
Christopher Haster 21:35ed15069189 88 */
Christopher Haster 21:35ed15069189 89 virtual SocketInterface *createSocket(socket_protocol_t proto) = 0;
bridadan 11:47c32687a44c 90
Christopher Haster 21:35ed15069189 91 /** Internally destroy a socket
Christopher Haster 21:35ed15069189 92 * @param socket An allocated SocketInterface
Christopher Haster 21:35ed15069189 93 * @returns 0 on success
bridadan 11:47c32687a44c 94 */
Christopher Haster 21:35ed15069189 95 virtual void destroySocket(SocketInterface *socket) = 0;
Christopher Haster 21:35ed15069189 96
Christopher Haster 21:35ed15069189 97 private:
Christopher Haster 21:35ed15069189 98 const char *_ip_address;
Christopher Haster 21:35ed15069189 99 const char *_network_mask;
Christopher Haster 21:35ed15069189 100 const char *_gateway;
bridadan 1:291a9d61e58a 101 };
bridadan 1:291a9d61e58a 102
bridadan 1:291a9d61e58a 103 #endif