Hendrik Lipka / NetServicesMin

Stripped down version of Segundos NetService library (http://mbed.org/users/segundo/libraries/NetServices ). I have removed all NetServices, and all functions which had been disabled. Use this version when you need only pure TCP or UDP functions - this library compiles faster.

Dependencies:   lwip lwip-sys

Dependents:   christmasLights device_server pop3demo device_server_udp ... more

api/UDPSocket.h@1:9d93f4dc2f46, 2012-07-18 (annotated)

Committer:
hlipka
Date:
Wed Jul 18 20:28:43 2012 +0000
Revision:
1:9d93f4dc2f46
Parent:
0:8b387bed54c2 
updated to the new mbed library (version 41) and the new LwIP stack. Code is still untested.

Who changed what in which revision?

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