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/api/TCPSocket.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

/** \file





bfictorie

0:8cdad1c73e8e


    25

TCP Socket header file





bfictorie

0:8cdad1c73e8e


    26

*/





bfictorie

0:8cdad1c73e8e


    27







bfictorie

0:8cdad1c73e8e


    28

#ifndef TCPSOCKET_H





bfictorie

0:8cdad1c73e8e


    29

#define TCPSOCKET_H





bfictorie

0:8cdad1c73e8e


    30







bfictorie

0:8cdad1c73e8e


    31

#include "core/net.h"





bfictorie

0:8cdad1c73e8e


    32

#include "core/host.h"





bfictorie

0:8cdad1c73e8e


    33

//Essentially it is a safe interface to NetTcpSocket





bfictorie

0:8cdad1c73e8e


    34







bfictorie

0:8cdad1c73e8e


    35

///TCP Socket error codes





bfictorie

0:8cdad1c73e8e


    36

enum TCPSocketErr





bfictorie

0:8cdad1c73e8e


    37

{





bfictorie

0:8cdad1c73e8e


    38

  __TCPSOCKET_MIN = -0xFFFF,





bfictorie

0:8cdad1c73e8e


    39

  TCPSOCKET_SETUP, ///<TCPSocket not properly configured





bfictorie

0:8cdad1c73e8e


    40

  TCPSOCKET_TIMEOUT, ///<Connection timed out





bfictorie

0:8cdad1c73e8e


    41

  TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized





bfictorie

0:8cdad1c73e8e


    42

  TCPSOCKET_MEM, ///<Not enough mem





bfictorie

0:8cdad1c73e8e


    43

  TCPSOCKET_INUSE, ///<Interface / Port is in use





bfictorie

0:8cdad1c73e8e


    44

  TCPSOCKET_EMPTY, ///<Connections queue is empty





bfictorie

0:8cdad1c73e8e


    45

  TCPSOCKET_RST, ///<Connection was reset by remote host





bfictorie

0:8cdad1c73e8e


    46

//...





bfictorie

0:8cdad1c73e8e


    47

  TCPSOCKET_OK = 0 ///<Success





bfictorie

0:8cdad1c73e8e


    48

};





bfictorie

0:8cdad1c73e8e


    49







bfictorie

0:8cdad1c73e8e


    50

///TCP Socket Events





bfictorie

0:8cdad1c73e8e


    51

enum TCPSocketEvent





bfictorie

0:8cdad1c73e8e


    52

{





bfictorie

0:8cdad1c73e8e


    53

  TCPSOCKET_CONNECTED, ///<Connected to host





bfictorie

0:8cdad1c73e8e


    54

  TCPSOCKET_ACCEPT,  ///<Client is connected, must call accept() to get a new Socket





bfictorie

0:8cdad1c73e8e


    55

  TCPSOCKET_READABLE, ///<Data in buf





bfictorie

0:8cdad1c73e8e


    56

  TCPSOCKET_WRITEABLE, ///<Can write data to buf





bfictorie

0:8cdad1c73e8e


    57

  TCPSOCKET_CONTIMEOUT, ///<Connection timed out





bfictorie

0:8cdad1c73e8e


    58

  TCPSOCKET_CONRST, ///<Connection was reset by remote host





bfictorie

0:8cdad1c73e8e


    59

  TCPSOCKET_CONABRT, ///<Connection was aborted





bfictorie

0:8cdad1c73e8e


    60

  TCPSOCKET_ERROR, ///<Unknown error





bfictorie

0:8cdad1c73e8e


    61

  TCPSOCKET_DISCONNECTED ///<Disconnected





bfictorie

0:8cdad1c73e8e


    62

};





bfictorie

0:8cdad1c73e8e


    63







bfictorie

0:8cdad1c73e8e


    64

class NetTcpSocket;





bfictorie

0:8cdad1c73e8e


    65

enum NetTcpSocketEvent;





bfictorie

0:8cdad1c73e8e


    66







bfictorie

0:8cdad1c73e8e


    67

///This is a simple TCP Socket class





bfictorie

0:8cdad1c73e8e


    68

/**





bfictorie

0:8cdad1c73e8e


    69

  This class exposes an API to deal with TCP Sockets





bfictorie

0:8cdad1c73e8e


    70

*/





bfictorie

0:8cdad1c73e8e


    71

class TCPSocket





bfictorie

0:8cdad1c73e8e


    72

