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.h"
00023 #include "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 0 on success, -1 on failure.
00040     */
00041     int connect(const char* host, const int port);
00042     
00043     /** Check if the socket is connected
00044     \return true if connected, false otherwise.
00045     */
00046     bool is_connected(void);
00047     
00048     /** Check if FIN signal received.
00049     \return true if received, false otherwise.
00050     */
00051     bool is_fin_received(void);
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) or -1 on failure
00056      */
00057     int send(char* data, int length);
00058     
00059     /** Send all the data to the remote host.
00060     \param data The buffer to send to the host.
00061     \param length The length of the buffer to send.
00062     \return the number of written bytes on success (>=0) or -1 on failure
00063     */
00064     int send_all(char* data, int length);
00065     
00066     /** Receive data from the remote host.
00067     \param data The buffer in which to store the data received from the host.
00068     \param length The maximum length of the buffer.
00069     \return the number of received bytes on success (>=0) or -1 on failure
00070      */
00071     int receive(char* data, int length);
00072     
00073     /** Receive all the data from the remote host.
00074     \param data The buffer in which to store the data received from the host.
00075     \param length The maximum length of the buffer.
00076     \return the number of received bytes on success (>=0) or -1 on failure
00077     */
00078     int receive_all(char* data, int length);
00079 
00080 private:
00081     bool _is_connected;    
00082 };
00083 
00084 #endif
00085