For mbed OS-5 version for WIZnet Ethernet Interface, this is Library using Hardware TCP/IP chip, W5500 and TCP/IP Offload Engine, W7500.
Warning
- If you want to use existing codes, you need to change the class used as EthernetInterface to WIZnetInterface.
This is WIZnet Ethernet Interface using Hardware TCP/IP chip, W5500 and TCP/IP Offload Engine, W7500.
- WIZwiki_W7500 : /platforms/WIZwiki-W7500/
- WIZwiki_W7500P : /platforms/WIZwiki-W7500P/
- WIZwiki_W7500ECO : /platforms/WIZwiki-W7500ECO/
- W5500 Ethernet Shield : /components/W5500-Ethernet-Kit-for-IoT/
This library is an Ethernet Interface library port-based on [EthernetInterface](https://developer.mbed.org/users/mbed_official/code/EthernetInterface/docs/tip/).
For more detail, visit http://embeddist.blogspot.kr/2015/06/wiznetinterface-for-armmbed.html
Socket/TCPSocketConnection.h@0:d4c8fe4d9b29, 2017-09-04 (annotated)
- Committer:
- justinkim
- Date:
- Mon Sep 04 00:23:04 2017 +0000
- Revision:
- 0:d4c8fe4d9b29
mbed OS 5 version migration...
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
justinkim | 0:d4c8fe4d9b29 | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
justinkim | 0:d4c8fe4d9b29 | 2 | * |
justinkim | 0:d4c8fe4d9b29 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
justinkim | 0:d4c8fe4d9b29 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
justinkim | 0:d4c8fe4d9b29 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
justinkim | 0:d4c8fe4d9b29 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
justinkim | 0:d4c8fe4d9b29 | 7 | * furnished to do so, subject to the following conditions: |
justinkim | 0:d4c8fe4d9b29 | 8 | * |
justinkim | 0:d4c8fe4d9b29 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
justinkim | 0:d4c8fe4d9b29 | 10 | * substantial portions of the Software. |
justinkim | 0:d4c8fe4d9b29 | 11 | * |
justinkim | 0:d4c8fe4d9b29 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
justinkim | 0:d4c8fe4d9b29 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
justinkim | 0:d4c8fe4d9b29 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
justinkim | 0:d4c8fe4d9b29 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
justinkim | 0:d4c8fe4d9b29 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
justinkim | 0:d4c8fe4d9b29 | 17 | */ |
justinkim | 0:d4c8fe4d9b29 | 18 | |
justinkim | 0:d4c8fe4d9b29 | 19 | #ifndef TCPSOCKETCONNECTION_H |
justinkim | 0:d4c8fe4d9b29 | 20 | #define TCPSOCKETCONNECTION_H |
justinkim | 0:d4c8fe4d9b29 | 21 | |
justinkim | 0:d4c8fe4d9b29 | 22 | #include "WIZnet_Socket.h" |
justinkim | 0:d4c8fe4d9b29 | 23 | #include "Endpoint.h" |
justinkim | 0:d4c8fe4d9b29 | 24 | |
justinkim | 0:d4c8fe4d9b29 | 25 | /** |
justinkim | 0:d4c8fe4d9b29 | 26 | TCP socket connection |
justinkim | 0:d4c8fe4d9b29 | 27 | */ |
justinkim | 0:d4c8fe4d9b29 | 28 | class TCPSocketConnection: public WIZnet_Socket, public Endpoint { |
justinkim | 0:d4c8fe4d9b29 | 29 | friend class TCPSocketServer; |
justinkim | 0:d4c8fe4d9b29 | 30 | |
justinkim | 0:d4c8fe4d9b29 | 31 | public: |
justinkim | 0:d4c8fe4d9b29 | 32 | /** TCP socket connection |
justinkim | 0:d4c8fe4d9b29 | 33 | */ |
justinkim | 0:d4c8fe4d9b29 | 34 | TCPSocketConnection(); |
justinkim | 0:d4c8fe4d9b29 | 35 | |
justinkim | 0:d4c8fe4d9b29 | 36 | /** Connects this TCP socket to the server |
justinkim | 0:d4c8fe4d9b29 | 37 | \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS. |
justinkim | 0:d4c8fe4d9b29 | 38 | \param port The host's port to connect to. |
justinkim | 0:d4c8fe4d9b29 | 39 | \return 0 on success, -1 on failure. |
justinkim | 0:d4c8fe4d9b29 | 40 | */ |
justinkim | 0:d4c8fe4d9b29 | 41 | int connect(const char* host, const int port); |
justinkim | 0:d4c8fe4d9b29 | 42 | |
justinkim | 0:d4c8fe4d9b29 | 43 | /** Check if the socket is connected |
justinkim | 0:d4c8fe4d9b29 | 44 | \return true if connected, false otherwise. |
justinkim | 0:d4c8fe4d9b29 | 45 | */ |
justinkim | 0:d4c8fe4d9b29 | 46 | bool is_connected(void); |
justinkim | 0:d4c8fe4d9b29 | 47 | |
justinkim | 0:d4c8fe4d9b29 | 48 | /** Send data to the remote host. |
justinkim | 0:d4c8fe4d9b29 | 49 | \param data The buffer to send to the host. |
justinkim | 0:d4c8fe4d9b29 | 50 | \param length The length of the buffer to send. |
justinkim | 0:d4c8fe4d9b29 | 51 | \return the number of written bytes on success (>=0) or -1 on failure |
justinkim | 0:d4c8fe4d9b29 | 52 | */ |
justinkim | 0:d4c8fe4d9b29 | 53 | int send(char* data, int length); |
justinkim | 0:d4c8fe4d9b29 | 54 | |
justinkim | 0:d4c8fe4d9b29 | 55 | /** Send all the data to the remote host. |
justinkim | 0:d4c8fe4d9b29 | 56 | \param data The buffer to send to the host. |
justinkim | 0:d4c8fe4d9b29 | 57 | \param length The length of the buffer to send. |
justinkim | 0:d4c8fe4d9b29 | 58 | \return the number of written bytes on success (>=0) or -1 on failure |
justinkim | 0:d4c8fe4d9b29 | 59 | */ |
justinkim | 0:d4c8fe4d9b29 | 60 | int send_all(char* data, int length); |
justinkim | 0:d4c8fe4d9b29 | 61 | |
justinkim | 0:d4c8fe4d9b29 | 62 | /** Receive data from the remote host. |
justinkim | 0:d4c8fe4d9b29 | 63 | \param data The buffer in which to store the data received from the host. |
justinkim | 0:d4c8fe4d9b29 | 64 | \param length The maximum length of the buffer. |
justinkim | 0:d4c8fe4d9b29 | 65 | \return the number of received bytes on success (>=0) or -1 on failure |
justinkim | 0:d4c8fe4d9b29 | 66 | */ |
justinkim | 0:d4c8fe4d9b29 | 67 | int receive(char* data, int length); |
justinkim | 0:d4c8fe4d9b29 | 68 | |
justinkim | 0:d4c8fe4d9b29 | 69 | /** Receive all the data from the remote host. |
justinkim | 0:d4c8fe4d9b29 | 70 | \param data The buffer in which to store the data received from the host. |
justinkim | 0:d4c8fe4d9b29 | 71 | \param length The maximum length of the buffer. |
justinkim | 0:d4c8fe4d9b29 | 72 | \return the number of received bytes on success (>=0) or -1 on failure |
justinkim | 0:d4c8fe4d9b29 | 73 | */ |
justinkim | 0:d4c8fe4d9b29 | 74 | int receive_all(char* data, int length); |
justinkim | 0:d4c8fe4d9b29 | 75 | |
justinkim | 0:d4c8fe4d9b29 | 76 | private: |
justinkim | 0:d4c8fe4d9b29 | 77 | bool _is_connected; |
justinkim | 0:d4c8fe4d9b29 | 78 | }; |
justinkim | 0:d4c8fe4d9b29 | 79 | |
justinkim | 0:d4c8fe4d9b29 | 80 | #endif |