SHOHEI FUJIMOTO / Mbed 2 deprecated LineLedControl

LineLedControl

Dependencies:   LPD8806 mbed

Fork of LPD8806_Test by Jelmer Tiete

EthernetNetIf/LPC1768/api/UDPSocket.h@3:b0a1b4b24d3c, 2013-08-19 (annotated)

Committer:
sfjmt
Date:
Mon Aug 19 12:14:37 2013 +0000
Revision:
3:b0a1b4b24d3c
LPD8806 control

Who changed what in which revision?

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