{





bfictorie

0:8cdad1c73e8e


    73

public:





bfictorie

0:8cdad1c73e8e


    74

  ///Creates a new socket





bfictorie

0:8cdad1c73e8e


    75

  TCPSocket();





bfictorie

0:8cdad1c73e8e


    76

protected:





bfictorie

0:8cdad1c73e8e


    77

  TCPSocket(NetTcpSocket* pNetTcpSocket);





bfictorie

0:8cdad1c73e8e


    78

public:





bfictorie

0:8cdad1c73e8e


    79

  ///Closes if needed and destroys the socket





bfictorie

0:8cdad1c73e8e


    80

  ~TCPSocket(); //close()





bfictorie

0:8cdad1c73e8e


    81

  





bfictorie

0:8cdad1c73e8e


    82

  ///Binds the socket to (local) host





bfictorie

0:8cdad1c73e8e


    83

  TCPSocketErr bind(const Host& me);





bfictorie

0:8cdad1c73e8e


    84

  





bfictorie

0:8cdad1c73e8e


    85

  ///Starts listening





bfictorie

0:8cdad1c73e8e


    86

  TCPSocketErr listen();





bfictorie

0:8cdad1c73e8e


    87

  





bfictorie

0:8cdad1c73e8e


    88

  ///Connects socket to host





bfictorie

0:8cdad1c73e8e


    89

  TCPSocketErr connect(const Host& host);





bfictorie

0:8cdad1c73e8e


    90

  





bfictorie

0:8cdad1c73e8e


    91

  ///Accepts connection from client and gets connected socket





bfictorie

0:8cdad1c73e8e


    92

  TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket);





bfictorie

0:8cdad1c73e8e


    93

  





bfictorie

0:8cdad1c73e8e


    94

  ///Sends data





bfictorie

0:8cdad1c73e8e


    95

  /*





bfictorie

0:8cdad1c73e8e


    96

  @return a negative error code or the number of bytes transmitted





bfictorie

0:8cdad1c73e8e


    97

  */





bfictorie

0:8cdad1c73e8e


    98

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





bfictorie

0:8cdad1c73e8e


    99

  





bfictorie

0:8cdad1c73e8e


   100

  ///Receives data





bfictorie

0:8cdad1c73e8e


   101

  /*





bfictorie

0:8cdad1c73e8e


   102

  @return a negative error code or the number of bytes received





bfictorie

0:8cdad1c73e8e


   103

  */





bfictorie

0:8cdad1c73e8e


   104

  int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len);





bfictorie

0:8cdad1c73e8e


   105







bfictorie

0:8cdad1c73e8e


   106

  /* TODO NTH : printf / scanf helpers that call send/recv */





bfictorie

0:8cdad1c73e8e


   107







bfictorie

0:8cdad1c73e8e


   108

  ///Closes socket





bfictorie

0:8cdad1c73e8e


   109

  TCPSocketErr close();





bfictorie

0:8cdad1c73e8e


   110







bfictorie

0:8cdad1c73e8e


   111

  //Callbacks





bfictorie

0:8cdad1c73e8e


   112

  ///Setups callback





bfictorie

0:8cdad1c73e8e


   113

  /**





bfictorie

0:8cdad1c73e8e


   114

  @param pMethod : callback function





bfictorie

0:8cdad1c73e8e


   115

  */





bfictorie

0:8cdad1c73e8e


   116

  void setOnEvent( void (*pMethod)(TCPSocketEvent) );





bfictorie

0:8cdad1c73e8e


   117

  





bfictorie

0:8cdad1c73e8e


   118

  class CDummy;





bfictorie

0:8cdad1c73e8e


   119

  ///Setups callback





bfictorie

0:8cdad1c73e8e


   120

  /**





bfictorie

0:8cdad1c73e8e


   121

  @param pItem : instance of class on which to execute the callback method





bfictorie

0:8cdad1c73e8e


   122

  @param pMethod : callback method





bfictorie

0:8cdad1c73e8e


   123

  */





bfictorie

0:8cdad1c73e8e


   124

  template<class T> 





bfictorie

0:8cdad1c73e8e


   125

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





bfictorie

0:8cdad1c73e8e


   126

  {





bfictorie

0:8cdad1c73e8e


   127

    m_pCbItem = (CDummy*) pItem;





bfictorie

0:8cdad1c73e8e


   128

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





bfictorie

0:8cdad1c73e8e


   129

  }





bfictorie

0:8cdad1c73e8e


   130

  





bfictorie

0:8cdad1c73e8e


   131

  ///Disables callback





bfictorie

0:8cdad1c73e8e


   132

  void resetOnEvent(); 





bfictorie

0:8cdad1c73e8e


   133

  





bfictorie

0:8cdad1c73e8e


   134

protected:





bfictorie

0:8cdad1c73e8e


   135

  void onNetTcpSocketEvent(NetTcpSocketEvent e);





bfictorie

0:8cdad1c73e8e


   136

  TCPSocketErr checkInst();





bfictorie

0:8cdad1c73e8e


   137







bfictorie

0:8cdad1c73e8e


   138

private:





bfictorie

0:8cdad1c73e8e


   139

  NetTcpSocket* m_pNetTcpSocket;





bfictorie

0:8cdad1c73e8e


   140

  





bfictorie

0:8cdad1c73e8e


   141

  CDummy* m_pCbItem;





bfictorie

0:8cdad1c73e8e


   142

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





bfictorie

0:8cdad1c73e8e


   143

  





bfictorie

0:8cdad1c73e8e


   144

  void (*m_pCb)(TCPSocketEvent);





bfictorie

0:8cdad1c73e8e


   145

  





bfictorie

0:8cdad1c73e8e


   146

};





bfictorie

0:8cdad1c73e8e


   147







bfictorie

0:8cdad1c73e8e


   148

#endif