Junichi Katsu / MultiIoTBoardLib

MultiIoTBoard library

Dependencies:   BME280 SB1602E

Dependents:   MITB_Sample

ESP8266InterfaceTiny/Socket/TCPSocketConnection.h@0:bad9495b4215, 2017-07-28 (annotated)

Committer:
jksoft
Date:
Fri Jul 28 02:23:25 2017 +0000
Revision:
0:bad9495b4215
First edition

Who changed what in which revision?

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