Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   DS1307 TextLCD mbed

NetServices/if/net/nettcpsocket.h@0:f615d151a72c, 2014-12-04 (annotated)

Committer:
Michielber
Date:
Thu Dec 04 10:36:40 2014 +0000
Revision:
0:f615d151a72c
Berckvens Michiel & Basteyns Jonas 4/12/2014

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 #ifndef NETTCPSOCKET_H
Michielber 0:f615d151a72c 25 #define NETTCPSOCKET_H
Michielber 0:f615d151a72c 26
Michielber 0:f615d151a72c 27 #include "net.h"
Michielber 0:f615d151a72c 28 #include "host.h"
Michielber 0:f615d151a72c 29
Michielber 0:f615d151a72c 30 #include <queue>
Michielber 0:f615d151a72c 31 using std::queue;
Michielber 0:f615d151a72c 32
Michielber 0:f615d151a72c 33 //Implements a Berkeley-like socket if
Michielber 0:f615d151a72c 34 //Can be interfaced either to lwip or a Telit module
Michielber 0:f615d151a72c 35
Michielber 0:f615d151a72c 36 enum NetTcpSocketErr
Michielber 0:f615d151a72c 37 {
Michielber 0:f615d151a72c 38 __NETTCPSOCKET_MIN = -0xFFFF,
Michielber 0:f615d151a72c 39 NETTCPSOCKET_SETUP, //NetTcpSocket not properly configured
Michielber 0:f615d151a72c 40 NETTCPSOCKET_TIMEOUT,
Michielber 0:f615d151a72c 41 NETTCPSOCKET_IF, //If has problems
Michielber 0:f615d151a72c 42 NETTCPSOCKET_MEM, //Not enough mem
Michielber 0:f615d151a72c 43 NETTCPSOCKET_INUSE, //If/Port is in use
Michielber 0:f615d151a72c 44 NETTCPSOCKET_EMPTY, //Connections queue is empty
Michielber 0:f615d151a72c 45 NETTCPSOCKET_RST, // Connection was reset by remote host
Michielber 0:f615d151a72c 46 //...
Michielber 0:f615d151a72c 47 NETTCPSOCKET_OK = 0
Michielber 0:f615d151a72c 48 };
Michielber 0:f615d151a72c 49
Michielber 0:f615d151a72c 50 enum NetTcpSocketEvent
Michielber 0:f615d151a72c 51 {
Michielber 0:f615d151a72c 52 NETTCPSOCKET_CONNECTED, //Connected to host, must call accept() if we were listening
Michielber 0:f615d151a72c 53 NETTCPSOCKET_ACCEPT, //Connected to client
Michielber 0:f615d151a72c 54 NETTCPSOCKET_READABLE, //Data in buf
Michielber 0:f615d151a72c 55 NETTCPSOCKET_WRITEABLE, //Can write data to buf
Michielber 0:f615d151a72c 56 NETTCPSOCKET_CONTIMEOUT,
Michielber 0:f615d151a72c 57 NETTCPSOCKET_CONRST,
Michielber 0:f615d151a72c 58 NETTCPSOCKET_CONABRT,
Michielber 0:f615d151a72c 59 NETTCPSOCKET_ERROR,
Michielber 0:f615d151a72c 60 NETTCPSOCKET_DISCONNECTED
Michielber 0:f615d151a72c 61 };
Michielber 0:f615d151a72c 62
Michielber 0:f615d151a72c 63
Michielber 0:f615d151a72c 64 class NetTcpSocket
Michielber 0:f615d151a72c 65 {
Michielber 0:f615d151a72c 66 public:
Michielber 0:f615d151a72c 67 NetTcpSocket();
Michielber 0:f615d151a72c 68 virtual ~NetTcpSocket(); //close()
Michielber 0:f615d151a72c 69
Michielber 0:f615d151a72c 70 virtual NetTcpSocketErr bind(const Host& me) = 0;
Michielber 0:f615d151a72c 71 virtual NetTcpSocketErr listen() = 0;
Michielber 0:f615d151a72c 72 virtual NetTcpSocketErr connect(const Host& host) = 0;
Michielber 0:f615d151a72c 73 virtual NetTcpSocketErr accept(Host* pClient, NetTcpSocket** ppNewNetTcpSocket) = 0;
Michielber 0:f615d151a72c 74
Michielber 0:f615d151a72c 75 virtual int /*if < 0 : NetTcpSocketErr*/ send(const char* buf, int len) = 0;
Michielber 0:f615d151a72c 76 virtual int /*if < 0 : NetTcpSocketErr*/ recv(char* buf, int len) = 0;
Michielber 0:f615d151a72c 77
Michielber 0:f615d151a72c 78 virtual NetTcpSocketErr close() = 0;
Michielber 0:f615d151a72c 79
Michielber 0:f615d151a72c 80 virtual NetTcpSocketErr poll() = 0;
Michielber 0:f615d151a72c 81
Michielber 0:f615d151a72c 82 class CDummy;
Michielber 0:f615d151a72c 83 //Callbacks
Michielber 0:f615d151a72c 84 template<class T>
Michielber 0:f615d151a72c 85 //Linker bug : Must be defined here :(
Michielber 0:f615d151a72c 86 void setOnEvent( T* pItem, void (T::*pMethod)(NetTcpSocketEvent) )
Michielber 0:f615d151a72c 87 {
Michielber 0:f615d151a72c 88 m_pCbItem = (CDummy*) pItem;
Michielber 0:f615d151a72c 89 m_pCbMeth = (void (CDummy::*)(NetTcpSocketEvent)) pMethod;
Michielber 0:f615d151a72c 90 }
Michielber 0:f615d151a72c 91
Michielber 0:f615d151a72c 92 void resetOnEvent(); //Disable callback
Michielber 0:f615d151a72c 93
Michielber 0:f615d151a72c 94 protected:
Michielber 0:f615d151a72c 95 void queueEvent(NetTcpSocketEvent e);
Michielber 0:f615d151a72c 96 void discardEvents();
Michielber 0:f615d151a72c 97 void flushEvents(); //to be called during polling
Michielber 0:f615d151a72c 98
Michielber 0:f615d151a72c 99 Host m_host;
Michielber 0:f615d151a72c 100 Host m_client;
Michielber 0:f615d151a72c 101
Michielber 0:f615d151a72c 102 friend class Net;
Michielber 0:f615d151a72c 103 int m_refs;
Michielber 0:f615d151a72c 104
Michielber 0:f615d151a72c 105 bool m_closed;
Michielber 0:f615d151a72c 106 bool m_removed;
Michielber 0:f615d151a72c 107
Michielber 0:f615d151a72c 108 private:
Michielber 0:f615d151a72c 109 //We do not want to execute user code in interrupt routines, so we queue events until the server is polled
Michielber 0:f615d151a72c 110 //If we port this to a multithreaded OS, we could avoid this (however some functions here are not thread-safe, so beware ;) )
Michielber 0:f615d151a72c 111 void onEvent(NetTcpSocketEvent e); //To be called on poll
Michielber 0:f615d151a72c 112 CDummy* m_pCbItem;
Michielber 0:f615d151a72c 113 void (CDummy::*m_pCbMeth)(NetTcpSocketEvent);
Michielber 0:f615d151a72c 114 queue<NetTcpSocketEvent> m_events;
Michielber 0:f615d151a72c 115
Michielber 0:f615d151a72c 116 };
Michielber 0:f615d151a72c 117
Michielber 0:f615d151a72c 118 #endif