Wayne Jay / EthernetInterface

Onenet

Dependents:   K64F_eCompass_OneNET_JW

Socket/TCPSocketConnection.h@0:b2805b6888dc, 2016-06-20 (annotated)

Committer:
robert_jw
Date:
Mon Jun 20 01:40:20 2016 +0000
Revision:
0:b2805b6888dc
ADS

Who changed what in which revision?

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