Derek Fukumori
/
NetworkAnimator
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.
EthernetNetIf/LPC2368/api/UDPSocket.h@0:b6a536e40b5d, 2012-06-20 (annotated)
- Committer:
- dfukumori
- Date:
- Wed Jun 20 22:16:31 2012 +0000
- Revision:
- 0:b6a536e40b5d
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| dfukumori | 0:b6a536e40b5d | 1 | |
| dfukumori | 0:b6a536e40b5d | 2 | /* |
| dfukumori | 0:b6a536e40b5d | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| dfukumori | 0:b6a536e40b5d | 4 | |
| dfukumori | 0:b6a536e40b5d | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| dfukumori | 0:b6a536e40b5d | 6 | of this software and associated documentation files (the "Software"), to deal |
| dfukumori | 0:b6a536e40b5d | 7 | in the Software without restriction, including without limitation the rights |
| dfukumori | 0:b6a536e40b5d | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| dfukumori | 0:b6a536e40b5d | 9 | copies of the Software, and to permit persons to whom the Software is |
| dfukumori | 0:b6a536e40b5d | 10 | furnished to do so, subject to the following conditions: |
| dfukumori | 0:b6a536e40b5d | 11 | |
| dfukumori | 0:b6a536e40b5d | 12 | The above copyright notice and this permission notice shall be included in |
| dfukumori | 0:b6a536e40b5d | 13 | all copies or substantial portions of the Software. |
| dfukumori | 0:b6a536e40b5d | 14 | |
| dfukumori | 0:b6a536e40b5d | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| dfukumori | 0:b6a536e40b5d | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| dfukumori | 0:b6a536e40b5d | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| dfukumori | 0:b6a536e40b5d | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| dfukumori | 0:b6a536e40b5d | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| dfukumori | 0:b6a536e40b5d | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| dfukumori | 0:b6a536e40b5d | 21 | THE SOFTWARE. |
| dfukumori | 0:b6a536e40b5d | 22 | */ |
| dfukumori | 0:b6a536e40b5d | 23 | |
| dfukumori | 0:b6a536e40b5d | 24 | /** \file |
| dfukumori | 0:b6a536e40b5d | 25 | UDP Socket header file |
| dfukumori | 0:b6a536e40b5d | 26 | */ |
| dfukumori | 0:b6a536e40b5d | 27 | |
| dfukumori | 0:b6a536e40b5d | 28 | #ifndef UDPSOCKET_H |
| dfukumori | 0:b6a536e40b5d | 29 | #define UDPSOCKET_H |
| dfukumori | 0:b6a536e40b5d | 30 | |
| dfukumori | 0:b6a536e40b5d | 31 | #include "core/net.h" |
| dfukumori | 0:b6a536e40b5d | 32 | #include "core/host.h" |
| dfukumori | 0:b6a536e40b5d | 33 | //Essentially it is a safe interface to NetUdpSocket |
| dfukumori | 0:b6a536e40b5d | 34 | |
| dfukumori | 0:b6a536e40b5d | 35 | ///UDP Socket error codes |
| dfukumori | 0:b6a536e40b5d | 36 | enum UDPSocketErr |
| dfukumori | 0:b6a536e40b5d | 37 | { |
| dfukumori | 0:b6a536e40b5d | 38 | __UDPSOCKET_MIN = -0xFFFF, |
| dfukumori | 0:b6a536e40b5d | 39 | UDPSOCKET_SETUP, ///<UDPSocket not properly configured |
| dfukumori | 0:b6a536e40b5d | 40 | UDPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized |
| dfukumori | 0:b6a536e40b5d | 41 | UDPSOCKET_MEM, ///<Not enough mem |
| dfukumori | 0:b6a536e40b5d | 42 | UDPSOCKET_INUSE, ///<Interface / Port is in use |
| dfukumori | 0:b6a536e40b5d | 43 | //... |
| dfukumori | 0:b6a536e40b5d | 44 | UDPSOCKET_OK = 0 ///<Success |
| dfukumori | 0:b6a536e40b5d | 45 | }; |
| dfukumori | 0:b6a536e40b5d | 46 | |
| dfukumori | 0:b6a536e40b5d | 47 | ///UDP Socket Event(s) |
| dfukumori | 0:b6a536e40b5d | 48 | enum UDPSocketEvent //Only one event here for now, but keeps that model in case we need to implement some others |
| dfukumori | 0:b6a536e40b5d | 49 | { |
| dfukumori | 0:b6a536e40b5d | 50 | UDPSOCKET_READABLE, ///<Data in buf |
| dfukumori | 0:b6a536e40b5d | 51 | }; |
| dfukumori | 0:b6a536e40b5d | 52 | |
| dfukumori | 0:b6a536e40b5d | 53 | class NetUdpSocket; |
| dfukumori | 0:b6a536e40b5d | 54 | enum NetUdpSocketEvent; |
| dfukumori | 0:b6a536e40b5d | 55 | |
| dfukumori | 0:b6a536e40b5d | 56 | ///This is a simple UDP Socket class |
| dfukumori | 0:b6a536e40b5d | 57 | /** |
| dfukumori | 0:b6a536e40b5d | 58 | This class exposes an API to deal with UDP Sockets |
| dfukumori | 0:b6a536e40b5d | 59 | */ |
| dfukumori | 0:b6a536e40b5d | 60 | class UDPSocket |
| dfukumori | 0:b6a536e40b5d | 61 | { |
| dfukumori | 0:b6a536e40b5d | 62 | public: |
| dfukumori | 0:b6a536e40b5d | 63 | ///Creates a new socket |
| dfukumori | 0:b6a536e40b5d | 64 | UDPSocket(); |
| dfukumori | 0:b6a536e40b5d | 65 | |
| dfukumori | 0:b6a536e40b5d | 66 | ///Closes and destroys socket |
| dfukumori | 0:b6a536e40b5d | 67 | ~UDPSocket(); //close() |
| dfukumori | 0:b6a536e40b5d | 68 | |
| dfukumori | 0:b6a536e40b5d | 69 | ///Binds the socket to local host or a multicast address |
| dfukumori | 0:b6a536e40b5d | 70 | UDPSocketErr bind(const Host& me); |
| dfukumori | 0:b6a536e40b5d | 71 | |
| dfukumori | 0:b6a536e40b5d | 72 | ///Sends data |
| dfukumori | 0:b6a536e40b5d | 73 | /* |
| dfukumori | 0:b6a536e40b5d | 74 | @param pHost : host to send data to |
| dfukumori | 0:b6a536e40b5d | 75 | @return a negative error code or the number of bytes transmitted |
| dfukumori | 0:b6a536e40b5d | 76 | */ |
| dfukumori | 0:b6a536e40b5d | 77 | int /*if < 0 : UDPSocketErr*/ sendto(const char* buf, int len, Host* pHost); |
| dfukumori | 0:b6a536e40b5d | 78 | |
| dfukumori | 0:b6a536e40b5d | 79 | ///Receives data |
| dfukumori | 0:b6a536e40b5d | 80 | /* |
| dfukumori | 0:b6a536e40b5d | 81 | @param pHost : host from which this piece of data comes from |
| dfukumori | 0:b6a536e40b5d | 82 | @return a negative error code or the number of bytes received |
| dfukumori | 0:b6a536e40b5d | 83 | */ |
| dfukumori | 0:b6a536e40b5d | 84 | int /*if < 0 : UDPSocketErr*/ recvfrom(char* buf, int len, Host* pHost); |
| dfukumori | 0:b6a536e40b5d | 85 | |
| dfukumori | 0:b6a536e40b5d | 86 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| dfukumori | 0:b6a536e40b5d | 87 | |
| dfukumori | 0:b6a536e40b5d | 88 | ///Closes socket |
| dfukumori | 0:b6a536e40b5d | 89 | UDPSocketErr close(); |
| dfukumori | 0:b6a536e40b5d | 90 | |
| dfukumori | 0:b6a536e40b5d | 91 | //Callbacks |
| dfukumori | 0:b6a536e40b5d | 92 | ///Setups callback |
| dfukumori | 0:b6a536e40b5d | 93 | /** |
| dfukumori | 0:b6a536e40b5d | 94 | @param pMethod : callback function |
| dfukumori | 0:b6a536e40b5d | 95 | */ |
| dfukumori | 0:b6a536e40b5d | 96 | void setOnEvent( void (*pMethod)(UDPSocketEvent) ); |
| dfukumori | 0:b6a536e40b5d | 97 | |
| dfukumori | 0:b6a536e40b5d | 98 | class CDummy; |
| dfukumori | 0:b6a536e40b5d | 99 | ///Setups callback |
| dfukumori | 0:b6a536e40b5d | 100 | /** |
| dfukumori | 0:b6a536e40b5d | 101 | @param pItem : instance of class on which to execute the callback method |
| dfukumori | 0:b6a536e40b5d | 102 | @param pMethod : callback method |
| dfukumori | 0:b6a536e40b5d | 103 | */ |
| dfukumori | 0:b6a536e40b5d | 104 | template<class T> |
| dfukumori | 0:b6a536e40b5d | 105 | void setOnEvent( T* pItem, void (T::*pMethod)(UDPSocketEvent) ) |
| dfukumori | 0:b6a536e40b5d | 106 | { |
| dfukumori | 0:b6a536e40b5d | 107 | m_pCbItem = (CDummy*) pItem; |
| dfukumori | 0:b6a536e40b5d | 108 | m_pCbMeth = (void (CDummy::*)(UDPSocketEvent)) pMethod; |
| dfukumori | 0:b6a536e40b5d | 109 | } |
| dfukumori | 0:b6a536e40b5d | 110 | |
| dfukumori | 0:b6a536e40b5d | 111 | ///Disables callback |
| dfukumori | 0:b6a536e40b5d | 112 | void resetOnEvent(); |
| dfukumori | 0:b6a536e40b5d | 113 | |
| dfukumori | 0:b6a536e40b5d | 114 | protected: |
| dfukumori | 0:b6a536e40b5d | 115 | void onNetUdpSocketEvent(NetUdpSocketEvent e); |
| dfukumori | 0:b6a536e40b5d | 116 | UDPSocketErr checkInst(); |
| dfukumori | 0:b6a536e40b5d | 117 | |
| dfukumori | 0:b6a536e40b5d | 118 | private: |
| dfukumori | 0:b6a536e40b5d | 119 | NetUdpSocket* m_pNetUdpSocket; |
| dfukumori | 0:b6a536e40b5d | 120 | |
| dfukumori | 0:b6a536e40b5d | 121 | CDummy* m_pCbItem; |
| dfukumori | 0:b6a536e40b5d | 122 | void (CDummy::*m_pCbMeth)(UDPSocketEvent); |
| dfukumori | 0:b6a536e40b5d | 123 | |
| dfukumori | 0:b6a536e40b5d | 124 | void (*m_pCb)(UDPSocketEvent); |
| dfukumori | 0:b6a536e40b5d | 125 | |
| dfukumori | 0:b6a536e40b5d | 126 | }; |
| dfukumori | 0:b6a536e40b5d | 127 | |
| dfukumori | 0:b6a536e40b5d | 128 | #endif |