Jack Berkhout / cc3000_hostdriver_mbedsocket

None

Fork of cc3000_hostdriver_mbedsocket by Martin Kojtal

Socket/TCPSocketConnection.h@0:615c697c33b0, 2013-09-19 (annotated)

Committer:
Kojto
Date:
Thu Sep 19 07:55:14 2013 +0000
Revision:
0:615c697c33b0
Child:
5:245ac5b73132
initial commit

Who changed what in which revision?

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