Rik Van Dyck / Mbed 2 deprecated Project_Embedded_C

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed DS1307 Servo TextLCD

NetServices/if/net/netudpsocket.h@2:55b6fd49b738, 2014-12-18 (annotated)

Committer:
rikvandyck
Date:
Thu Dec 18 10:43:07 2014 +0000
Revision:
2:55b6fd49b738
Parent:
0:e1edd52b1ee2 
Project_Embedded_C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rikvandyck 0:e1edd52b1ee2 1
rikvandyck 0:e1edd52b1ee2 2 /*
rikvandyck 0:e1edd52b1ee2 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
rikvandyck 0:e1edd52b1ee2 4
rikvandyck 0:e1edd52b1ee2 5 Permission is hereby granted, free of charge, to any person obtaining a copy
rikvandyck 0:e1edd52b1ee2 6 of this software and associated documentation files (the "Software"), to deal
rikvandyck 0:e1edd52b1ee2 7 in the Software without restriction, including without limitation the rights
rikvandyck 0:e1edd52b1ee2 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
rikvandyck 0:e1edd52b1ee2 9 copies of the Software, and to permit persons to whom the Software is
rikvandyck 0:e1edd52b1ee2 10 furnished to do so, subject to the following conditions:
rikvandyck 0:e1edd52b1ee2 11
rikvandyck 0:e1edd52b1ee2 12 The above copyright notice and this permission notice shall be included in
rikvandyck 0:e1edd52b1ee2 13 all copies or substantial portions of the Software.
rikvandyck 0:e1edd52b1ee2 14
rikvandyck 0:e1edd52b1ee2 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
rikvandyck 0:e1edd52b1ee2 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
rikvandyck 0:e1edd52b1ee2 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
rikvandyck 0:e1edd52b1ee2 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
rikvandyck 0:e1edd52b1ee2 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
rikvandyck 0:e1edd52b1ee2 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
rikvandyck 0:e1edd52b1ee2 21 THE SOFTWARE.
rikvandyck 0:e1edd52b1ee2 22 */
rikvandyck 0:e1edd52b1ee2 23
rikvandyck 0:e1edd52b1ee2 24 #ifndef NETUDPSOCKET_H
rikvandyck 0:e1edd52b1ee2 25 #define NETUDPSOCKET_H
rikvandyck 0:e1edd52b1ee2 26
rikvandyck 0:e1edd52b1ee2 27 #include "net.h"
rikvandyck 0:e1edd52b1ee2 28 #include "host.h"
rikvandyck 0:e1edd52b1ee2 29
rikvandyck 0:e1edd52b1ee2 30 #include <queue>
rikvandyck 0:e1edd52b1ee2 31 using std::queue;
rikvandyck 0:e1edd52b1ee2 32
rikvandyck 0:e1edd52b1ee2 33 //Implements a Berkeley-like socket if
rikvandyck 0:e1edd52b1ee2 34 //Can be interfaced either to lwip or a Telit module
rikvandyck 0:e1edd52b1ee2 35
rikvandyck 0:e1edd52b1ee2 36 enum NetUdpSocketErr
rikvandyck 0:e1edd52b1ee2 37 {
rikvandyck 0:e1edd52b1ee2 38 __NETUDPSOCKET_MIN = -0xFFFF,
rikvandyck 0:e1edd52b1ee2 39 NETUDPSOCKET_SETUP, //NetUdpSocket not properly configured
rikvandyck 0:e1edd52b1ee2 40 NETUDPSOCKET_IF, //If has problems
rikvandyck 0:e1edd52b1ee2 41 NETUDPSOCKET_MEM, //Not enough mem
rikvandyck 0:e1edd52b1ee2 42 NETUDPSOCKET_INUSE, //If/Port is in use
rikvandyck 0:e1edd52b1ee2 43 //...
rikvandyck 0:e1edd52b1ee2 44 NETUDPSOCKET_OK = 0
rikvandyck 0:e1edd52b1ee2 45 };
rikvandyck 0:e1edd52b1ee2 46
rikvandyck 0:e1edd52b1ee2 47 enum NetUdpSocketEvent //Only one lonely event here... but who knows, maybe some day there'll be another one!
rikvandyck 0:e1edd52b1ee2 48 {
rikvandyck 0:e1edd52b1ee2 49 NETUDPSOCKET_READABLE, //Data in buf
rikvandyck 0:e1edd52b1ee2 50 };
rikvandyck 0:e1edd52b1ee2 51
rikvandyck 0:e1edd52b1ee2 52
rikvandyck 0:e1edd52b1ee2 53 class NetUdpSocket
rikvandyck 0:e1edd52b1ee2 54 {
rikvandyck 0:e1edd52b1ee2 55 public:
rikvandyck 0:e1edd52b1ee2 56 NetUdpSocket();
rikvandyck 0:e1edd52b1ee2 57 virtual ~NetUdpSocket(); //close()
rikvandyck 0:e1edd52b1ee2 58
rikvandyck 0:e1edd52b1ee2 59 virtual NetUdpSocketErr bind(const Host& me) = 0;
rikvandyck 0:e1edd52b1ee2 60
rikvandyck 0:e1edd52b1ee2 61 virtual int /*if < 0 : NetUdpSocketErr*/ sendto(const char* buf, int len, Host* pHost) = 0;
rikvandyck 0:e1edd52b1ee2 62 virtual int /*if < 0 : NetUdpSocketErr*/ recvfrom(char* buf, int len, Host* pHost) = 0;
rikvandyck 0:e1edd52b1ee2 63
rikvandyck 0:e1edd52b1ee2 64 /* TODO NTH : printf / scanf helpers that call send/recv */
rikvandyck 0:e1edd52b1ee2 65
rikvandyck 0:e1edd52b1ee2 66 virtual NetUdpSocketErr close() = 0;
rikvandyck 0:e1edd52b1ee2 67
rikvandyck 0:e1edd52b1ee2 68 virtual NetUdpSocketErr poll() = 0;
rikvandyck 0:e1edd52b1ee2 69
rikvandyck 0:e1edd52b1ee2 70 class CDummy;
rikvandyck 0:e1edd52b1ee2 71 //Callbacks
rikvandyck 0:e1edd52b1ee2 72 template<class T>
rikvandyck 0:e1edd52b1ee2 73 //Linker bug : Must be defined here :(
rikvandyck 0:e1edd52b1ee2 74 void setOnEvent( T* pItem, void (T::*pMethod)(NetUdpSocketEvent) )
rikvandyck 0:e1edd52b1ee2 75 {
rikvandyck 0:e1edd52b1ee2 76 m_pCbItem = (CDummy*) pItem;
rikvandyck 0:e1edd52b1ee2 77 m_pCbMeth = (void (CDummy::*)(NetUdpSocketEvent)) pMethod;
rikvandyck 0:e1edd52b1ee2 78 }
rikvandyck 0:e1edd52b1ee2 79
rikvandyck 0:e1edd52b1ee2 80 void resetOnEvent(); //Disable callback
rikvandyck 0:e1edd52b1ee2 81
rikvandyck 0:e1edd52b1ee2 82 protected:
rikvandyck 0:e1edd52b1ee2 83 void queueEvent(NetUdpSocketEvent e);
rikvandyck 0:e1edd52b1ee2 84 void discardEvents();
rikvandyck 0:e1edd52b1ee2 85 void flushEvents(); //to be called during polling
rikvandyck 0:e1edd52b1ee2 86
rikvandyck 0:e1edd52b1ee2 87 Host m_host;
rikvandyck 0:e1edd52b1ee2 88 Host m_client;
rikvandyck 0:e1edd52b1ee2 89
rikvandyck 0:e1edd52b1ee2 90 friend class Net;
rikvandyck 0:e1edd52b1ee2 91 int m_refs;
rikvandyck 0:e1edd52b1ee2 92
rikvandyck 0:e1edd52b1ee2 93 bool m_closed;
rikvandyck 0:e1edd52b1ee2 94 bool m_removed;
rikvandyck 0:e1edd52b1ee2 95
rikvandyck 0:e1edd52b1ee2 96 private:
rikvandyck 0:e1edd52b1ee2 97 //We do not want to execute user code in interrupt routines, so we queue events until the server is polled
rikvandyck 0:e1edd52b1ee2 98 //If we port this to a multithreaded OS, we could avoid this (however some functions here are not thread-safe, so beware ;) )
rikvandyck 0:e1edd52b1ee2 99 void onEvent(NetUdpSocketEvent e); //To be called on poll
rikvandyck 0:e1edd52b1ee2 100 CDummy* m_pCbItem;
rikvandyck 0:e1edd52b1ee2 101 void (CDummy::*m_pCbMeth)(NetUdpSocketEvent);
rikvandyck 0:e1edd52b1ee2 102 queue<NetUdpSocketEvent> m_events;
rikvandyck 0:e1edd52b1ee2 103
rikvandyck 0:e1edd52b1ee2 104 };
rikvandyck 0:e1edd52b1ee2 105
rikvandyck 0:e1edd52b1ee2 106 #endif