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/api/UDPSocket.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 /** \file
Michael J. Spencer 1:f5ac63519541 25 UDP Socket header file
Michael J. Spencer 1:f5ac63519541 26 */
Michael J. Spencer 1:f5ac63519541 27
Michael J. Spencer 1:f5ac63519541 28 #ifndef UDPSOCKET_H
Michael J. Spencer 1:f5ac63519541 29 #define UDPSOCKET_H
Michael J. Spencer 1:f5ac63519541 30
Michael J. Spencer 1:f5ac63519541 31 #include "core/net.h"
Michael J. Spencer 1:f5ac63519541 32 #include "core/host.h"
Michael J. Spencer 1:f5ac63519541 33 #include "netudpsocket.h"
Michael J. Spencer 1:f5ac63519541 34 //Essentially it is a safe interface to NetUdpSocket
Michael J. Spencer 1:f5ac63519541 35
Michael J. Spencer 1:f5ac63519541 36 ///UDP Socket error codes
Michael J. Spencer 1:f5ac63519541 37 enum UDPSocketErr
Michael J. Spencer 1:f5ac63519541 38 {
Michael J. Spencer 1:f5ac63519541 39 __UDPSOCKET_MIN = -0xFFFF,
Michael J. Spencer 1:f5ac63519541 40 UDPSOCKET_SETUP, ///<UDPSocket not properly configured
Michael J. Spencer 1:f5ac63519541 41 UDPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
Michael J. Spencer 1:f5ac63519541 42 UDPSOCKET_MEM, ///<Not enough mem
Michael J. Spencer 1:f5ac63519541 43 UDPSOCKET_INUSE, ///<Interface / Port is in use
Michael J. Spencer 1:f5ac63519541 44 //...
Michael J. Spencer 1:f5ac63519541 45 UDPSOCKET_OK = 0 ///<Success
Michael J. Spencer 1:f5ac63519541 46 };
Michael J. Spencer 1:f5ac63519541 47
Michael J. Spencer 1:f5ac63519541 48 ///UDP Socket Event(s)
Michael J. Spencer 1:f5ac63519541 49 enum UDPSocketEvent //Only one event here for now, but keeps that model in case we need to implement some others
Michael J. Spencer 1:f5ac63519541 50 {
Michael J. Spencer 1:f5ac63519541 51 UDPSOCKET_READABLE, ///<Data in buf
Michael J. Spencer 1:f5ac63519541 52 };
Michael J. Spencer 1:f5ac63519541 53
Michael J. Spencer 1:f5ac63519541 54 ///This is a simple UDP Socket class
Michael J. Spencer 1:f5ac63519541 55 /**
Michael J. Spencer 1:f5ac63519541 56 This class exposes an API to deal with UDP Sockets
Michael J. Spencer 1:f5ac63519541 57 */
Michael J. Spencer 1:f5ac63519541 58 class UDPSocket
Michael J. Spencer 1:f5ac63519541 59 {
Michael J. Spencer 1:f5ac63519541 60 public:
Michael J. Spencer 1:f5ac63519541 61 ///Creates a new socket
Michael J. Spencer 1:f5ac63519541 62 UDPSocket();
Michael J. Spencer 1:f5ac63519541 63
Michael J. Spencer 1:f5ac63519541 64 ///Closes and destroys socket
Michael J. Spencer 1:f5ac63519541 65 ~UDPSocket(); //close()
Michael J. Spencer 1:f5ac63519541 66
Michael J. Spencer 1:f5ac63519541 67 ///Binds the socket to local host or a multicast address
Michael J. Spencer 1:f5ac63519541 68 UDPSocketErr bind(const Host& me);
Michael J. Spencer 1:f5ac63519541 69
Michael J. Spencer 1:f5ac63519541 70 ///Sends data
Michael J. Spencer 1:f5ac63519541 71 /*
Michael J. Spencer 1:f5ac63519541 72 @param pHost : host to send data to
Michael J. Spencer 1:f5ac63519541 73 @return a negative error code or the number of bytes transmitted
Michael J. Spencer 1:f5ac63519541 74 */
Michael J. Spencer 1:f5ac63519541 75 int /*if < 0 : UDPSocketErr*/ sendto(const char* buf, int len, Host* pHost);
Michael J. Spencer 1:f5ac63519541 76
Michael J. Spencer 1:f5ac63519541 77 ///Receives data
Michael J. Spencer 1:f5ac63519541 78 /*
Michael J. Spencer 1:f5ac63519541 79 @param pHost : host from which this piece of data comes from
Michael J. Spencer 1:f5ac63519541 80 @return a negative error code or the number of bytes received
Michael J. Spencer 1:f5ac63519541 81 */
Michael J. Spencer 1:f5ac63519541 82 int /*if < 0 : UDPSocketErr*/ recvfrom(char* buf, int len, Host* pHost);
Michael J. Spencer 1:f5ac63519541 83
Michael J. Spencer 1:f5ac63519541 84 /* TODO NTH : printf / scanf helpers that call send/recv */
Michael J. Spencer 1:f5ac63519541 85
Michael J. Spencer 1:f5ac63519541 86 ///Closes socket
Michael J. Spencer 1:f5ac63519541 87 UDPSocketErr close();
Michael J. Spencer 1:f5ac63519541 88
Michael J. Spencer 1:f5ac63519541 89 //Callbacks
Michael J. Spencer 1:f5ac63519541 90 ///Setups callback
Michael J. Spencer 1:f5ac63519541 91 /**
Michael J. Spencer 1:f5ac63519541 92 @param pMethod : callback function
Michael J. Spencer 1:f5ac63519541 93 */
Michael J. Spencer 1:f5ac63519541 94 void setOnEvent( void (*pMethod)(UDPSocketEvent) );
Michael J. Spencer 1:f5ac63519541 95
Michael J. Spencer 1:f5ac63519541 96 class CDummy;
Michael J. Spencer 1:f5ac63519541 97 ///Setups callback
Michael J. Spencer 1:f5ac63519541 98 /**
Michael J. Spencer 1:f5ac63519541 99 @param pItem : instance of class on which to execute the callback method
Michael J. Spencer 1:f5ac63519541 100 @param pMethod : callback method
Michael J. Spencer 1:f5ac63519541 101 */
Michael J. Spencer 1:f5ac63519541 102 template<class T>
Michael J. Spencer 1:f5ac63519541 103 void setOnEvent( T* pItem, void (T::*pMethod)(UDPSocketEvent) )
Michael J. Spencer 1:f5ac63519541 104 {
Michael J. Spencer 1:f5ac63519541 105 m_pCbItem = (CDummy*) pItem;
Michael J. Spencer 1:f5ac63519541 106 m_pCbMeth = (void (CDummy::*)(UDPSocketEvent)) pMethod;
Michael J. Spencer 1:f5ac63519541 107 }
Michael J. Spencer 1:f5ac63519541 108
Michael J. Spencer 1:f5ac63519541 109 ///Disables callback
Michael J. Spencer 1:f5ac63519541 110 void resetOnEvent();
Michael J. Spencer 1:f5ac63519541 111
Michael J. Spencer 1:f5ac63519541 112 protected:
Michael J. Spencer 1:f5ac63519541 113 void onNetUdpSocketEvent(NetUdpSocketEvent e);
Michael J. Spencer 1:f5ac63519541 114 UDPSocketErr checkInst();
Michael J. Spencer 1:f5ac63519541 115
Michael J. Spencer 1:f5ac63519541 116 private:
Michael J. Spencer 1:f5ac63519541 117 NetUdpSocket* m_pNetUdpSocket;
Michael J. Spencer 1:f5ac63519541 118
Michael J. Spencer 1:f5ac63519541 119 CDummy* m_pCbItem;
Michael J. Spencer 1:f5ac63519541 120 void (CDummy::*m_pCbMeth)(UDPSocketEvent);
Michael J. Spencer 1:f5ac63519541 121
Michael J. Spencer 1:f5ac63519541 122 void (*m_pCb)(UDPSocketEvent);
Michael J. Spencer 1:f5ac63519541 123
Michael J. Spencer 1:f5ac63519541 124 };
Michael J. Spencer 1:f5ac63519541 125
Michael J. Spencer 1:f5ac63519541 126 #endif