NXP fan (in Japan) / Mbed 2 deprecated TwitterExample_Japanese

japanese tweeting sample with newer version libraries

Dependencies:   TextLCD mbed

EthernetNetIf/LPC2368/api/UDPSocket.h@1:57304b082776, 2012-08-31 (annotated)

Committer:
nxpfan
Date:
Fri Aug 31 08:29:07 2012 +0000
Revision:
1:57304b082776
Parent:
0:66c7c9c4f765 
mbed-lib has been updated also

Who changed what in which revision?

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