Lorcan Smith / Mbed 2 deprecated Enet_SPI

SNMP agent attached to SPI slave

Dependencies:   mbed

api/UDPSocket.h@0:2a53a4c3238c, 2012-08-13 (annotated)

Committer:
lorcansmith
Date:
Mon Aug 13 15:07:40 2012 +0000
Revision:
0:2a53a4c3238c
v1.1 release includes ioAlarm traps

Who changed what in which revision?

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