Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
if/net/nettcpsocket.h@0:632c9925f013, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:05:15 2010 +0000
- Revision:
- 0:632c9925f013
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | |
| donatien | 0:632c9925f013 | 2 | /* |
| donatien | 0:632c9925f013 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:632c9925f013 | 4 | |
| donatien | 0:632c9925f013 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:632c9925f013 | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:632c9925f013 | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:632c9925f013 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:632c9925f013 | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:632c9925f013 | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:632c9925f013 | 11 | |
| donatien | 0:632c9925f013 | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:632c9925f013 | 13 | all copies or substantial portions of the Software. |
| donatien | 0:632c9925f013 | 14 | |
| donatien | 0:632c9925f013 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:632c9925f013 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:632c9925f013 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:632c9925f013 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:632c9925f013 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:632c9925f013 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:632c9925f013 | 21 | THE SOFTWARE. |
| donatien | 0:632c9925f013 | 22 | */ |
| donatien | 0:632c9925f013 | 23 | |
| donatien | 0:632c9925f013 | 24 | #ifndef NETTCPSOCKET_H |
| donatien | 0:632c9925f013 | 25 | #define NETTCPSOCKET_H |
| donatien | 0:632c9925f013 | 26 | |
| donatien | 0:632c9925f013 | 27 | #include "net.h" |
| donatien | 0:632c9925f013 | 28 | #include "host.h" |
| donatien | 0:632c9925f013 | 29 | |
| donatien | 0:632c9925f013 | 30 | #include <queue> |
| donatien | 0:632c9925f013 | 31 | using std::queue; |
| donatien | 0:632c9925f013 | 32 | |
| donatien | 0:632c9925f013 | 33 | //Implements a Berkeley-like socket if |
| donatien | 0:632c9925f013 | 34 | //Can be interfaced either to lwip or a Telit module |
| donatien | 0:632c9925f013 | 35 | |
| donatien | 0:632c9925f013 | 36 | enum NetTcpSocketErr |
| donatien | 0:632c9925f013 | 37 | { |
| donatien | 0:632c9925f013 | 38 | __NETTCPSOCKET_MIN = -0xFFFF, |
| donatien | 0:632c9925f013 | 39 | NETTCPSOCKET_SETUP, //NetTcpSocket not properly configured |
| donatien | 0:632c9925f013 | 40 | NETTCPSOCKET_TIMEOUT, |
| donatien | 0:632c9925f013 | 41 | NETTCPSOCKET_IF, //If has problems |
| donatien | 0:632c9925f013 | 42 | NETTCPSOCKET_MEM, //Not enough mem |
| donatien | 0:632c9925f013 | 43 | NETTCPSOCKET_INUSE, //If/Port is in use |
| donatien | 0:632c9925f013 | 44 | NETTCPSOCKET_EMPTY, //Connections queue is empty |
| donatien | 0:632c9925f013 | 45 | NETTCPSOCKET_RST, // Connection was reset by remote host |
| donatien | 0:632c9925f013 | 46 | //... |
| donatien | 0:632c9925f013 | 47 | NETTCPSOCKET_OK = 0 |
| donatien | 0:632c9925f013 | 48 | }; |
| donatien | 0:632c9925f013 | 49 | |
| donatien | 0:632c9925f013 | 50 | enum NetTcpSocketEvent |
| donatien | 0:632c9925f013 | 51 | { |
| donatien | 0:632c9925f013 | 52 | NETTCPSOCKET_CONNECTED, //Connected to host, must call accept() if we were listening |
| donatien | 0:632c9925f013 | 53 | NETTCPSOCKET_ACCEPT, //Connected to client |
| donatien | 0:632c9925f013 | 54 | NETTCPSOCKET_READABLE, //Data in buf |
| donatien | 0:632c9925f013 | 55 | NETTCPSOCKET_WRITEABLE, //Can write data to buf |
| donatien | 0:632c9925f013 | 56 | NETTCPSOCKET_CONTIMEOUT, |
| donatien | 0:632c9925f013 | 57 | NETTCPSOCKET_CONRST, |
| donatien | 0:632c9925f013 | 58 | NETTCPSOCKET_CONABRT, |
| donatien | 0:632c9925f013 | 59 | NETTCPSOCKET_ERROR, |
| donatien | 0:632c9925f013 | 60 | NETTCPSOCKET_DISCONNECTED |
| donatien | 0:632c9925f013 | 61 | }; |
| donatien | 0:632c9925f013 | 62 | |
| donatien | 0:632c9925f013 | 63 | |
| donatien | 0:632c9925f013 | 64 | class NetTcpSocket |
| donatien | 0:632c9925f013 | 65 | { |
| donatien | 0:632c9925f013 | 66 | public: |
| donatien | 0:632c9925f013 | 67 | NetTcpSocket(); |
| donatien | 0:632c9925f013 | 68 | virtual ~NetTcpSocket(); //close() |
| donatien | 0:632c9925f013 | 69 | |
| donatien | 0:632c9925f013 | 70 | virtual NetTcpSocketErr bind(const Host& me) = 0; |
| donatien | 0:632c9925f013 | 71 | virtual NetTcpSocketErr listen() = 0; |
| donatien | 0:632c9925f013 | 72 | virtual NetTcpSocketErr connect(const Host& host) = 0; |
| donatien | 0:632c9925f013 | 73 | virtual NetTcpSocketErr accept(Host* pClient, NetTcpSocket** ppNewNetTcpSocket) = 0; |
| donatien | 0:632c9925f013 | 74 | |
| donatien | 0:632c9925f013 | 75 | virtual int /*if < 0 : NetTcpSocketErr*/ send(const char* buf, int len) = 0; |
| donatien | 0:632c9925f013 | 76 | virtual int /*if < 0 : NetTcpSocketErr*/ recv(char* buf, int len) = 0; |
| donatien | 0:632c9925f013 | 77 | |
| donatien | 0:632c9925f013 | 78 | virtual NetTcpSocketErr close() = 0; |
| donatien | 0:632c9925f013 | 79 | |
| donatien | 0:632c9925f013 | 80 | virtual NetTcpSocketErr poll() = 0; |
| donatien | 0:632c9925f013 | 81 | |
| donatien | 0:632c9925f013 | 82 | class CDummy; |
| donatien | 0:632c9925f013 | 83 | //Callbacks |
| donatien | 0:632c9925f013 | 84 | template<class T> |
| donatien | 0:632c9925f013 | 85 | //Linker bug : Must be defined here :( |
| donatien | 0:632c9925f013 | 86 | void setOnEvent( T* pItem, void (T::*pMethod)(NetTcpSocketEvent) ) |
| donatien | 0:632c9925f013 | 87 | { |
| donatien | 0:632c9925f013 | 88 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:632c9925f013 | 89 | m_pCbMeth = (void (CDummy::*)(NetTcpSocketEvent)) pMethod; |
| donatien | 0:632c9925f013 | 90 | } |
| donatien | 0:632c9925f013 | 91 | |
| donatien | 0:632c9925f013 | 92 | void resetOnEvent(); //Disable callback |
| donatien | 0:632c9925f013 | 93 | |
| donatien | 0:632c9925f013 | 94 | protected: |
| donatien | 0:632c9925f013 | 95 | void queueEvent(NetTcpSocketEvent e); |
| donatien | 0:632c9925f013 | 96 | void discardEvents(); |
| donatien | 0:632c9925f013 | 97 | void flushEvents(); //to be called during polling |
| donatien | 0:632c9925f013 | 98 | |
| donatien | 0:632c9925f013 | 99 | Host m_host; |
| donatien | 0:632c9925f013 | 100 | Host m_client; |
| donatien | 0:632c9925f013 | 101 | |
| donatien | 0:632c9925f013 | 102 | friend class Net; |
| donatien | 0:632c9925f013 | 103 | int m_refs; |
| donatien | 0:632c9925f013 | 104 | |
| donatien | 0:632c9925f013 | 105 | bool m_closed; |
| donatien | 0:632c9925f013 | 106 | bool m_removed; |
| donatien | 0:632c9925f013 | 107 | |
| donatien | 0:632c9925f013 | 108 | private: |
| donatien | 0:632c9925f013 | 109 | //We do not want to execute user code in interrupt routines, so we queue events until the server is polled |
| donatien | 0:632c9925f013 | 110 | //If we port this to a multithreaded OS, we could avoid this (however some functions here are not thread-safe, so beware ;) ) |
| donatien | 0:632c9925f013 | 111 | void onEvent(NetTcpSocketEvent e); //To be called on poll |
| donatien | 0:632c9925f013 | 112 | CDummy* m_pCbItem; |
| donatien | 0:632c9925f013 | 113 | void (CDummy::*m_pCbMeth)(NetTcpSocketEvent); |
| donatien | 0:632c9925f013 | 114 | queue<NetTcpSocketEvent> m_events; |
| donatien | 0:632c9925f013 | 115 | |
| donatien | 0:632c9925f013 | 116 | }; |
| donatien | 0:632c9925f013 | 117 | |
| donatien | 0:632c9925f013 | 118 | #endif |