File content as of revision 13:084c7fa00503:

/* Copyright (C) 2012 mbed.org, MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef TCPSOCKET_H
#define TCPSOCKET_H

#include "Socket/Socket.h"
#include "Socket/Endpoint.h"

/**
TCP socket connection
*/
class TCPSocketConnection : public Socket, public Endpoint {
    friend class TCPSocketServer;
    
public:
    /** TCP socket connection
    */
    TCPSocketConnection();
    
    /** Connects this TCP socket to the server
    \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
    \param port The host's port to connect to.
    \return 0 on success, -1 on failure.
    */
    int connect(const char* host, const int port);
    
    /** Check if the socket is connected
    \return true if connected, false otherwise.
    */
    bool is_connected(void);
    
    /* \brief Send data to the remote host. Applications are responsible for 
     *        checking that all data has been sent; if only some of the data was
     *        transmitted, the application needs to attempt delivery of the
     *        remaining data.
     * \param data The buffer to send to the host.
     * \param length The length of the buffer to send.
     * \return the number of written bytes on success (>=0) or -1 on failure
     */
    int send(char* data, int length);
    
    /* \brief Send all the data to the remote host. This method continues to send
     *        data until either all data has been sent, or an error occurs, or a
     *        timeout occurs.
     * \param data The buffer to send to the host.
     * \param length The length of the buffer to send.
     * \return the number of written bytes on success (>=0) or -1 on failure
     */
    int send_all(char* data, int length);
    
    /* \brief Receive data from the remote host. Return as soon as some data is available.
     * \param data The buffer in which to store the data received from the host.
     * \param length The maximum length of the buffer.
     * \return the number of received bytes on success (>=0) or -1 on failure
     */
    int receive(char* data, int length);
    
    /* \brief Receive all the data from the remote host. This method continues to receive
     *        data until either length bytes has been received, or an error occurs, or a
     *        timeout occurs.
     * \param data The buffer in which to store the data received from the host.
     * \param length The maximum length of the buffer.
     * \return the number of received bytes on success (>=0) or -1 on failure
     */
    int receive_all(char* data, int length);

private:
    bool _is_connected;

};

#endif