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 
00019 #ifndef TCPSOCKET_H
00020 #define TCPSOCKET_H
00021 
00022 #include "Socket/Socket.h"
00023 #include "Socket/Endpoint.h"
00024 
00025 /**
00026 TCP socket connection
00027 */
00028 class TCPSocketConnection : public Socket, public Endpoint {
00029     friend class TCPSocketServer;
00030     
00031 public:
00032     /** TCP socket connection
00033     */
00034     TCPSocketConnection();
00035     
00036     /** Connects this TCP socket to the server
00037     \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
00038     \param port The host's port to connect to.
00039     \return 
00040         * 0 on success, 
00041         * -1 on failure to init.
00042         * -2 on failure to set the address
00043         * -3 on failure to connect
00044     */
00045     int connect(const char* host, const int port);
00046     
00047     /** Check if the socket is connected
00048     \return true if connected, false otherwise.
00049     */
00050     bool is_connected(void);
00051     
00052     /** Send data to the remote host.
00053     \param data The buffer to send to the host.
00054     \param length The length of the buffer to send.
00055     \return the number of written bytes on success (>=0) 
00056         * -1 if not connected
00057         * -2 on timeout
00058      */
00059     int send(const char* data, int length);
00060     
00061     /** Send all the data to the remote host.
00062     \param data The buffer to send to the host.
00063     \param length The length of the buffer to send.
00064     \return the number of written bytes on success (>=0) or 
00065         * -1 if not connected
00066         * -2 on send failure - connection error
00067     */
00068     int send_all(const char* data, int length);
00069     
00070     /** Receive data from the remote host.
00071     \param data The buffer in which to store the data received from the host.
00072     \param length The maximum length of the buffer.
00073     \return the number of received bytes on success (>=0) or 
00074         * -1 if not connected
00075         * -2 on timeout
00076      */
00077     int receive(char* data, int length);
00078     
00079     /** Receive all the data from the remote host.
00080     \param data The buffer in which to store the data received from the host.
00081     \param length The maximum length of the buffer.
00082     \return the number of received bytes on success (>=0) or  
00083         * -1 if not connected
00084         * -2 on send failure - connection error
00085     */
00086     int receive_all(char* data, int length);
00087 
00088 private:
00089     bool _is_connected;
00090 
00091 };
00092 
00093 #endif