Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Berckvens Michiel & Basteyns Jonas

Dependencies:   DS1307 TextLCD mbed

NetServices/api/TCPSocket.h@5:6878defcfeb9, 2014-12-11 (annotated)

Committer:
Michielber
Date:
Thu Dec 11 16:07:34 2014 +0000
Revision:
5:6878defcfeb9
Parent:
0:f615d151a72c 
Project updated belastingslijn

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michielber 0:f615d151a72c 1
Michielber 0:f615d151a72c 2 /*
Michielber 0:f615d151a72c 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michielber 0:f615d151a72c 4
Michielber 0:f615d151a72c 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michielber 0:f615d151a72c 6 of this software and associated documentation files (the "Software"), to deal
Michielber 0:f615d151a72c 7 in the Software without restriction, including without limitation the rights
Michielber 0:f615d151a72c 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michielber 0:f615d151a72c 9 copies of the Software, and to permit persons to whom the Software is
Michielber 0:f615d151a72c 10 furnished to do so, subject to the following conditions:
Michielber 0:f615d151a72c 11
Michielber 0:f615d151a72c 12 The above copyright notice and this permission notice shall be included in
Michielber 0:f615d151a72c 13 all copies or substantial portions of the Software.
Michielber 0:f615d151a72c 14
Michielber 0:f615d151a72c 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michielber 0:f615d151a72c 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michielber 0:f615d151a72c 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michielber 0:f615d151a72c 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michielber 0:f615d151a72c 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michielber 0:f615d151a72c 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michielber 0:f615d151a72c 21 THE SOFTWARE.
Michielber 0:f615d151a72c 22 */
Michielber 0:f615d151a72c 23
Michielber 0:f615d151a72c 24 /** \file
Michielber 0:f615d151a72c 25 TCP Socket header file
Michielber 0:f615d151a72c 26 */
Michielber 0:f615d151a72c 27
Michielber 0:f615d151a72c 28 #ifndef TCPSOCKET_H
Michielber 0:f615d151a72c 29 #define TCPSOCKET_H
Michielber 0:f615d151a72c 30
Michielber 0:f615d151a72c 31 #include "core/net.h"
Michielber 0:f615d151a72c 32 #include "core/host.h"
Michielber 0:f615d151a72c 33 //Essentially it is a safe interface to NetTcpSocket
Michielber 0:f615d151a72c 34
Michielber 0:f615d151a72c 35 ///TCP Socket error codes
Michielber 0:f615d151a72c 36 enum TCPSocketErr
Michielber 0:f615d151a72c 37 {
Michielber 0:f615d151a72c 38 __TCPSOCKET_MIN = -0xFFFF,
Michielber 0:f615d151a72c 39 TCPSOCKET_SETUP, ///<TCPSocket not properly configured
Michielber 0:f615d151a72c 40 TCPSOCKET_TIMEOUT, ///<Connection timed out
Michielber 0:f615d151a72c 41 TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized
Michielber 0:f615d151a72c 42 TCPSOCKET_MEM, ///<Not enough mem
Michielber 0:f615d151a72c 43 TCPSOCKET_INUSE, ///<Interface / Port is in use
Michielber 0:f615d151a72c 44 TCPSOCKET_EMPTY, ///<Connections queue is empty
Michielber 0:f615d151a72c 45 TCPSOCKET_RST, ///<Connection was reset by remote host
Michielber 0:f615d151a72c 46 //...
Michielber 0:f615d151a72c 47 TCPSOCKET_OK = 0 ///<Success
Michielber 0:f615d151a72c 48 };
Michielber 0:f615d151a72c 49
Michielber 0:f615d151a72c 50 ///TCP Socket Events
Michielber 0:f615d151a72c 51 enum TCPSocketEvent
Michielber 0:f615d151a72c 52 {
Michielber 0:f615d151a72c 53 TCPSOCKET_CONNECTED, ///<Connected to host
Michielber 0:f615d151a72c 54 TCPSOCKET_ACCEPT, ///<Client is connected, must call accept() to get a new Socket
Michielber 0:f615d151a72c 55 TCPSOCKET_READABLE, ///<Data in buf
Michielber 0:f615d151a72c 56 TCPSOCKET_WRITEABLE, ///<Can write data to buf
Michielber 0:f615d151a72c 57 TCPSOCKET_CONTIMEOUT, ///<Connection timed out
Michielber 0:f615d151a72c 58 TCPSOCKET_CONRST, ///<Connection was reset by remote host
Michielber 0:f615d151a72c 59 TCPSOCKET_CONABRT, ///<Connection was aborted
Michielber 0:f615d151a72c 60 TCPSOCKET_ERROR, ///<Unknown error
Michielber 0:f615d151a72c 61 TCPSOCKET_DISCONNECTED ///<Disconnected
Michielber 0:f615d151a72c 62 };
Michielber 0:f615d151a72c 63
Michielber 0:f615d151a72c 64 class NetTcpSocket;
Michielber 0:f615d151a72c 65 enum NetTcpSocketEvent;
Michielber 0:f615d151a72c 66
Michielber 0:f615d151a72c 67 ///This is a simple TCP Socket class
Michielber 0:f615d151a72c 68 /**
Michielber 0:f615d151a72c 69 This class exposes an API to deal with TCP Sockets
Michielber 0:f615d151a72c 70 */
Michielber 0:f615d151a72c 71 class TCPSocket
Michielber 0:f615d151a72c 72 {
Michielber 0:f615d151a72c 73 public:
Michielber 0:f615d151a72c 74 ///Creates a new socket
Michielber 0:f615d151a72c 75 TCPSocket();
Michielber 0:f615d151a72c 76 protected:
Michielber 0:f615d151a72c 77 TCPSocket(NetTcpSocket* pNetTcpSocket);
Michielber 0:f615d151a72c 78 public:
Michielber 0:f615d151a72c 79 ///Closes if needed and destroys the socket
Michielber 0:f615d151a72c 80 ~TCPSocket(); //close()
Michielber 0:f615d151a72c 81
Michielber 0:f615d151a72c 82 ///Binds the socket to (local) host
Michielber 0:f615d151a72c 83 TCPSocketErr bind(const Host& me);
Michielber 0:f615d151a72c 84
Michielber 0:f615d151a72c 85 ///Starts listening
Michielber 0:f615d151a72c 86 TCPSocketErr listen();
Michielber 0:f615d151a72c 87
Michielber 0:f615d151a72c 88 ///Connects socket to host
Michielber 0:f615d151a72c 89 TCPSocketErr connect(const Host& host);
Michielber 0:f615d151a72c 90
Michielber 0:f615d151a72c 91 ///Accepts connection from client and gets connected socket
Michielber 0:f615d151a72c 92 TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket);
Michielber 0:f615d151a72c 93
Michielber 0:f615d151a72c 94 ///Sends data
Michielber 0:f615d151a72c 95 /*
Michielber 0:f615d151a72c 96 @return a negative error code or the number of bytes transmitted
Michielber 0:f615d151a72c 97 */
Michielber 0:f615d151a72c 98 int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len);
Michielber 0:f615d151a72c 99
Michielber 0:f615d151a72c 100 ///Receives data
Michielber 0:f615d151a72c 101 /*
Michielber 0:f615d151a72c 102 @return a negative error code or the number of bytes received
Michielber 0:f615d151a72c 103 */
Michielber 0:f615d151a72c 104 int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len);
Michielber 0:f615d151a72c 105
Michielber 0:f615d151a72c 106 /* TODO NTH : printf / scanf helpers that call send/recv */
Michielber 0:f615d151a72c 107
Michielber 0:f615d151a72c 108 ///Closes socket
Michielber 0:f615d151a72c 109 TCPSocketErr close();
Michielber 0:f615d151a72c 110
Michielber 0:f615d151a72c 111 //Callbacks
Michielber 0:f615d151a72c 112 ///Setups callback
Michielber 0:f615d151a72c 113 /**
Michielber 0:f615d151a72c 114 @param pMethod : callback function
Michielber 0:f615d151a72c 115 */
Michielber 0:f615d151a72c 116 void setOnEvent( void (*pMethod)(TCPSocketEvent) );
Michielber 0:f615d151a72c 117
Michielber 0:f615d151a72c 118 class CDummy;
Michielber 0:f615d151a72c 119 ///Setups callback
Michielber 0:f615d151a72c 120 /**
Michielber 0:f615d151a72c 121 @param pItem : instance of class on which to execute the callback method
Michielber 0:f615d151a72c 122 @param pMethod : callback method
Michielber 0:f615d151a72c 123 */
Michielber 0:f615d151a72c 124 template<class T>
Michielber 0:f615d151a72c 125 void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) )
Michielber 0:f615d151a72c 126 {
Michielber 0:f615d151a72c 127 m_pCbItem = (CDummy*) pItem;
Michielber 0:f615d151a72c 128 m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod;
Michielber 0:f615d151a72c 129 }
Michielber 0:f615d151a72c 130
Michielber 0:f615d151a72c 131 ///Disables callback
Michielber 0:f615d151a72c 132 void resetOnEvent();
Michielber 0:f615d151a72c 133
Michielber 0:f615d151a72c 134 protected:
Michielber 0:f615d151a72c 135 void onNetTcpSocketEvent(NetTcpSocketEvent e);
Michielber 0:f615d151a72c 136 TCPSocketErr checkInst();
Michielber 0:f615d151a72c 137
Michielber 0:f615d151a72c 138 private:
Michielber 0:f615d151a72c 139 NetTcpSocket* m_pNetTcpSocket;
Michielber 0:f615d151a72c 140
Michielber 0:f615d151a72c 141 CDummy* m_pCbItem;
Michielber 0:f615d151a72c 142 void (CDummy::*m_pCbMeth)(TCPSocketEvent);
Michielber 0:f615d151a72c 143
Michielber 0:f615d151a72c 144 void (*m_pCb)(TCPSocketEvent);
Michielber 0:f615d151a72c 145
Michielber 0:f615d151a72c 146 };
Michielber 0:f615d151a72c 147
Michielber 0:f615d151a72c 148 #endif