Richard Blimmel / Mbed 2 deprecated CIG_HTTPClient

HTTPClient using static IP

Dependencies:   mbed

NetServices/api/TCPSocket.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 TCP Socket header file
mr_q 0:d8f2f7d5f31b 26 */
mr_q 0:d8f2f7d5f31b 27
mr_q 0:d8f2f7d5f31b 28 #ifndef TCPSOCKET_H
mr_q 0:d8f2f7d5f31b 29 #define TCPSOCKET_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 NetTcpSocket
mr_q 0:d8f2f7d5f31b 34
mr_q 0:d8f2f7d5f31b 35 ///TCP Socket error codes
mr_q 0:d8f2f7d5f31b 36 enum TCPSocketErr
mr_q 0:d8f2f7d5f31b 37 {
mr_q 0:d8f2f7d5f31b 38 __TCPSOCKET_MIN = -0xFFFF,
mr_q 0:d8f2f7d5f31b 39 TCPSOCKET_SETUP, ///<TCPSocket not properly configured
mr_q 0:d8f2f7d5f31b 40 TCPSOCKET_TIMEOUT, ///<Connection timed out
mr_q 0:d8f2f7d5f31b 41 TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
mr_q 0:d8f2f7d5f31b 42 TCPSOCKET_MEM, ///<Not enough mem
mr_q 0:d8f2f7d5f31b 43 TCPSOCKET_INUSE, ///<Interface / Port is in use
mr_q 0:d8f2f7d5f31b 44 TCPSOCKET_EMPTY, ///<Connections queue is empty
mr_q 0:d8f2f7d5f31b 45 TCPSOCKET_RST, ///<Connection was reset by remote host
mr_q 0:d8f2f7d5f31b 46 //...
mr_q 0:d8f2f7d5f31b 47 TCPSOCKET_OK = 0 ///<Success
mr_q 0:d8f2f7d5f31b 48 };
mr_q 0:d8f2f7d5f31b 49
mr_q 0:d8f2f7d5f31b 50 ///TCP Socket Events
mr_q 0:d8f2f7d5f31b 51 enum TCPSocketEvent
mr_q 0:d8f2f7d5f31b 52 {
mr_q 0:d8f2f7d5f31b 53 TCPSOCKET_CONNECTED, ///<Connected to host
mr_q 0:d8f2f7d5f31b 54 TCPSOCKET_ACCEPT, ///<Client is connected, must call accept() to get a new Socket
mr_q 0:d8f2f7d5f31b 55 TCPSOCKET_READABLE, ///<Data in buf
mr_q 0:d8f2f7d5f31b 56 TCPSOCKET_WRITEABLE, ///<Can write data to buf
mr_q 0:d8f2f7d5f31b 57 TCPSOCKET_CONTIMEOUT, ///<Connection timed out
mr_q 0:d8f2f7d5f31b 58 TCPSOCKET_CONRST, ///<Connection was reset by remote host
mr_q 0:d8f2f7d5f31b 59 TCPSOCKET_CONABRT, ///<Connection was aborted
mr_q 0:d8f2f7d5f31b 60 TCPSOCKET_ERROR, ///<Unknown error
mr_q 0:d8f2f7d5f31b 61 TCPSOCKET_DISCONNECTED ///<Disconnected
mr_q 0:d8f2f7d5f31b 62 };
mr_q 0:d8f2f7d5f31b 63
mr_q 0:d8f2f7d5f31b 64 class NetTcpSocket;
mr_q 0:d8f2f7d5f31b 65 enum NetTcpSocketEvent;
mr_q 0:d8f2f7d5f31b 66
mr_q 0:d8f2f7d5f31b 67 ///This is a simple TCP Socket class
mr_q 0:d8f2f7d5f31b 68 /**
mr_q 0:d8f2f7d5f31b 69 This class exposes an API to deal with TCP Sockets
mr_q 0:d8f2f7d5f31b 70 */
mr_q 0:d8f2f7d5f31b 71 class TCPSocket
mr_q 0:d8f2f7d5f31b 72 {
mr_q 0:d8f2f7d5f31b 73 public:
mr_q 0:d8f2f7d5f31b 74 ///Creates a new socket
mr_q 0:d8f2f7d5f31b 75 TCPSocket();
mr_q 0:d8f2f7d5f31b 76 protected:
mr_q 0:d8f2f7d5f31b 77 TCPSocket(NetTcpSocket* pNetTcpSocket);
mr_q 0:d8f2f7d5f31b 78 public:
mr_q 0:d8f2f7d5f31b 79 ///Closes if needed and destroys the socket
mr_q 0:d8f2f7d5f31b 80 ~TCPSocket(); //close()
mr_q 0:d8f2f7d5f31b 81
mr_q 0:d8f2f7d5f31b 82 ///Binds the socket to (local) host
mr_q 0:d8f2f7d5f31b 83 TCPSocketErr bind(const Host& me);
mr_q 0:d8f2f7d5f31b 84
mr_q 0:d8f2f7d5f31b 85 ///Starts listening
mr_q 0:d8f2f7d5f31b 86 TCPSocketErr listen();
mr_q 0:d8f2f7d5f31b 87
mr_q 0:d8f2f7d5f31b 88 ///Connects socket to host
mr_q 0:d8f2f7d5f31b 89 TCPSocketErr connect(const Host& host);
mr_q 0:d8f2f7d5f31b 90
mr_q 0:d8f2f7d5f31b 91 ///Accepts connection from client and gets connected socket
mr_q 0:d8f2f7d5f31b 92 TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket);
mr_q 0:d8f2f7d5f31b 93
mr_q 0:d8f2f7d5f31b 94 ///Sends data
mr_q 0:d8f2f7d5f31b 95 /*
mr_q 0:d8f2f7d5f31b 96 @return a negative error code or the number of bytes transmitted
mr_q 0:d8f2f7d5f31b 97 */
mr_q 0:d8f2f7d5f31b 98 int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len);
mr_q 0:d8f2f7d5f31b 99
mr_q 0:d8f2f7d5f31b 100 ///Receives data
mr_q 0:d8f2f7d5f31b 101 /*
mr_q 0:d8f2f7d5f31b 102 @return a negative error code or the number of bytes received
mr_q 0:d8f2f7d5f31b 103 */
mr_q 0:d8f2f7d5f31b 104 int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len);
mr_q 0:d8f2f7d5f31b 105
mr_q 0:d8f2f7d5f31b 106 /* TODO NTH : printf / scanf helpers that call send/recv */
mr_q 0:d8f2f7d5f31b 107
mr_q 0:d8f2f7d5f31b 108 ///Closes socket
mr_q 0:d8f2f7d5f31b 109 TCPSocketErr close();
mr_q 0:d8f2f7d5f31b 110
mr_q 0:d8f2f7d5f31b 111 //Callbacks
mr_q 0:d8f2f7d5f31b 112 ///Setups callback
mr_q 0:d8f2f7d5f31b 113 /**
mr_q 0:d8f2f7d5f31b 114 @param pMethod : callback function
mr_q 0:d8f2f7d5f31b 115 */
mr_q 0:d8f2f7d5f31b 116 void setOnEvent( void (*pMethod)(TCPSocketEvent) );
mr_q 0:d8f2f7d5f31b 117
mr_q 0:d8f2f7d5f31b 118 class CDummy;
mr_q 0:d8f2f7d5f31b 119 ///Setups callback
mr_q 0:d8f2f7d5f31b 120 /**
mr_q 0:d8f2f7d5f31b 121 @param pItem : instance of class on which to execute the callback method
mr_q 0:d8f2f7d5f31b 122 @param pMethod : callback method
mr_q 0:d8f2f7d5f31b 123 */
mr_q 0:d8f2f7d5f31b 124 template<class T>
mr_q 0:d8f2f7d5f31b 125 void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) )
mr_q 0:d8f2f7d5f31b 126 {
mr_q 0:d8f2f7d5f31b 127 m_pCbItem = (CDummy*) pItem;
mr_q 0:d8f2f7d5f31b 128 m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod;
mr_q 0:d8f2f7d5f31b 129 }
mr_q 0:d8f2f7d5f31b 130
mr_q 0:d8f2f7d5f31b 131 ///Disables callback
mr_q 0:d8f2f7d5f31b 132 void resetOnEvent();
mr_q 0:d8f2f7d5f31b 133
mr_q 0:d8f2f7d5f31b 134 protected:
mr_q 0:d8f2f7d5f31b 135 void onNetTcpSocketEvent(NetTcpSocketEvent e);
mr_q 0:d8f2f7d5f31b 136 TCPSocketErr checkInst();
mr_q 0:d8f2f7d5f31b 137
mr_q 0:d8f2f7d5f31b 138 private:
mr_q 0:d8f2f7d5f31b 139 NetTcpSocket* m_pNetTcpSocket;
mr_q 0:d8f2f7d5f31b 140
mr_q 0:d8f2f7d5f31b 141 CDummy* m_pCbItem;
mr_q 0:d8f2f7d5f31b 142 void (CDummy::*m_pCbMeth)(TCPSocketEvent);
mr_q 0:d8f2f7d5f31b 143
mr_q 0:d8f2f7d5f31b 144 void (*m_pCb)(TCPSocketEvent);
mr_q 0:d8f2f7d5f31b 145
mr_q 0:d8f2f7d5f31b 146 };
mr_q 0:d8f2f7d5f31b 147
mr_q 0:d8f2f7d5f31b 148 #endif