TCPSocketConnection.h

00001 /* Copyright (C) 2012 mbed.org, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 /* Copyright (C) 2013 gsfan, MIT License
00019  *  port to the GainSpan Wi-FI module GS1011
00020  */
00021 
00022 #ifndef TCPSOCKET_H
00023 #define TCPSOCKET_H
00024 
00025 #include "Socket.h"
00026 #include "Endpoint.h"
00027 
00028 /**
00029 TCP socket connection
00030 */
00031 class TCPSocketConnection: public Socket, public Endpoint {
00032     
00033 public:
00034     /** TCP socket connection
00035     */
00036     TCPSocketConnection();
00037     
00038     /** Connects this TCP socket to the server
00039     \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
00040     \param port The host's port to connect to.
00041     \return 0 on success, -1 on failure.
00042     */
00043     int connect(const char* host, const int port);
00044     
00045     /** Check if the socket is connected
00046     \return true if connected, false otherwise.
00047     */
00048     bool is_connected(void);
00049     
00050     /** Send data to the remote host.
00051     \param data The buffer to send to the host.
00052     \param length The length of the buffer to send.
00053     \return the number of written bytes on success (>=0) or -1 on failure
00054      */
00055     int send(char* data, int length);
00056     
00057     /** Send all the data to the remote host.
00058     \param data The buffer to send to the host.
00059     \param length The length of the buffer to send.
00060     \return the number of written bytes on success (>=0) or -1 on failure
00061     */
00062     int send_all(char* data, int length);
00063     
00064     /** Receive data from the remote host.
00065     \param data The buffer in which to store the data received from the host.
00066     \param length The maximum length of the buffer.
00067     \return the number of received bytes on success (>=0) or -1 on failure
00068      */
00069     int receive(char* data, int length);
00070     
00071     /** Receive all the data from the remote host.
00072     \param data The buffer in which to store the data received from the host.
00073     \param length The maximum length of the buffer.
00074     \return the number of received bytes on success (>=0) or -1 on failure
00075     */
00076     int receive_all(char* data, int length);
00077 
00078     void acceptCID (int cid);
00079 };
00080 
00081 #endif