pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

Socket.h@42:49893d13c432, 2016-02-23 (annotated)

Committer:
Christopher Haster
Date:
Tue Feb 23 05:07:02 2016 -0600
Branch:
api-changes
Revision:
42:49893d13c432
Parent:
41:3ec1c97e9bbf
Child:
43:09ea32f2eb54
Standardized some C++ style things

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 25:ed7b2a52e8ac 1 /* Socket
Christopher Haster 25:ed7b2a52e8ac 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 25:ed7b2a52e8ac 3 *
Christopher Haster 25:ed7b2a52e8ac 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 25:ed7b2a52e8ac 5 * you may not use this file except in compliance with the License.
Christopher Haster 25:ed7b2a52e8ac 6 * You may obtain a copy of the License at
Christopher Haster 25:ed7b2a52e8ac 7 *
Christopher Haster 25:ed7b2a52e8ac 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 25:ed7b2a52e8ac 9 *
Christopher Haster 25:ed7b2a52e8ac 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 25:ed7b2a52e8ac 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 25:ed7b2a52e8ac 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 25:ed7b2a52e8ac 13 * See the License for the specific language governing permissions and
Christopher Haster 25:ed7b2a52e8ac 14 * limitations under the License.
Christopher Haster 25:ed7b2a52e8ac 15 */
Christopher Haster 25:ed7b2a52e8ac 16
Christopher Haster 25:ed7b2a52e8ac 17 #ifndef SOCKET_H
Christopher Haster 25:ed7b2a52e8ac 18 #define SOCKET_H
Christopher Haster 25:ed7b2a52e8ac 19
Christopher Haster 25:ed7b2a52e8ac 20 #include "NetworkInterface.h"
Christopher Haster 25:ed7b2a52e8ac 21
Christopher Haster 25:ed7b2a52e8ac 22 /** Abstract socket class
Christopher Haster 25:ed7b2a52e8ac 23 * API for handling general sockets. Supports IP address operations
Christopher Haster 25:ed7b2a52e8ac 24 * and sending/recieving data.
Christopher Haster 25:ed7b2a52e8ac 25 */
Christopher Haster 25:ed7b2a52e8ac 26 class Socket
Christopher Haster 25:ed7b2a52e8ac 27 {
Christopher Haster 25:ed7b2a52e8ac 28 public:
Christopher Haster 25:ed7b2a52e8ac 29 /** Set the URL of the socket
Christopher Haster 25:ed7b2a52e8ac 30 * Performs DNS lookup if necessary
Christopher Haster 25:ed7b2a52e8ac 31 * @param url URL to connect to
Christopher Haster 27:d7ed39727306 32 * @return 0 on success
Christopher Haster 25:ed7b2a52e8ac 33 */
Christopher Haster 34:c17745683385 34 int32_t setURL(const char *url);
Christopher Haster 25:ed7b2a52e8ac 35
Christopher Haster 25:ed7b2a52e8ac 36 /** Set the IP address of the socket
Christopher Haster 25:ed7b2a52e8ac 37 * @param ip IP address to connect to, copied internally
Christopher Haster 25:ed7b2a52e8ac 38 */
Christopher Haster 34:c17745683385 39 void setIPAddress(const char *ip);
Christopher Haster 25:ed7b2a52e8ac 40
Christopher Haster 25:ed7b2a52e8ac 41 /** Set the port of the socket
Christopher Haster 25:ed7b2a52e8ac 42 * @param port Port to connect to
Christopher Haster 25:ed7b2a52e8ac 43 */
Christopher Haster 25:ed7b2a52e8ac 44 void setPort(uint16_t port);
Christopher Haster 25:ed7b2a52e8ac 45
Christopher Haster 25:ed7b2a52e8ac 46 /** Gets the IP address
Christopher Haster 25:ed7b2a52e8ac 47 * @return IP address to connect to
Christopher Haster 25:ed7b2a52e8ac 48 */
Christopher Haster 28:163fbe3263f4 49 const char *getIPAddress() const;
Christopher Haster 25:ed7b2a52e8ac 50
Christopher Haster 25:ed7b2a52e8ac 51 /** Gets the port
Christopher Haster 25:ed7b2a52e8ac 52 * @return Port to connect to
Christopher Haster 25:ed7b2a52e8ac 53 */
Christopher Haster 28:163fbe3263f4 54 uint16_t getPort() const;
Christopher Haster 25:ed7b2a52e8ac 55
Christopher Haster 41:3ec1c97e9bbf 56 /** Set a timeout on network operations
Christopher Haster 41:3ec1c97e9bbf 57 * @param timeout Maximum time in milliseconds for socket operations
Christopher Haster 41:3ec1c97e9bbf 58 */
Christopher Haster 41:3ec1c97e9bbf 59 void setTimeout(uint32_t timeout);
Christopher Haster 41:3ec1c97e9bbf 60
Christopher Haster 41:3ec1c97e9bbf 61 /** Get the current timeout on network operations
Christopher Haster 41:3ec1c97e9bbf 62 * @return Maximum time in milliseconds for socket operations
Christopher Haster 41:3ec1c97e9bbf 63 */
Christopher Haster 41:3ec1c97e9bbf 64 uint32_t getTimeout() const;
Christopher Haster 41:3ec1c97e9bbf 65
Christopher Haster 38:157fb2ab965f 66 /** Returns status of socket
Christopher Haster 38:157fb2ab965f 67 * @return true if connected
Christopher Haster 38:157fb2ab965f 68 */
Christopher Haster 38:157fb2ab965f 69 bool isConnected();
Christopher Haster 38:157fb2ab965f 70
Christopher Haster 25:ed7b2a52e8ac 71
Christopher Haster 32:2c5fc105fc50 72 /** Open a connection to the underlying address
Christopher Haster 34:c17745683385 73 * @param url Optional URL or IP address to connect to
Christopher Haster 34:c17745683385 74 * @param port Optional port to connect to
Christopher Haster 32:2c5fc105fc50 75 * @return 0 on success
Christopher Haster 32:2c5fc105fc50 76 */
Christopher Haster 34:c17745683385 77 int32_t open(const char *url = 0, uint16_t port = 0);
Christopher Haster 32:2c5fc105fc50 78
Christopher Haster 32:2c5fc105fc50 79 /** Close an open connection
Christopher Haster 32:2c5fc105fc50 80 * @return 0 on success
Christopher Haster 32:2c5fc105fc50 81 */
Christopher Haster 32:2c5fc105fc50 82 int32_t close();
Christopher Haster 32:2c5fc105fc50 83
Christopher Haster 25:ed7b2a52e8ac 84 /** Send data over the socket
Christopher Haster 25:ed7b2a52e8ac 85 * @param data Buffer of data to send
Christopher Haster 25:ed7b2a52e8ac 86 * @param len Size of data to send
Christopher Haster 25:ed7b2a52e8ac 87 * @return 0 on success
Christopher Haster 25:ed7b2a52e8ac 88 */
Christopher Haster 41:3ec1c97e9bbf 89 int32_t send(const void *data, uint32_t len);
Christopher Haster 25:ed7b2a52e8ac 90
Christopher Haster 25:ed7b2a52e8ac 91 /** Recieve data over the socket
Christopher Haster 25:ed7b2a52e8ac 92 * @param data Buffer to store recieved data
Christopher Haster 25:ed7b2a52e8ac 93 * @param len Size of provided buffer
Christopher Haster 25:ed7b2a52e8ac 94 * @return Number of bytes sent or a negative value on failure
Christopher Haster 25:ed7b2a52e8ac 95 */
Christopher Haster 41:3ec1c97e9bbf 96 int32_t recv(void *data, uint32_t len);
Christopher Haster 25:ed7b2a52e8ac 97
Christopher Haster 25:ed7b2a52e8ac 98
Christopher Haster 25:ed7b2a52e8ac 99 protected:
Christopher Haster 28:163fbe3263f4 100 Socket(NetworkInterface *iface, socket_protocol_t proto);
Christopher Haster 25:ed7b2a52e8ac 101 ~Socket();
Christopher Haster 25:ed7b2a52e8ac 102
Christopher Haster 25:ed7b2a52e8ac 103 private:
Christopher Haster 25:ed7b2a52e8ac 104 NetworkInterface *_iface;
Christopher Haster 25:ed7b2a52e8ac 105 socket_protocol_t _proto;
Christopher Haster 25:ed7b2a52e8ac 106 SocketInterface *_socket;
Christopher Haster 27:d7ed39727306 107
Christopher Haster 42:49893d13c432 108 char _ip_address[NS_IP_SIZE];
Christopher Haster 28:163fbe3263f4 109 uint16_t _port;
Christopher Haster 41:3ec1c97e9bbf 110 uint32_t _timeout;
Christopher Haster 25:ed7b2a52e8ac 111 };
Christopher Haster 25:ed7b2a52e8ac 112
Christopher Haster 25:ed7b2a52e8ac 113 #endif