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 #define TCP_BUFFER_SIZE   SOCKET_BUFFER_MAX_LENGTH//Tsungta, set 0 if no buffer is required
00026 
00027 /**
00028 TCP socket connection
00029 */
00030 class TCPSocketConnection : public Socket, public Endpoint {
00031     friend class TCPSocketServer;
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     \param sslSocket set true when SSL/TLS connection is used.
00042     \return 0 on success, -1 on failure.
00043     */
00044     int connect(const char* host, const int port, bool sslSocket = false);
00045     
00046     /** Check if the socket is connected
00047     \return true if connected, false otherwise.
00048     */
00049     bool is_connected(void);
00050     
00051     /** Send data to the remote host.
00052     \param data The buffer to send to the host.
00053     \param length The length of the buffer to send.
00054     \return the number of written bytes on success (>=0) or -1 on failure
00055      */
00056     int send(char* data, int length);
00057     
00058     /** Send all the data to the remote host.
00059     \param data The buffer to send to the host.
00060     \param length The length of the buffer to send.
00061     \return the number of written bytes on success (>=0) or -1 on failure
00062     */
00063     int send_all(char* data, int length);
00064     
00065     /** Receive data from the remote host.
00066     \param data The buffer in which to store the data received from the host.
00067     \param length The maximum length of the buffer.
00068     \return the number of received bytes on success (>=0) or -1 on failure
00069      */
00070     int receive(char* data, int length);
00071     
00072     /** Receive all the data from the remote host.
00073     \param data The buffer in which to store the data received from the host.
00074     \param length The maximum length of the buffer.
00075     \return the number of received bytes on success (>=0) or -1 on failure
00076     */
00077     int receive_all(char* data, int length);
00078 
00079 private:
00080     bool _is_connected;
00081 
00082 };
00083 
00084 #endif
00085