David Smart / Socket

minor derivative to reduce compiler warnings and tag read-only parameters as const.

Dependents:   EthernetInterface

Fork of Socket by mbed official

TCPSocketConnection.h@22:95f0918446a9, 2018-07-03 (annotated)

Committer:
WiredHome
Date:
Tue Jul 03 02:06:47 2018 +0000
Revision:
22:95f0918446a9
Parent:
21:04922f6a3602 
Revised error returns to uniquely identify failure modes.

Who changed what in which revision?

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