Atsushi Hattori / Mbed 2 deprecated 20210627_Logger

hattori&ide

Dependencies:   mbed

TinyHTTP/EthernetNetIf/LPC1768/api/UDPSocket.h@0:f77369cabd75, 18 months ago (annotated)

Committer:
hattori_atsushi
Date:
Sun Dec 18 08:16:01 2022 +0000
Revision:
0:f77369cabd75
hattori

Who changed what in which revision?

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