hirifumi mikage / EthernetNetIf

EthernetNetIf

Dependents:   XBee_WiFi_EA_LPC4088

api/UDPSocket.h@0:62580107d20c, 2014-11-19 (annotated)

Committer:
hmike
Date:
Wed Nov 19 12:00:42 2014 +0000
Revision:
0:62580107d20c
EthernetNetIf

Who changed what in which revision?

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