Jeff Mourich / EthernetNetIf_ChangeHostName

ID the MBED processor on the network if you have more than one. View MBED name on DHCP of your Router - Example \"MBED PE\" Change your ID in Core / host.h

LPC2368/api/UDPSocket.h@0:fd3b85615428, 2010-11-06 (annotated)

Committer:
JeffM
Date:
Sat Nov 06 14:11:02 2010 +0000
Revision:
0:fd3b85615428
MBED ID 1A

Who changed what in which revision?

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