Hill Kim / W5200Interface

MQTT client test with W5200 ethernet shield

Dependents:   IBMIoTClientEthernetExample_W5200

Fork of W5500Interface by W5500-Ethernet-Interface Makers

Socket/TCPSocketConnection.h@0:e11e8793c3ce, 2014-08-20 (annotated)

Committer:
Bongjun
Date:
Wed Aug 20 00:28:37 2014 +0000
Revision:
0:e11e8793c3ce
first release.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Bongjun 0:e11e8793c3ce 1 /* Copyright (C) 2012 mbed.org, MIT License
Bongjun 0:e11e8793c3ce 2 *
Bongjun 0:e11e8793c3ce 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Bongjun 0:e11e8793c3ce 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Bongjun 0:e11e8793c3ce 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Bongjun 0:e11e8793c3ce 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Bongjun 0:e11e8793c3ce 7 * furnished to do so, subject to the following conditions:
Bongjun 0:e11e8793c3ce 8 *
Bongjun 0:e11e8793c3ce 9 * The above copyright notice and this permission notice shall be included in all copies or
Bongjun 0:e11e8793c3ce 10 * substantial portions of the Software.
Bongjun 0:e11e8793c3ce 11 *
Bongjun 0:e11e8793c3ce 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Bongjun 0:e11e8793c3ce 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Bongjun 0:e11e8793c3ce 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Bongjun 0:e11e8793c3ce 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Bongjun 0:e11e8793c3ce 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Bongjun 0:e11e8793c3ce 17 */
Bongjun 0:e11e8793c3ce 18
Bongjun 0:e11e8793c3ce 19 #ifndef TCPSOCKET_H
Bongjun 0:e11e8793c3ce 20 #define TCPSOCKET_H
Bongjun 0:e11e8793c3ce 21
Bongjun 0:e11e8793c3ce 22 #include "Socket/Socket.h"
Bongjun 0:e11e8793c3ce 23 #include "Socket/Endpoint.h"
Bongjun 0:e11e8793c3ce 24 /**
Bongjun 0:e11e8793c3ce 25 TCP socket connection
Bongjun 0:e11e8793c3ce 26 */
Bongjun 0:e11e8793c3ce 27 class TCPSocketConnection: public Socket, public Endpoint
Bongjun 0:e11e8793c3ce 28 {
Bongjun 0:e11e8793c3ce 29 friend class TCPSocketServer;
Bongjun 0:e11e8793c3ce 30
Bongjun 0:e11e8793c3ce 31 public:
Bongjun 0:e11e8793c3ce 32 /** TCP socket connection
Bongjun 0:e11e8793c3ce 33 */
Bongjun 0:e11e8793c3ce 34 TCPSocketConnection();
Bongjun 0:e11e8793c3ce 35
Bongjun 0:e11e8793c3ce 36 /** Connects this TCP socket to the server
Bongjun 0:e11e8793c3ce 37 \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
Bongjun 0:e11e8793c3ce 38 \param port The host's port to connect to.
Bongjun 0:e11e8793c3ce 39 \return 0 on success, -1 on failure.
Bongjun 0:e11e8793c3ce 40 */
Bongjun 0:e11e8793c3ce 41 int connect(const char* host, const int port);
Bongjun 0:e11e8793c3ce 42
Bongjun 0:e11e8793c3ce 43 /** Check if the socket is connected
Bongjun 0:e11e8793c3ce 44 \return true if connected, false otherwise.
Bongjun 0:e11e8793c3ce 45 */
Bongjun 0:e11e8793c3ce 46 bool is_connected(void);
Bongjun 0:e11e8793c3ce 47
Bongjun 0:e11e8793c3ce 48 /** Send data to the remote host.
Bongjun 0:e11e8793c3ce 49 \param data The buffer to send to the host.
Bongjun 0:e11e8793c3ce 50 \param length The length of the buffer to send.
Bongjun 0:e11e8793c3ce 51 \return the number of written bytes on success (>=0) or -1 on failure
Bongjun 0:e11e8793c3ce 52 */
Bongjun 0:e11e8793c3ce 53 int send(char* data, int length);
Bongjun 0:e11e8793c3ce 54
Bongjun 0:e11e8793c3ce 55 /** Send all the data to the remote host.
Bongjun 0:e11e8793c3ce 56 \param data The buffer to send to the host.
Bongjun 0:e11e8793c3ce 57 \param length The length of the buffer to send.
Bongjun 0:e11e8793c3ce 58 \return the number of written bytes on success (>=0) or -1 on failure
Bongjun 0:e11e8793c3ce 59 */
Bongjun 0:e11e8793c3ce 60 int send_all(char* data, int length);
Bongjun 0:e11e8793c3ce 61
Bongjun 0:e11e8793c3ce 62 /** Receive data from the remote host.
Bongjun 0:e11e8793c3ce 63 \param data The buffer in which to store the data received from the host.
Bongjun 0:e11e8793c3ce 64 \param length The maximum length of the buffer.
Bongjun 0:e11e8793c3ce 65 \return the number of received bytes on success (>=0) or -1 on failure
Bongjun 0:e11e8793c3ce 66 */
Bongjun 0:e11e8793c3ce 67 int receive(char* data, int length);
Bongjun 0:e11e8793c3ce 68
Bongjun 0:e11e8793c3ce 69 /** Receive all the data from the remote host.
Bongjun 0:e11e8793c3ce 70 \param data The buffer in which to store the data received from the host.
Bongjun 0:e11e8793c3ce 71 \param length The maximum length of the buffer.
Bongjun 0:e11e8793c3ce 72 \return the number of received bytes on success (>=0) or -1 on failure
Bongjun 0:e11e8793c3ce 73 */
Bongjun 0:e11e8793c3ce 74 int receive_all(char* data, int length);
Bongjun 0:e11e8793c3ce 75
Bongjun 0:e11e8793c3ce 76 private:
Bongjun 0:e11e8793c3ce 77 bool _is_connected;
Bongjun 0:e11e8793c3ce 78 };
Bongjun 0:e11e8793c3ce 79
Bongjun 0:e11e8793c3ce 80 #endif