Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Berckvens Michiel & Basteyns Jonas

Dependencies:   DS1307 TextLCD mbed

NetServices/api/UDPSocket.h@5:6878defcfeb9, 2014-12-11 (annotated)

Committer:
Michielber
Date:
Thu Dec 11 16:07:34 2014 +0000
Revision:
5:6878defcfeb9
Parent:
0:f615d151a72c 
Project updated belastingslijn

Who changed what in which revision?

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