Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
api/UDPSocket.h@8:93fa3cfc0219, 2010-07-28 (annotated)
- Committer:
- donatien
- Date:
- Wed Jul 28 12:45:32 2010 +0000
- Revision:
- 8:93fa3cfc0219
- Parent:
- 6:b7dd7cde8ad2
- Child:
- 9:c79fa4034f5b
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 | 8:93fa3cfc0219 | 24 | /** \file |
| donatien | 8:93fa3cfc0219 | 25 | UDP Socket header file |
| donatien | 8:93fa3cfc0219 | 26 | */ |
| donatien | 8:93fa3cfc0219 | 27 | |
| donatien | 0:632c9925f013 | 28 | #ifndef UDPSOCKET_H |
| donatien | 0:632c9925f013 | 29 | #define UDPSOCKET_H |
| donatien | 0:632c9925f013 | 30 | |
| donatien | 0:632c9925f013 | 31 | #include "if/net/net.h" |
| donatien | 0:632c9925f013 | 32 | //Essentially it is a safe interface to NetUdpSocket |
| donatien | 0:632c9925f013 | 33 | |
| donatien | 8:93fa3cfc0219 | 34 | ///UDP Socket error codes |
| donatien | 0:632c9925f013 | 35 | enum UDPSocketErr |
| donatien | 0:632c9925f013 | 36 | { |
| donatien | 0:632c9925f013 | 37 | __UDPSOCKET_MIN = -0xFFFF, |
| donatien | 8:93fa3cfc0219 | 38 | UDPSOCKET_SETUP, ///<UDPSocket not properly configured |
| donatien | 8:93fa3cfc0219 | 39 | UDPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized |
| donatien | 8:93fa3cfc0219 | 40 | UDPSOCKET_MEM, ///<Not enough mem |
| donatien | 8:93fa3cfc0219 | 41 | UDPSOCKET_INUSE, ///<Interface / Port is in use |
| donatien | 0:632c9925f013 | 42 | //... |
| donatien | 8:93fa3cfc0219 | 43 | UDPSOCKET_OK = 0 ///<Success |
| donatien | 0:632c9925f013 | 44 | }; |
| donatien | 0:632c9925f013 | 45 | |
| donatien | 5:dd63a1e02b1b | 46 | ///UDP Socket Event(s) |
| donatien | 8:93fa3cfc0219 | 47 | enum UDPSocketEvent //Only one event here for now, but keeps that model in case we need to implement some others |
| donatien | 0:632c9925f013 | 48 | { |
| donatien | 8:93fa3cfc0219 | 49 | UDPSOCKET_READABLE, ///<Data in buf |
| donatien | 0:632c9925f013 | 50 | }; |
| donatien | 0:632c9925f013 | 51 | |
| donatien | 5:dd63a1e02b1b | 52 | ///This is a simple UDP Socket class |
| donatien | 5:dd63a1e02b1b | 53 | /** |
| donatien | 5:dd63a1e02b1b | 54 | This class exposes an API to deal with UDP Sockets |
| donatien | 5:dd63a1e02b1b | 55 | */ |
| donatien | 0:632c9925f013 | 56 | class UDPSocket |
| donatien | 0:632c9925f013 | 57 | { |
| donatien | 0:632c9925f013 | 58 | public: |
| donatien | 5:dd63a1e02b1b | 59 | ///Creates a new socket |
| donatien | 0:632c9925f013 | 60 | UDPSocket(); |
| donatien | 6:b7dd7cde8ad2 | 61 | |
| donatien | 6:b7dd7cde8ad2 | 62 | ///Closes and destroys socket |
| donatien | 0:632c9925f013 | 63 | ~UDPSocket(); //close() |
| donatien | 0:632c9925f013 | 64 | |
| donatien | 6:b7dd7cde8ad2 | 65 | ///Binds the socket to local host or a multicast address |
| donatien | 0:632c9925f013 | 66 | UDPSocketErr bind(const Host& me); |
| donatien | 0:632c9925f013 | 67 | |
| donatien | 5:dd63a1e02b1b | 68 | ///Sends data |
| donatien | 5:dd63a1e02b1b | 69 | /* |
| donatien | 5:dd63a1e02b1b | 70 | @param pHost : host to send data to |
| donatien | 5:dd63a1e02b1b | 71 | @return a negative error code or the number of bytes transmitted |
| donatien | 5:dd63a1e02b1b | 72 | */ |
| donatien | 0:632c9925f013 | 73 | int /*if < 0 : UDPSocketErr*/ sendto(const char* buf, int len, Host* pHost); |
| donatien | 5:dd63a1e02b1b | 74 | |
| donatien | 5:dd63a1e02b1b | 75 | ///Receives data |
| donatien | 5:dd63a1e02b1b | 76 | /* |
| donatien | 5:dd63a1e02b1b | 77 | @param pHost : host from which this piece of data comes from |
| donatien | 5:dd63a1e02b1b | 78 | @return a negative error code or the number of bytes received |
| donatien | 5:dd63a1e02b1b | 79 | */ |
| donatien | 0:632c9925f013 | 80 | int /*if < 0 : UDPSocketErr*/ recvfrom(char* buf, int len, Host* pHost); |
| donatien | 0:632c9925f013 | 81 | |
| donatien | 0:632c9925f013 | 82 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| donatien | 0:632c9925f013 | 83 | |
| donatien | 5:dd63a1e02b1b | 84 | ///Closes socket |
| donatien | 0:632c9925f013 | 85 | UDPSocketErr close(); |
| donatien | 0:632c9925f013 | 86 | |
| donatien | 5:dd63a1e02b1b | 87 | //Callbacks |
| donatien | 5:dd63a1e02b1b | 88 | ///Setups callback |
| donatien | 5:dd63a1e02b1b | 89 | /** |
| donatien | 5:dd63a1e02b1b | 90 | @param pMethod : callback function |
| donatien | 5:dd63a1e02b1b | 91 | */ |
| donatien | 5:dd63a1e02b1b | 92 | void setOnEvent( void (*pMethod)(UDPSocketEvent) ); |
| donatien | 5:dd63a1e02b1b | 93 | |
| donatien | 0:632c9925f013 | 94 | class CDummy; |
| donatien | 5:dd63a1e02b1b | 95 | ///Setups callback |
| donatien | 5:dd63a1e02b1b | 96 | /** |
| donatien | 5:dd63a1e02b1b | 97 | @param pItem : instance of class on which to execute the callback method |
| donatien | 5:dd63a1e02b1b | 98 | @param pMethod : callback method |
| donatien | 5:dd63a1e02b1b | 99 | */ |
| donatien | 0:632c9925f013 | 100 | template<class T> |
| donatien | 0:632c9925f013 | 101 | void setOnEvent( T* pItem, void (T::*pMethod)(UDPSocketEvent) ) |
| donatien | 0:632c9925f013 | 102 | { |
| donatien | 0:632c9925f013 | 103 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:632c9925f013 | 104 | m_pCbMeth = (void (CDummy::*)(UDPSocketEvent)) pMethod; |
| donatien | 0:632c9925f013 | 105 | } |
| donatien | 0:632c9925f013 | 106 | |
| donatien | 5:dd63a1e02b1b | 107 | ///Disables callback |
| donatien | 5:dd63a1e02b1b | 108 | void resetOnEvent(); |
| donatien | 0:632c9925f013 | 109 | |
| donatien | 0:632c9925f013 | 110 | protected: |
| donatien | 0:632c9925f013 | 111 | void onNetUdpSocketEvent(NetUdpSocketEvent e); |
| donatien | 0:632c9925f013 | 112 | UDPSocketErr checkInst(); |
| donatien | 0:632c9925f013 | 113 | |
| donatien | 0:632c9925f013 | 114 | private: |
| donatien | 0:632c9925f013 | 115 | NetUdpSocket* m_pNetUdpSocket; |
| donatien | 0:632c9925f013 | 116 | |
| donatien | 0:632c9925f013 | 117 | CDummy* m_pCbItem; |
| donatien | 0:632c9925f013 | 118 | void (CDummy::*m_pCbMeth)(UDPSocketEvent); |
| donatien | 0:632c9925f013 | 119 | |
| donatien | 0:632c9925f013 | 120 | void (*m_pCb)(UDPSocketEvent); |
| donatien | 0:632c9925f013 | 121 | |
| donatien | 0:632c9925f013 | 122 | }; |
| donatien | 0:632c9925f013 | 123 | |
| donatien | 0:632c9925f013 | 124 | #endif |