Used in Live Traffic Update Nokia LCD Display Project

Fork of NetServices by Segundo Equipo

Committer:
segundo
Date:
Tue Nov 09 20:54:15 2010 +0000
Revision:
0:ac1725ba162c

        

Who changed what in which revision?

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