Brandon Fictorie / Mbed 2 deprecated BF_Websocket

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:   mbed

NetServices/if/net/nettcpsocket.h@0:8cdad1c73e8e, 2012-03-25 (annotated)

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


bfictorie

0:8cdad1c73e8e


     1







bfictorie

0:8cdad1c73e8e


     2

/*





bfictorie

0:8cdad1c73e8e


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)





bfictorie

0:8cdad1c73e8e


     4

 





bfictorie

0:8cdad1c73e8e


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





bfictorie

0:8cdad1c73e8e


     6

of this software and associated documentation files (the "Software"), to deal





bfictorie

0:8cdad1c73e8e


     7

in the Software without restriction, including without limitation the rights





bfictorie

0:8cdad1c73e8e


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





bfictorie

0:8cdad1c73e8e


     9

copies of the Software, and to permit persons to whom the Software is





bfictorie

0:8cdad1c73e8e


    10

furnished to do so, subject to the following conditions:





bfictorie

0:8cdad1c73e8e


    11

 





bfictorie

0:8cdad1c73e8e


    12

The above copyright notice and this permission notice shall be included in





bfictorie

0:8cdad1c73e8e


    13

all copies or substantial portions of the Software.





bfictorie

0:8cdad1c73e8e


    14

 





bfictorie

0:8cdad1c73e8e


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





bfictorie

0:8cdad1c73e8e


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





bfictorie

0:8cdad1c73e8e


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





bfictorie

0:8cdad1c73e8e


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





bfictorie

0:8cdad1c73e8e


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





bfictorie

0:8cdad1c73e8e


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





bfictorie

0:8cdad1c73e8e


    21

THE SOFTWARE.





bfictorie

0:8cdad1c73e8e


    22

*/





bfictorie

0:8cdad1c73e8e


    23







bfictorie

0:8cdad1c73e8e


    24

#ifndef NETTCPSOCKET_H





bfictorie

0:8cdad1c73e8e


    25

#define NETTCPSOCKET_H





bfictorie

0:8cdad1c73e8e


    26







bfictorie

0:8cdad1c73e8e


    27

#include "net.h"





bfictorie

0:8cdad1c73e8e


    28

#include "host.h"





bfictorie

0:8cdad1c73e8e


    29







bfictorie

0:8cdad1c73e8e


    30

#include <queue>





bfictorie

0:8cdad1c73e8e


    31

using std::queue;





bfictorie

0:8cdad1c73e8e


    32







bfictorie

0:8cdad1c73e8e


    33

//Implements a Berkeley-like socket if





bfictorie

0:8cdad1c73e8e


    34

//Can be interfaced either to lwip or a Telit module





bfictorie

0:8cdad1c73e8e


    35







bfictorie

0:8cdad1c73e8e


    36

enum NetTcpSocketErr





bfictorie

0:8cdad1c73e8e


    37

{





bfictorie

0:8cdad1c73e8e


    38

  __NETTCPSOCKET_MIN = -0xFFFF,





bfictorie

0:8cdad1c73e8e


    39

  NETTCPSOCKET_SETUP, //NetTcpSocket not properly configured





bfictorie

0:8cdad1c73e8e


    40

  NETTCPSOCKET_TIMEOUT,





bfictorie

0:8cdad1c73e8e


    41

  NETTCPSOCKET_IF, //If has problems





bfictorie

0:8cdad1c73e8e


    42

  NETTCPSOCKET_MEM, //Not enough mem





bfictorie

0:8cdad1c73e8e


    43

  NETTCPSOCKET_INUSE, //If/Port is in use





bfictorie

0:8cdad1c73e8e


    44

  NETTCPSOCKET_EMPTY, //Connections queue is empty





bfictorie

0:8cdad1c73e8e


    45

  NETTCPSOCKET_RST, // Connection was reset by remote host





bfictorie

0:8cdad1c73e8e


    46

//...





bfictorie

0:8cdad1c73e8e


    47

  NETTCPSOCKET_OK = 0





bfictorie

0:8cdad1c73e8e


    48

};





bfictorie

0:8cdad1c73e8e


    49







bfictorie

0:8cdad1c73e8e


    50

enum NetTcpSocketEvent





bfictorie

0:8cdad1c73e8e


    51

{





bfictorie

0:8cdad1c73e8e


    52

  NETTCPSOCKET_CONNECTED, //Connected to host, must call accept() if we were listening





bfictorie

0:8cdad1c73e8e


    53

  NETTCPSOCKET_ACCEPT,  //Connected to client





bfictorie

0:8cdad1c73e8e


    54

  NETTCPSOCKET_READABLE, //Data in buf





bfictorie

0:8cdad1c73e8e


    55

  NETTCPSOCKET_WRITEABLE, //Can write data to buf





bfictorie

0:8cdad1c73e8e


    56

  NETTCPSOCKET_CONTIMEOUT,





bfictorie

0:8cdad1c73e8e


    57

  NETTCPSOCKET_CONRST,





bfictorie

0:8cdad1c73e8e


    58

  NETTCPSOCKET_CONABRT,





bfictorie

0:8cdad1c73e8e


    59

  NETTCPSOCKET_ERROR,





bfictorie

0:8cdad1c73e8e


    60

  NETTCPSOCKET_DISCONNECTED





bfictorie

0:8cdad1c73e8e


    61

};





