Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

api/UDPSocket.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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