Richard Blimmel / Mbed 2 deprecated CIG_HTTPClient

HTTPClient using static IP

Dependencies:   mbed

NetServices/api/UDPSocket.h@0:d8f2f7d5f31b, 2011-05-30 (annotated)

Committer:
mr_q
Date:
Mon May 30 11:53:37 2011 +0000
Revision:
0:d8f2f7d5f31b
v0.01 Draft

Who changed what in which revision?

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