Samuel Mokrani / WiflyInterface

wifly/socket interface for wifly modules

Dependents:   WiFi neurGAI_WIFI thingspeak thingspeak2

Socket/TCPSocketConnection.h@0:6ffb0aeb3972, 2012-08-17 (annotated)

Committer:
samux
Date:
Fri Aug 17 08:28:04 2012 +0000
Revision:
0:6ffb0aeb3972
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 0:6ffb0aeb3972 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 0:6ffb0aeb3972 2 *
samux 0:6ffb0aeb3972 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 0:6ffb0aeb3972 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 0:6ffb0aeb3972 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 0:6ffb0aeb3972 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 0:6ffb0aeb3972 7 * furnished to do so, subject to the following conditions:
samux 0:6ffb0aeb3972 8 *
samux 0:6ffb0aeb3972 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 0:6ffb0aeb3972 10 * substantial portions of the Software.
samux 0:6ffb0aeb3972 11 *
samux 0:6ffb0aeb3972 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 0:6ffb0aeb3972 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 0:6ffb0aeb3972 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 0:6ffb0aeb3972 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 0:6ffb0aeb3972 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 0:6ffb0aeb3972 17 */
samux 0:6ffb0aeb3972 18
samux 0:6ffb0aeb3972 19 #ifndef TCPSOCKET_H
samux 0:6ffb0aeb3972 20 #define TCPSOCKET_H
samux 0:6ffb0aeb3972 21
samux 0:6ffb0aeb3972 22 #include "Socket.h"
samux 0:6ffb0aeb3972 23 #include "Endpoint.h"
samux 0:6ffb0aeb3972 24
samux 0:6ffb0aeb3972 25 /**
samux 0:6ffb0aeb3972 26 TCP socket connection
samux 0:6ffb0aeb3972 27 */
samux 0:6ffb0aeb3972 28 class TCPSocketConnection: public Socket, public Endpoint {
samux 0:6ffb0aeb3972 29
samux 0:6ffb0aeb3972 30 public:
samux 0:6ffb0aeb3972 31 /** TCP socket connection
samux 0:6ffb0aeb3972 32 */
samux 0:6ffb0aeb3972 33 TCPSocketConnection();
samux 0:6ffb0aeb3972 34
samux 0:6ffb0aeb3972 35 /** Connects this TCP socket to the server
samux 0:6ffb0aeb3972 36 \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
samux 0:6ffb0aeb3972 37 \param port The host's port to connect to.
samux 0:6ffb0aeb3972 38 \return 0 on success, -1 on failure.
samux 0:6ffb0aeb3972 39 */
samux 0:6ffb0aeb3972 40 int connect(const char* host, const int port);
samux 0:6ffb0aeb3972 41
samux 0:6ffb0aeb3972 42 /** Check if the socket is connected
samux 0:6ffb0aeb3972 43 \return true if connected, false otherwise.
samux 0:6ffb0aeb3972 44 */
samux 0:6ffb0aeb3972 45 bool is_connected(void);
samux 0:6ffb0aeb3972 46
samux 0:6ffb0aeb3972 47 /** Send data to the remote host.
samux 0:6ffb0aeb3972 48 \param data The buffer to send to the host.
samux 0:6ffb0aeb3972 49 \param length The length of the buffer to send.
samux 0:6ffb0aeb3972 50 \return the number of written bytes on success (>=0) or -1 on failure
samux 0:6ffb0aeb3972 51 */
samux 0:6ffb0aeb3972 52 int send(char* data, int length);
samux 0:6ffb0aeb3972 53
samux 0:6ffb0aeb3972 54 /** Send all the data to the remote host.
samux 0:6ffb0aeb3972 55 \param data The buffer to send to the host.
samux 0:6ffb0aeb3972 56 \param length The length of the buffer to send.
samux 0:6ffb0aeb3972 57 \return the number of written bytes on success (>=0) or -1 on failure
samux 0:6ffb0aeb3972 58 */
samux 0:6ffb0aeb3972 59 int send_all(char* data, int length);
samux 0:6ffb0aeb3972 60
samux 0:6ffb0aeb3972 61 /** Receive data from the remote host.
samux 0:6ffb0aeb3972 62 \param data The buffer in which to store the data received from the host.
samux 0:6ffb0aeb3972 63 \param length The maximum length of the buffer.
samux 0:6ffb0aeb3972 64 \return the number of received bytes on success (>=0) or -1 on failure
samux 0:6ffb0aeb3972 65 */
samux 0:6ffb0aeb3972 66 int receive(char* data, int length);
samux 0:6ffb0aeb3972 67
samux 0:6ffb0aeb3972 68 /** Receive all the data from the remote host.
samux 0:6ffb0aeb3972 69 \param data The buffer in which to store the data received from the host.
samux 0:6ffb0aeb3972 70 \param length The maximum length of the buffer.
samux 0:6ffb0aeb3972 71 \return the number of received bytes on success (>=0) or -1 on failure
samux 0:6ffb0aeb3972 72 */
samux 0:6ffb0aeb3972 73 int receive_all(char* data, int length);
samux 0:6ffb0aeb3972 74 };
samux 0:6ffb0aeb3972 75
samux 0:6ffb0aeb3972 76 #endif