Patrick Pollet / EthernetInterfaceW5500

Ethernet interface for W5500 with bug fixed in socket::close()

Fork of EthernetInterfaceW5500 by W5500-Ethernet-Interface Makers

Socket/TCPSocketConnection.h@15:fe68ac753657, 2014-08-29 (annotated)

Committer:
ppo
Date:
Fri Aug 29 12:00:38 2014 +0000
Revision:
15:fe68ac753657
Parent:
10:cadac6bcd169 
bug fixed in close(), now socket is really closed

Who changed what in which revision?

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