Donatien Garnier
/
EthernetNetIfBeta
Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
LPC2368/api/TCPSocket.h@0:7f97f2ad3030, 2010-07-26 (annotated)
- Committer:
- donatien
- Date:
- Mon Jul 26 16:25:55 2010 +0000
- Revision:
- 0:7f97f2ad3030
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:7f97f2ad3030 | 1 | |
| donatien | 0:7f97f2ad3030 | 2 | /* |
| donatien | 0:7f97f2ad3030 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:7f97f2ad3030 | 4 | |
| donatien | 0:7f97f2ad3030 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:7f97f2ad3030 | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:7f97f2ad3030 | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:7f97f2ad3030 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:7f97f2ad3030 | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:7f97f2ad3030 | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:7f97f2ad3030 | 11 | |
| donatien | 0:7f97f2ad3030 | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:7f97f2ad3030 | 13 | all copies or substantial portions of the Software. |
| donatien | 0:7f97f2ad3030 | 14 | |
| donatien | 0:7f97f2ad3030 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:7f97f2ad3030 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:7f97f2ad3030 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:7f97f2ad3030 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:7f97f2ad3030 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:7f97f2ad3030 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:7f97f2ad3030 | 21 | THE SOFTWARE. |
| donatien | 0:7f97f2ad3030 | 22 | */ |
| donatien | 0:7f97f2ad3030 | 23 | |
| donatien | 0:7f97f2ad3030 | 24 | #ifndef TCPSOCKET_H |
| donatien | 0:7f97f2ad3030 | 25 | #define TCPSOCKET_H |
| donatien | 0:7f97f2ad3030 | 26 | |
| donatien | 0:7f97f2ad3030 | 27 | #include "if/net/net.h" |
| donatien | 0:7f97f2ad3030 | 28 | //Essentially it is a safe interface to NetTcpSocket |
| donatien | 0:7f97f2ad3030 | 29 | |
| donatien | 0:7f97f2ad3030 | 30 | //!TCP Socket Errors |
| donatien | 0:7f97f2ad3030 | 31 | enum TCPSocketErr |
| donatien | 0:7f97f2ad3030 | 32 | { |
| donatien | 0:7f97f2ad3030 | 33 | __TCPSOCKET_MIN = -0xFFFF, |
| donatien | 0:7f97f2ad3030 | 34 | TCPSOCKET_SETUP, //!TCPSocket not properly configured |
| donatien | 0:7f97f2ad3030 | 35 | TCPSOCKET_TIMEOUT, |
| donatien | 0:7f97f2ad3030 | 36 | TCPSOCKET_IF, //!Interface has problems, does not exist or is not initialized |
| donatien | 0:7f97f2ad3030 | 37 | TCPSOCKET_MEM, //!Not enough mem |
| donatien | 0:7f97f2ad3030 | 38 | TCPSOCKET_INUSE, //!Interface / Port is in use |
| donatien | 0:7f97f2ad3030 | 39 | TCPSOCKET_EMPTY, //!Connections queue is empty |
| donatien | 0:7f97f2ad3030 | 40 | TCPSOCKET_RST, //!Connection was reset by remote host |
| donatien | 0:7f97f2ad3030 | 41 | //... |
| donatien | 0:7f97f2ad3030 | 42 | TCPSOCKET_OK = 0 |
| donatien | 0:7f97f2ad3030 | 43 | }; |
| donatien | 0:7f97f2ad3030 | 44 | |
| donatien | 0:7f97f2ad3030 | 45 | //!TCP Socket Events |
| donatien | 0:7f97f2ad3030 | 46 | enum TCPSocketEvent |
| donatien | 0:7f97f2ad3030 | 47 | { |
| donatien | 0:7f97f2ad3030 | 48 | TCPSOCKET_CONNECTED, //!Connected to host, must call accept() if we were listening |
| donatien | 0:7f97f2ad3030 | 49 | TCPSOCKET_ACCEPT, //!Connected to client |
| donatien | 0:7f97f2ad3030 | 50 | TCPSOCKET_READABLE, //!Data in buf |
| donatien | 0:7f97f2ad3030 | 51 | TCPSOCKET_WRITEABLE, //!Can write data to buf |
| donatien | 0:7f97f2ad3030 | 52 | TCPSOCKET_CONTIMEOUT, //!Connection timed out |
| donatien | 0:7f97f2ad3030 | 53 | TCPSOCKET_CONRST, //!Connection was reset by remote host |
| donatien | 0:7f97f2ad3030 | 54 | TCPSOCKET_CONABRT, //!Connection was aborted |
| donatien | 0:7f97f2ad3030 | 55 | TCPSOCKET_ERROR, //!Unknown error |
| donatien | 0:7f97f2ad3030 | 56 | TCPSOCKET_DISCONNECTED //!Disconnected |
| donatien | 0:7f97f2ad3030 | 57 | }; |
| donatien | 0:7f97f2ad3030 | 58 | |
| donatien | 0:7f97f2ad3030 | 59 | //!This is a simple TCP Socket class |
| donatien | 0:7f97f2ad3030 | 60 | /*! |
| donatien | 0:7f97f2ad3030 | 61 | This class exposes an API to deal with TCP Sockets |
| donatien | 0:7f97f2ad3030 | 62 | */ |
| donatien | 0:7f97f2ad3030 | 63 | class TCPSocket |
| donatien | 0:7f97f2ad3030 | 64 | { |
| donatien | 0:7f97f2ad3030 | 65 | public: |
| donatien | 0:7f97f2ad3030 | 66 | //!Creates a new socket |
| donatien | 0:7f97f2ad3030 | 67 | TCPSocket(); |
| donatien | 0:7f97f2ad3030 | 68 | protected: |
| donatien | 0:7f97f2ad3030 | 69 | TCPSocket(NetTcpSocket* pNetTcpSocket); |
| donatien | 0:7f97f2ad3030 | 70 | public: |
| donatien | 0:7f97f2ad3030 | 71 | //!Closes if needed and destroys the socket |
| donatien | 0:7f97f2ad3030 | 72 | ~TCPSocket(); //close() |
| donatien | 0:7f97f2ad3030 | 73 | |
| donatien | 0:7f97f2ad3030 | 74 | //!Binds the socket to (local) host |
| donatien | 0:7f97f2ad3030 | 75 | TCPSocketErr bind(const Host& me); |
| donatien | 0:7f97f2ad3030 | 76 | |
| donatien | 0:7f97f2ad3030 | 77 | //!Starts listening |
| donatien | 0:7f97f2ad3030 | 78 | TCPSocketErr listen(); |
| donatien | 0:7f97f2ad3030 | 79 | |
| donatien | 0:7f97f2ad3030 | 80 | //!Connects socket to host |
| donatien | 0:7f97f2ad3030 | 81 | TCPSocketErr connect(const Host& host); |
| donatien | 0:7f97f2ad3030 | 82 | |
| donatien | 0:7f97f2ad3030 | 83 | //!Accepts connection from client and gets connected socket |
| donatien | 0:7f97f2ad3030 | 84 | TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket); |
| donatien | 0:7f97f2ad3030 | 85 | |
| donatien | 0:7f97f2ad3030 | 86 | //!Sends data |
| donatien | 0:7f97f2ad3030 | 87 | /* |
| donatien | 0:7f97f2ad3030 | 88 | \return a negative error code or the number of bytes transmitted |
| donatien | 0:7f97f2ad3030 | 89 | */ |
| donatien | 0:7f97f2ad3030 | 90 | int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len); |
| donatien | 0:7f97f2ad3030 | 91 | |
| donatien | 0:7f97f2ad3030 | 92 | //!Receives data |
| donatien | 0:7f97f2ad3030 | 93 | /* |
| donatien | 0:7f97f2ad3030 | 94 | \return a negative error code or the number of bytes received |
| donatien | 0:7f97f2ad3030 | 95 | */ |
| donatien | 0:7f97f2ad3030 | 96 | int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len); |
| donatien | 0:7f97f2ad3030 | 97 | |
| donatien | 0:7f97f2ad3030 | 98 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| donatien | 0:7f97f2ad3030 | 99 | |
| donatien | 0:7f97f2ad3030 | 100 | //!Closes socket |
| donatien | 0:7f97f2ad3030 | 101 | TCPSocketErr close(); |
| donatien | 0:7f97f2ad3030 | 102 | |
| donatien | 0:7f97f2ad3030 | 103 | //Callbacks |
| donatien | 0:7f97f2ad3030 | 104 | //!Setups callback |
| donatien | 0:7f97f2ad3030 | 105 | /*! |
| donatien | 0:7f97f2ad3030 | 106 | \param pMethod : callback function |
| donatien | 0:7f97f2ad3030 | 107 | */ |
| donatien | 0:7f97f2ad3030 | 108 | void setOnEvent( void (*pMethod)(TCPSocketEvent) ); |
| donatien | 0:7f97f2ad3030 | 109 | |
| donatien | 0:7f97f2ad3030 | 110 | //!Setups callback |
| donatien | 0:7f97f2ad3030 | 111 | /*! |
| donatien | 0:7f97f2ad3030 | 112 | \param pItem : instance of class on which to execute the callback method |
| donatien | 0:7f97f2ad3030 | 113 | \param pMethod : callback method |
| donatien | 0:7f97f2ad3030 | 114 | */ |
| donatien | 0:7f97f2ad3030 | 115 | class CDummy; |
| donatien | 0:7f97f2ad3030 | 116 | template<class T> |
| donatien | 0:7f97f2ad3030 | 117 | void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) ) |
| donatien | 0:7f97f2ad3030 | 118 | { |
| donatien | 0:7f97f2ad3030 | 119 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:7f97f2ad3030 | 120 | m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod; |
| donatien | 0:7f97f2ad3030 | 121 | } |
| donatien | 0:7f97f2ad3030 | 122 | |
| donatien | 0:7f97f2ad3030 | 123 | //!Disables callback |
| donatien | 0:7f97f2ad3030 | 124 | void resetOnEvent(); |
| donatien | 0:7f97f2ad3030 | 125 | |
| donatien | 0:7f97f2ad3030 | 126 | protected: |
| donatien | 0:7f97f2ad3030 | 127 | void onNetTcpSocketEvent(NetTcpSocketEvent e); |
| donatien | 0:7f97f2ad3030 | 128 | TCPSocketErr checkInst(); |
| donatien | 0:7f97f2ad3030 | 129 | |
| donatien | 0:7f97f2ad3030 | 130 | private: |
| donatien | 0:7f97f2ad3030 | 131 | NetTcpSocket* m_pNetTcpSocket; |
| donatien | 0:7f97f2ad3030 | 132 | |
| donatien | 0:7f97f2ad3030 | 133 | CDummy* m_pCbItem; |
| donatien | 0:7f97f2ad3030 | 134 | void (CDummy::*m_pCbMeth)(TCPSocketEvent); |
| donatien | 0:7f97f2ad3030 | 135 | |
| donatien | 0:7f97f2ad3030 | 136 | void (*m_pCb)(TCPSocketEvent); |
| donatien | 0:7f97f2ad3030 | 137 | |
| donatien | 0:7f97f2ad3030 | 138 | }; |
| donatien | 0:7f97f2ad3030 | 139 | |
| donatien | 0:7f97f2ad3030 | 140 | #endif |