Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/api/UDPSocket.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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