bfictorie

0:8cdad1c73e8e


    62







bfictorie

0:8cdad1c73e8e


    63







bfictorie

0:8cdad1c73e8e


    64

class NetTcpSocket





bfictorie

0:8cdad1c73e8e


    65

{





bfictorie

0:8cdad1c73e8e


    66

public:





bfictorie

0:8cdad1c73e8e


    67

  NetTcpSocket();





bfictorie

0:8cdad1c73e8e


    68

  virtual ~NetTcpSocket(); //close()





bfictorie

0:8cdad1c73e8e


    69

  





bfictorie

0:8cdad1c73e8e


    70

  virtual NetTcpSocketErr bind(const Host& me) = 0;





bfictorie

0:8cdad1c73e8e


    71

  virtual NetTcpSocketErr listen() = 0;





bfictorie

0:8cdad1c73e8e


    72

  virtual NetTcpSocketErr connect(const Host& host) = 0;





bfictorie

0:8cdad1c73e8e


    73

  virtual NetTcpSocketErr accept(Host* pClient, NetTcpSocket** ppNewNetTcpSocket) = 0;





bfictorie

0:8cdad1c73e8e


    74

  





bfictorie

0:8cdad1c73e8e


    75

  virtual int /*if < 0 : NetTcpSocketErr*/ send(const char* buf, int len) = 0;





bfictorie

0:8cdad1c73e8e


    76

  virtual int /*if < 0 : NetTcpSocketErr*/ recv(char* buf, int len) = 0;





bfictorie

0:8cdad1c73e8e


    77







bfictorie

0:8cdad1c73e8e


    78

  virtual NetTcpSocketErr close() = 0;





bfictorie

0:8cdad1c73e8e


    79







bfictorie

0:8cdad1c73e8e


    80

  virtual NetTcpSocketErr poll() = 0;





bfictorie

0:8cdad1c73e8e


    81

  





bfictorie

0:8cdad1c73e8e


    82

  class CDummy;





bfictorie

0:8cdad1c73e8e


    83

  //Callbacks





bfictorie

0:8cdad1c73e8e


    84

  template<class T> 





bfictorie

0:8cdad1c73e8e


    85

  //Linker bug : Must be defined here :(





bfictorie

0:8cdad1c73e8e


    86

  void setOnEvent( T* pItem, void (T::*pMethod)(NetTcpSocketEvent) )





bfictorie

0:8cdad1c73e8e


    87

  {





bfictorie

0:8cdad1c73e8e


    88

    m_pCbItem = (CDummy*) pItem;





bfictorie

0:8cdad1c73e8e


    89

    m_pCbMeth = (void (CDummy::*)(NetTcpSocketEvent)) pMethod;





bfictorie

0:8cdad1c73e8e


    90

  }





bfictorie

0:8cdad1c73e8e


    91

  





bfictorie

0:8cdad1c73e8e


    92

  void resetOnEvent(); //Disable callback





bfictorie

0:8cdad1c73e8e


    93







bfictorie

0:8cdad1c73e8e


    94

protected:





bfictorie

0:8cdad1c73e8e


    95

  void queueEvent(NetTcpSocketEvent e);





bfictorie

0:8cdad1c73e8e


    96

  void discardEvents();  





bfictorie

0:8cdad1c73e8e


    97

  void flushEvents(); //to be called during polling





bfictorie

0:8cdad1c73e8e


    98







bfictorie

0:8cdad1c73e8e


    99

  Host m_host;





bfictorie

0:8cdad1c73e8e


   100

  Host m_client;





bfictorie

0:8cdad1c73e8e


   101

  





bfictorie

0:8cdad1c73e8e


   102

  friend class Net;





bfictorie

0:8cdad1c73e8e


   103

  int m_refs;





bfictorie

0:8cdad1c73e8e


   104







bfictorie

0:8cdad1c73e8e


   105

  bool m_closed;





bfictorie

0:8cdad1c73e8e


   106

  bool m_removed;





bfictorie

0:8cdad1c73e8e


   107

  





bfictorie

0:8cdad1c73e8e


   108

private:





bfictorie

0:8cdad1c73e8e


   109

  //We do not want to execute user code in interrupt routines, so we queue events until the server is polled





bfictorie

0:8cdad1c73e8e


   110

  //If we port this to a multithreaded OS, we could avoid this (however some functions here are not thread-safe, so beware ;) )





bfictorie

0:8cdad1c73e8e


   111

  void onEvent(NetTcpSocketEvent e); //To be called on poll





bfictorie

0:8cdad1c73e8e


   112

  CDummy* m_pCbItem;





bfictorie

0:8cdad1c73e8e


   113

  void (CDummy::*m_pCbMeth)(NetTcpSocketEvent);





bfictorie

0:8cdad1c73e8e


   114

  queue<NetTcpSocketEvent> m_events;





bfictorie

0:8cdad1c73e8e


   115







bfictorie

0:8cdad1c73e8e


   116

};





bfictorie

0:8cdad1c73e8e


   117







bfictorie

0:8cdad1c73e8e


   118

#endif