hiroshi matsumoto / EthernetNetIf

lpc1768

api/UDPSocket.h@0:f35dada1dac1, 2015-01-27 (annotated)

Committer:
jh1cdv00
Date:
Tue Jan 27 01:38:19 2015 +0000
Revision:
0:f35dada1dac1
lpc1768

Who changed what in which revision?

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