Darran Shepherd
Net stack with AutoIP enabled
api/TCPSocket.h@0:ac21159e27f4, 2010-07-02 (annotated)
- Committer:
- darran
- Date:
- Fri Jul 02 17:21:58 2010 +0000
- Revision:
- 0:ac21159e27f4
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| darran | 0:ac21159e27f4 | 1 | |
| darran | 0:ac21159e27f4 | 2 | /* |
| darran | 0:ac21159e27f4 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| darran | 0:ac21159e27f4 | 4 | |
| darran | 0:ac21159e27f4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| darran | 0:ac21159e27f4 | 6 | of this software and associated documentation files (the "Software"), to deal |
| darran | 0:ac21159e27f4 | 7 | in the Software without restriction, including without limitation the rights |
| darran | 0:ac21159e27f4 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| darran | 0:ac21159e27f4 | 9 | copies of the Software, and to permit persons to whom the Software is |
| darran | 0:ac21159e27f4 | 10 | furnished to do so, subject to the following conditions: |
| darran | 0:ac21159e27f4 | 11 | |
| darran | 0:ac21159e27f4 | 12 | The above copyright notice and this permission notice shall be included in |
| darran | 0:ac21159e27f4 | 13 | all copies or substantial portions of the Software. |
| darran | 0:ac21159e27f4 | 14 | |
| darran | 0:ac21159e27f4 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| darran | 0:ac21159e27f4 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| darran | 0:ac21159e27f4 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| darran | 0:ac21159e27f4 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| darran | 0:ac21159e27f4 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| darran | 0:ac21159e27f4 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| darran | 0:ac21159e27f4 | 21 | THE SOFTWARE. |
| darran | 0:ac21159e27f4 | 22 | */ |
| darran | 0:ac21159e27f4 | 23 | |
| darran | 0:ac21159e27f4 | 24 | #ifndef TCPSOCKET_H |
| darran | 0:ac21159e27f4 | 25 | #define TCPSOCKET_H |
| darran | 0:ac21159e27f4 | 26 | |
| darran | 0:ac21159e27f4 | 27 | #include "if/net/net.h" |
| darran | 0:ac21159e27f4 | 28 | //Essentially it is a safe interface to NetTcpSocket |
| darran | 0:ac21159e27f4 | 29 | |
| darran | 0:ac21159e27f4 | 30 | enum TCPSocketErr |
| darran | 0:ac21159e27f4 | 31 | { |
| darran | 0:ac21159e27f4 | 32 | __TCPSOCKET_MIN = -0xFFFF, |
| darran | 0:ac21159e27f4 | 33 | TCPSOCKET_SETUP, //NetTcpSocket not properly configured |
| darran | 0:ac21159e27f4 | 34 | TCPSOCKET_TIMEOUT, |
| darran | 0:ac21159e27f4 | 35 | TCPSOCKET_IF, //If has problems, does not exist or is not initialized |
| darran | 0:ac21159e27f4 | 36 | TCPSOCKET_MEM, //Not enough mem |
| darran | 0:ac21159e27f4 | 37 | TCPSOCKET_INUSE, //If/Port is in use |
| darran | 0:ac21159e27f4 | 38 | TCPSOCKET_EMPTY, //Connections queue is empty |
| darran | 0:ac21159e27f4 | 39 | TCPSOCKET_RST, // Connection was reset by remote host |
| darran | 0:ac21159e27f4 | 40 | //... |
| darran | 0:ac21159e27f4 | 41 | TCPSOCKET_OK = 0 |
| darran | 0:ac21159e27f4 | 42 | }; |
| darran | 0:ac21159e27f4 | 43 | |
| darran | 0:ac21159e27f4 | 44 | enum TCPSocketEvent |
| darran | 0:ac21159e27f4 | 45 | { |
| darran | 0:ac21159e27f4 | 46 | TCPSOCKET_CONNECTED, //Connected to host, must call accept() if we were listening |
| darran | 0:ac21159e27f4 | 47 | TCPSOCKET_ACCEPT, //Connected to client |
| darran | 0:ac21159e27f4 | 48 | TCPSOCKET_READABLE, //Data in buf |
| darran | 0:ac21159e27f4 | 49 | TCPSOCKET_WRITEABLE, //Can write data to buf |
| darran | 0:ac21159e27f4 | 50 | TCPSOCKET_CONTIMEOUT, |
| darran | 0:ac21159e27f4 | 51 | TCPSOCKET_CONRST, |
| darran | 0:ac21159e27f4 | 52 | TCPSOCKET_CONABRT, |
| darran | 0:ac21159e27f4 | 53 | TCPSOCKET_ERROR, |
| darran | 0:ac21159e27f4 | 54 | TCPSOCKET_DISCONNECTED |
| darran | 0:ac21159e27f4 | 55 | }; |
| darran | 0:ac21159e27f4 | 56 | |
| darran | 0:ac21159e27f4 | 57 | |
| darran | 0:ac21159e27f4 | 58 | class TCPSocket |
| darran | 0:ac21159e27f4 | 59 | { |
| darran | 0:ac21159e27f4 | 60 | public: |
| darran | 0:ac21159e27f4 | 61 | TCPSocket(); |
| darran | 0:ac21159e27f4 | 62 | protected: |
| darran | 0:ac21159e27f4 | 63 | TCPSocket(NetTcpSocket* pNetTcpSocket); |
| darran | 0:ac21159e27f4 | 64 | public: |
| darran | 0:ac21159e27f4 | 65 | ~TCPSocket(); //close() |
| darran | 0:ac21159e27f4 | 66 | |
| darran | 0:ac21159e27f4 | 67 | TCPSocketErr bind(const Host& me); |
| darran | 0:ac21159e27f4 | 68 | TCPSocketErr listen(); |
| darran | 0:ac21159e27f4 | 69 | TCPSocketErr connect(const Host& host); |
| darran | 0:ac21159e27f4 | 70 | TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket); |
| darran | 0:ac21159e27f4 | 71 | |
| darran | 0:ac21159e27f4 | 72 | int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len); |
| darran | 0:ac21159e27f4 | 73 | int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len); |
| darran | 0:ac21159e27f4 | 74 | |
| darran | 0:ac21159e27f4 | 75 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| darran | 0:ac21159e27f4 | 76 | |
| darran | 0:ac21159e27f4 | 77 | TCPSocketErr close(); |
| darran | 0:ac21159e27f4 | 78 | |
| darran | 0:ac21159e27f4 | 79 | class CDummy; |
| darran | 0:ac21159e27f4 | 80 | //Callbacks |
| darran | 0:ac21159e27f4 | 81 | void setOnEvent( void (*pMethod)(TCPSocketEvent) ); |
| darran | 0:ac21159e27f4 | 82 | template<class T> |
| darran | 0:ac21159e27f4 | 83 | void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) ) |
| darran | 0:ac21159e27f4 | 84 | { |
| darran | 0:ac21159e27f4 | 85 | m_pCbItem = (CDummy*) pItem; |
| darran | 0:ac21159e27f4 | 86 | m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod; |
| darran | 0:ac21159e27f4 | 87 | } |
| darran | 0:ac21159e27f4 | 88 | |
| darran | 0:ac21159e27f4 | 89 | void resetOnEvent(); //Disable callback |
| darran | 0:ac21159e27f4 | 90 | |
| darran | 0:ac21159e27f4 | 91 | protected: |
| darran | 0:ac21159e27f4 | 92 | void onNetTcpSocketEvent(NetTcpSocketEvent e); |
| darran | 0:ac21159e27f4 | 93 | TCPSocketErr checkInst(); |
| darran | 0:ac21159e27f4 | 94 | |
| darran | 0:ac21159e27f4 | 95 | private: |
| darran | 0:ac21159e27f4 | 96 | NetTcpSocket* m_pNetTcpSocket; |
| darran | 0:ac21159e27f4 | 97 | |
| darran | 0:ac21159e27f4 | 98 | CDummy* m_pCbItem; |
| darran | 0:ac21159e27f4 | 99 | void (CDummy::*m_pCbMeth)(TCPSocketEvent); |
| darran | 0:ac21159e27f4 | 100 | |
| darran | 0:ac21159e27f4 | 101 | void (*m_pCb)(TCPSocketEvent); |
| darran | 0:ac21159e27f4 | 102 | |
| darran | 0:ac21159e27f4 | 103 | }; |
| darran | 0:ac21159e27f4 | 104 | |
| darran | 0:ac21159e27f4 | 105 | #endif |