Donatien Garnier
ZG2100 Network interface source
api/UDPSocket.h@0:b802fc31f1db, 2010-07-09 (annotated)
- Committer:
- donatien
- Date:
- Fri Jul 09 15:37:23 2010 +0000
- Revision:
- 0:b802fc31f1db
- Child:
- 1:3a7c15057192
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:b802fc31f1db | 1 | |
| donatien | 0:b802fc31f1db | 2 | /* |
| donatien | 0:b802fc31f1db | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:b802fc31f1db | 4 | |
| donatien | 0:b802fc31f1db | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:b802fc31f1db | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:b802fc31f1db | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:b802fc31f1db | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:b802fc31f1db | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:b802fc31f1db | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:b802fc31f1db | 11 | |
| donatien | 0:b802fc31f1db | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:b802fc31f1db | 13 | all copies or substantial portions of the Software. |
| donatien | 0:b802fc31f1db | 14 | |
| donatien | 0:b802fc31f1db | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:b802fc31f1db | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:b802fc31f1db | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:b802fc31f1db | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:b802fc31f1db | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:b802fc31f1db | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:b802fc31f1db | 21 | THE SOFTWARE. |
| donatien | 0:b802fc31f1db | 22 | */ |
| donatien | 0:b802fc31f1db | 23 | |
| donatien | 0:b802fc31f1db | 24 | #ifndef UDPSOCKET_H |
| donatien | 0:b802fc31f1db | 25 | #define UDPSOCKET_H |
| donatien | 0:b802fc31f1db | 26 | |
| donatien | 0:b802fc31f1db | 27 | #include "if/net/net.h" |
| donatien | 0:b802fc31f1db | 28 | //Essentially it is a safe interface to NetUdpSocket |
| donatien | 0:b802fc31f1db | 29 | |
| donatien | 0:b802fc31f1db | 30 | enum UDPSocketErr |
| donatien | 0:b802fc31f1db | 31 | { |
| donatien | 0:b802fc31f1db | 32 | __UDPSOCKET_MIN = -0xFFFF, |
| donatien | 0:b802fc31f1db | 33 | UDPSOCKET_SETUP, //NetUdpSocket not properly configured |
| donatien | 0:b802fc31f1db | 34 | UDPSOCKET_IF, //If has problems, does not exist or is not initialized |
| donatien | 0:b802fc31f1db | 35 | UDPSOCKET_MEM, //Not enough mem |
| donatien | 0:b802fc31f1db | 36 | UDPSOCKET_INUSE, //If/Port is in use |
| donatien | 0:b802fc31f1db | 37 | //... |
| donatien | 0:b802fc31f1db | 38 | UDPSOCKET_OK = 0 |
| donatien | 0:b802fc31f1db | 39 | }; |
| donatien | 0:b802fc31f1db | 40 | |
| donatien | 0:b802fc31f1db | 41 | enum UDPSocketEvent //Only one lonely event here... but who knows, maybe some day there'll be another one! |
| donatien | 0:b802fc31f1db | 42 | { |
| donatien | 0:b802fc31f1db | 43 | UDPSOCKET_READABLE, //Data in buf |
| donatien | 0:b802fc31f1db | 44 | }; |
| donatien | 0:b802fc31f1db | 45 | |
| donatien | 0:b802fc31f1db | 46 | |
| donatien | 0:b802fc31f1db | 47 | class UDPSocket |
| donatien | 0:b802fc31f1db | 48 | { |
| donatien | 0:b802fc31f1db | 49 | public: |
| donatien | 0:b802fc31f1db | 50 | UDPSocket(); |
| donatien | 0:b802fc31f1db | 51 | ~UDPSocket(); //close() |
| donatien | 0:b802fc31f1db | 52 | |
| donatien | 0:b802fc31f1db | 53 | UDPSocketErr bind(const Host& me); |
| donatien | 0:b802fc31f1db | 54 | |
| donatien | 0:b802fc31f1db | 55 | int /*if < 0 : UDPSocketErr*/ sendto(const char* buf, int len, Host* pHost); |
| donatien | 0:b802fc31f1db | 56 | int /*if < 0 : UDPSocketErr*/ recvfrom(char* buf, int len, Host* pHost); |
| donatien | 0:b802fc31f1db | 57 | |
| donatien | 0:b802fc31f1db | 58 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| donatien | 0:b802fc31f1db | 59 | |
| donatien | 0:b802fc31f1db | 60 | UDPSocketErr close(); |
| donatien | 0:b802fc31f1db | 61 | |
| donatien | 0:b802fc31f1db | 62 | class CDummy; |
| donatien | 0:b802fc31f1db | 63 | //Callbacks |
| donatien | 0:b802fc31f1db | 64 | void setOnEvent( void (*pMethod)(UDPSocketEvent) ); |
| donatien | 0:b802fc31f1db | 65 | template<class T> |
| donatien | 0:b802fc31f1db | 66 | void setOnEvent( T* pItem, void (T::*pMethod)(UDPSocketEvent) ) |
| donatien | 0:b802fc31f1db | 67 | { |
| donatien | 0:b802fc31f1db | 68 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:b802fc31f1db | 69 | m_pCbMeth = (void (CDummy::*)(UDPSocketEvent)) pMethod; |
| donatien | 0:b802fc31f1db | 70 | } |
| donatien | 0:b802fc31f1db | 71 | |
| donatien | 0:b802fc31f1db | 72 | void resetOnEvent(); //Disable callback |
| donatien | 0:b802fc31f1db | 73 | |
| donatien | 0:b802fc31f1db | 74 | protected: |
| donatien | 0:b802fc31f1db | 75 | void onNetUdpSocketEvent(NetUdpSocketEvent e); |
| donatien | 0:b802fc31f1db | 76 | UDPSocketErr checkInst(); |
| donatien | 0:b802fc31f1db | 77 | |
| donatien | 0:b802fc31f1db | 78 | private: |
| donatien | 0:b802fc31f1db | 79 | NetUdpSocket* m_pNetUdpSocket; |
| donatien | 0:b802fc31f1db | 80 | |
| donatien | 0:b802fc31f1db | 81 | CDummy* m_pCbItem; |
| donatien | 0:b802fc31f1db | 82 | void (CDummy::*m_pCbMeth)(UDPSocketEvent); |
| donatien | 0:b802fc31f1db | 83 | |
| donatien | 0:b802fc31f1db | 84 | void (*m_pCb)(UDPSocketEvent); |
| donatien | 0:b802fc31f1db | 85 | |
| donatien | 0:b802fc31f1db | 86 | }; |
| donatien | 0:b802fc31f1db | 87 | |
| donatien | 0:b802fc31f1db | 88 | #endif |