Michael Spencer / Mbed 2 deprecated LaOS

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

NetServices/if/net/netudpsocket.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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