FBI FRATER / Mbed 2 deprecated InetTest

Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

NetServices/api/UDPSocket.h@0:4edb816d21e1, 2015-10-16 (annotated)

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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