NetworkSocketAPI
Dependents: HelloWizFi250Interface
Fork of NetworkSocketAPI by
Diff: Socket.h
- Branch:
- api-changes
- Revision:
- 25:ed7b2a52e8ac
- Child:
- 27:d7ed39727306
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Socket.h Thu Feb 18 06:01:55 2016 -0600 @@ -0,0 +1,88 @@ +/* Socket + * Copyright (c) 2015 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef SOCKET_H +#define SOCKET_H + +#include "NetworkInterface.h" + +/** Abstract socket class + * API for handling general sockets. Supports IP address operations + * and sending/recieving data. + */ +class Socket +{ +public: + /** Set the URL of the socket + * Performs DNS lookup if necessary + * @param url URL to connect to + */ + void setURL(const char *url); + + /** Set the IP address of the socket + * @param ip IP address to connect to, copied internally + */ + void setIPAddress(const char *ip); + + /** Set the port of the socket + * @param port Port to connect to + */ + void setPort(uint16_t port); + + /** Gets the IP address + * @return IP address to connect to + */ + const char *getIPAddress(); + + /** Gets the port + * @return Port to connect to + */ + uint16_t getPort(); + + + /** Send data over the socket + * @param data Buffer of data to send + * @param len Size of data to send + * @param timeout_ms Maximum amount of time to wait + * @return 0 on success + */ + int32_t send(const void *data, uint32_t len, uint32_t timeout_ms = 15000); + + /** Recieve data over the socket + * @param data Buffer to store recieved data + * @param len Size of provided buffer + * @param timeout_ms Maximum amount of time to wait + * @return Number of bytes sent or a negative value on failure + */ + int32_t recv(void *data, uint32_t len, uint32_t timeout_ms = 15000); + + +protected: + Socket( NetworkInterface *iface, + socket_protocol_t proto, + const char *url = 0, + uint16_t port = 0); + ~Socket(); + + SocketInterface *_get_socket(); + +private: + NetworkInterface *_iface; + socket_protocol_t _proto; + SocketInterface *_socket; +}; + +#endif