Amruta S / EthernetNetIf

AmrRT

Dependents:   LPC1768_AppBoard_Internet_LCD_Clock

Fork of EthernetNetIf by Donatien Garnier

LPC2368/api/UDPSocket.h@6:01cb5a40de7d, 2014-02-13 (annotated)

Committer:
joinamruta
Date:
Thu Feb 13 10:13:38 2014 +0000
Revision:
6:01cb5a40de7d
Parent:
5:bc7df6da7589 
Increased EthernetNetIf  setup() function default time out value

Who changed what in which revision?

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