takashi yamanoue / Mbed 2 deprecated XBee_API_ex2

Xbee test 2

Dependencies:   XBee mbed

LPC1768/api/UDPSocket.h@0:ffac63d6a7f0, 2012-07-21 (annotated)

Committer:
takashiyamanoue
Date:
Sat Jul 21 04:08:27 2012 +0000
Revision:
0:ffac63d6a7f0
xbee test 2

Who changed what in which revision?

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