Abdulaziz alsalloum / Project1HomeAlertSystem

Home Alert System

Dependencies:   PWM_Tone_Library DHT

EthernetInterface/Socket/TCPSocketConnection.h@5:569a4894abc1, 2019-03-08 (annotated)

Committer:
aziz111
Date:
Fri Mar 08 17:15:02 2019 +0000
Revision:
5:569a4894abc1
Parent:
3:78f223d34f36 
Final

Who changed what in which revision?

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