Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC2368/if/net/nettcpsocket.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
0:422060928e37 
Done

Who changed what in which revision?

UserRevisionLine numberNew contents of line
psawant9 6:22ce63eddd2b 1
psawant9 6:22ce63eddd2b 2 /*
psawant9 6:22ce63eddd2b 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
psawant9 6:22ce63eddd2b 4
psawant9 6:22ce63eddd2b 5 Permission is hereby granted, free of charge, to any person obtaining a copy
psawant9 6:22ce63eddd2b 6 of this software and associated documentation files (the "Software"), to deal
psawant9 6:22ce63eddd2b 7 in the Software without restriction, including without limitation the rights
psawant9 6:22ce63eddd2b 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
psawant9 6:22ce63eddd2b 9 copies of the Software, and to permit persons to whom the Software is
psawant9 6:22ce63eddd2b 10 furnished to do so, subject to the following conditions:
psawant9 6:22ce63eddd2b 11
psawant9 6:22ce63eddd2b 12 The above copyright notice and this permission notice shall be included in
psawant9 6:22ce63eddd2b 13 all copies or substantial portions of the Software.
psawant9 6:22ce63eddd2b 14
psawant9 6:22ce63eddd2b 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
psawant9 6:22ce63eddd2b 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
psawant9 6:22ce63eddd2b 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
psawant9 6:22ce63eddd2b 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
psawant9 6:22ce63eddd2b 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
psawant9 6:22ce63eddd2b 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
psawant9 6:22ce63eddd2b 21 THE SOFTWARE.
psawant9 6:22ce63eddd2b 22 */
psawant9 6:22ce63eddd2b 23
psawant9 6:22ce63eddd2b 24 #ifndef NETTCPSOCKET_H
psawant9 6:22ce63eddd2b 25 #define NETTCPSOCKET_H
psawant9 6:22ce63eddd2b 26
psawant9 6:22ce63eddd2b 27 #include "net.h"
psawant9 6:22ce63eddd2b 28 #include "host.h"
psawant9 6:22ce63eddd2b 29
psawant9 6:22ce63eddd2b 30 #include <queue>
psawant9 6:22ce63eddd2b 31 using std::queue;
psawant9 6:22ce63eddd2b 32
psawant9 6:22ce63eddd2b 33 //Implements a Berkeley-like socket if
psawant9 6:22ce63eddd2b 34 //Can be interfaced either to lwip or a Telit module
psawant9 6:22ce63eddd2b 35
psawant9 6:22ce63eddd2b 36 enum NetTcpSocketErr
psawant9 6:22ce63eddd2b 37 {
psawant9 6:22ce63eddd2b 38 __NETTCPSOCKET_MIN = -0xFFFF,
psawant9 6:22ce63eddd2b 39 NETTCPSOCKET_SETUP, //NetTcpSocket not properly configured
psawant9 6:22ce63eddd2b 40 NETTCPSOCKET_TIMEOUT,
psawant9 6:22ce63eddd2b 41 NETTCPSOCKET_IF, //If has problems
psawant9 6:22ce63eddd2b 42 NETTCPSOCKET_MEM, //Not enough mem
psawant9 6:22ce63eddd2b 43 NETTCPSOCKET_INUSE, //If/Port is in use
psawant9 6:22ce63eddd2b 44 NETTCPSOCKET_EMPTY, //Connections queue is empty
psawant9 6:22ce63eddd2b 45 NETTCPSOCKET_RST, // Connection was reset by remote host
psawant9 6:22ce63eddd2b 46 //...
psawant9 6:22ce63eddd2b 47 NETTCPSOCKET_OK = 0
psawant9 6:22ce63eddd2b 48 };
psawant9 6:22ce63eddd2b 49
psawant9 6:22ce63eddd2b 50 enum NetTcpSocketEvent
psawant9 6:22ce63eddd2b 51 {
psawant9 6:22ce63eddd2b 52 NETTCPSOCKET_CONNECTED, //Connected to host, must call accept() if we were listening
psawant9 6:22ce63eddd2b 53 NETTCPSOCKET_ACCEPT, //Connected to client
psawant9 6:22ce63eddd2b 54 NETTCPSOCKET_READABLE, //Data in buf
psawant9 6:22ce63eddd2b 55 NETTCPSOCKET_WRITEABLE, //Can write data to buf
psawant9 6:22ce63eddd2b 56 NETTCPSOCKET_CONTIMEOUT,
psawant9 6:22ce63eddd2b 57 NETTCPSOCKET_CONRST,
psawant9 6:22ce63eddd2b 58 NETTCPSOCKET_CONABRT,
psawant9 6:22ce63eddd2b 59 NETTCPSOCKET_ERROR,
psawant9 6:22ce63eddd2b 60 NETTCPSOCKET_DISCONNECTED
psawant9 6:22ce63eddd2b 61 };
psawant9 6:22ce63eddd2b 62
psawant9 6:22ce63eddd2b 63
psawant9 6:22ce63eddd2b 64 class NetTcpSocket
psawant9 6:22ce63eddd2b 65 {
psawant9 6:22ce63eddd2b 66 public:
psawant9 6:22ce63eddd2b 67 NetTcpSocket();
psawant9 6:22ce63eddd2b 68 virtual ~NetTcpSocket(); //close()
psawant9 6:22ce63eddd2b 69
psawant9 6:22ce63eddd2b 70 virtual NetTcpSocketErr bind(const Host& me) = 0;
psawant9 6:22ce63eddd2b 71 virtual NetTcpSocketErr listen() = 0;
psawant9 6:22ce63eddd2b 72 virtual NetTcpSocketErr connect(const Host& host) = 0;
psawant9 6:22ce63eddd2b 73 virtual NetTcpSocketErr accept(Host* pClient, NetTcpSocket** ppNewNetTcpSocket) = 0;
psawant9 6:22ce63eddd2b 74
psawant9 6:22ce63eddd2b 75 virtual int /*if < 0 : NetTcpSocketErr*/ send(const char* buf, int len) = 0;
psawant9 6:22ce63eddd2b 76 virtual int /*if < 0 : NetTcpSocketErr*/ recv(char* buf, int len) = 0;
psawant9 6:22ce63eddd2b 77
psawant9 6:22ce63eddd2b 78 virtual NetTcpSocketErr close() = 0;
psawant9 6:22ce63eddd2b 79
psawant9 6:22ce63eddd2b 80 virtual NetTcpSocketErr poll() = 0;
psawant9 6:22ce63eddd2b 81
psawant9 6:22ce63eddd2b 82 class CDummy;
psawant9 6:22ce63eddd2b 83 //Callbacks
psawant9 6:22ce63eddd2b 84 template<class T>
psawant9 6:22ce63eddd2b 85 //Linker bug : Must be defined here :(
psawant9 6:22ce63eddd2b 86 void setOnEvent( T* pItem, void (T::*pMethod)(NetTcpSocketEvent) )
psawant9 6:22ce63eddd2b 87 {
psawant9 6:22ce63eddd2b 88 m_pCbItem = (CDummy*) pItem;
psawant9 6:22ce63eddd2b 89 m_pCbMeth = (void (CDummy::*)(NetTcpSocketEvent)) pMethod;
psawant9 6:22ce63eddd2b 90 }
psawant9 6:22ce63eddd2b 91
psawant9 6:22ce63eddd2b 92 void resetOnEvent(); //Disable callback
psawant9 6:22ce63eddd2b 93
psawant9 6:22ce63eddd2b 94 protected:
psawant9 6:22ce63eddd2b 95 void queueEvent(NetTcpSocketEvent e);
psawant9 6:22ce63eddd2b 96 void discardEvents();
psawant9 6:22ce63eddd2b 97 void flushEvents(); //to be called during polling
psawant9 6:22ce63eddd2b 98
psawant9 6:22ce63eddd2b 99 Host m_host;
psawant9 6:22ce63eddd2b 100 Host m_client;
psawant9 6:22ce63eddd2b 101
psawant9 6:22ce63eddd2b 102 friend class Net;
psawant9 6:22ce63eddd2b 103 int m_refs;
psawant9 6:22ce63eddd2b 104
psawant9 6:22ce63eddd2b 105 bool m_closed;
psawant9 6:22ce63eddd2b 106 bool m_removed;
psawant9 6:22ce63eddd2b 107
psawant9 6:22ce63eddd2b 108 private:
psawant9 6:22ce63eddd2b 109 //We do not want to execute user code in interrupt routines, so we queue events until the server is polled
psawant9 6:22ce63eddd2b 110 //If we port this to a multithreaded OS, we could avoid this (however some functions here are not thread-safe, so beware ;) )
psawant9 6:22ce63eddd2b 111 void onEvent(NetTcpSocketEvent e); //To be called on poll
psawant9 6:22ce63eddd2b 112 CDummy* m_pCbItem;
psawant9 6:22ce63eddd2b 113 void (CDummy::*m_pCbMeth)(NetTcpSocketEvent);
psawant9 6:22ce63eddd2b 114 queue<NetTcpSocketEvent> m_events;
psawant9 6:22ce63eddd2b 115
psawant9 6:22ce63eddd2b 116 };
psawant9 6:22ce63eddd2b 117
psawant9 6:22ce63eddd2b 118 #endif