mimil owns / NetServicesProxy

A modified version of http://mbed.org/users/segundo/libraries/NetServices/ljhqix to add HTTP proxy feature (based on http://mbed.org/users/igorsk/programs/NetServicesSource/ltjpag)

Dependents:   SenseClient

api/TCPSocket.h@0:308f83189a3f, 2011-09-06 (annotated)

Committer:
mimil
Date:
Tue Sep 06 13:26:45 2011 +0000
Revision:
0:308f83189a3f

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


mimil

0:308f83189a3f


     1







mimil

0:308f83189a3f


     2

/*





mimil

0:308f83189a3f


     3

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





mimil

0:308f83189a3f


     4

 





mimil

0:308f83189a3f


     5

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





mimil

0:308f83189a3f


     6

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





mimil

0:308f83189a3f


     7

in the Software without restriction, including without limitation the rights





mimil

0:308f83189a3f


     8

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





mimil

0:308f83189a3f


     9

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





mimil

0:308f83189a3f


    10

furnished to do so, subject to the following conditions:





mimil

0:308f83189a3f


    11

 





mimil

0:308f83189a3f


    12

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





mimil

0:308f83189a3f


    13

all copies or substantial portions of the Software.





mimil

0:308f83189a3f


    14

 





mimil

0:308f83189a3f


    15

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





mimil

0:308f83189a3f


    16

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





mimil

0:308f83189a3f


    17

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





mimil

0:308f83189a3f


    18

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





mimil

0:308f83189a3f


    19

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





mimil

0:308f83189a3f


    20

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





mimil

0:308f83189a3f


    21

THE SOFTWARE.





mimil

0:308f83189a3f


    22

*/





mimil

0:308f83189a3f


    23







mimil

0:308f83189a3f


    24

/** \file





mimil

0:308f83189a3f


    25

TCP Socket header file





mimil

0:308f83189a3f


    26

*/





mimil

0:308f83189a3f


    27







mimil

0:308f83189a3f


    28

#ifndef TCPSOCKET_H





mimil

0:308f83189a3f


    29

#define TCPSOCKET_H





mimil

0:308f83189a3f


    30







mimil

0:308f83189a3f


    31

#include "core/net.h"





mimil

0:308f83189a3f


    32

#include "core/host.h"





mimil

0:308f83189a3f


    33

//Essentially it is a safe interface to NetTcpSocket





mimil

0:308f83189a3f


    34







mimil

0:308f83189a3f


    35

///TCP Socket error codes





mimil

0:308f83189a3f


    36

enum TCPSocketErr





mimil

0:308f83189a3f


    37

{





mimil

0:308f83189a3f


    38

  __TCPSOCKET_MIN = -0xFFFF,





mimil

0:308f83189a3f


    39

  TCPSOCKET_SETUP, ///<TCPSocket not properly configured





mimil

0:308f83189a3f


    40

  TCPSOCKET_TIMEOUT, ///<Connection timed out





mimil

0:308f83189a3f


    41

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





mimil

0:308f83189a3f


    42

  TCPSOCKET_MEM, ///<Not enough mem





mimil

0:308f83189a3f


    43

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





mimil

0:308f83189a3f


    44

  TCPSOCKET_EMPTY, ///<Connections queue is empty





mimil

0:308f83189a3f


    45

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





mimil

0:308f83189a3f


    46

//...





mimil

0:308f83189a3f


    47

  TCPSOCKET_OK = 0 ///<Success





mimil

0:308f83189a3f


    48

};





mimil

0:308f83189a3f


    49







mimil

0:308f83189a3f


    50

///TCP Socket Events





mimil

0:308f83189a3f


    51

enum TCPSocketEvent





mimil

0:308f83189a3f


    52

{





mimil

0:308f83189a3f


    53

  TCPSOCKET_CONNECTED, ///<Connected to host





mimil

0:308f83189a3f


    54

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





mimil

0:308f83189a3f


    55

  TCPSOCKET_READABLE, ///<Data in buf





mimil

0:308f83189a3f


    56

  TCPSOCKET_WRITEABLE, ///<Can write data to buf





mimil

0:308f83189a3f


    57

  TCPSOCKET_CONTIMEOUT, ///<Connection timed out





mimil

0:308f83189a3f


    58

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





mimil

0:308f83189a3f


    59

  TCPSOCKET_CONABRT, ///<Connection was aborted





mimil

0:308f83189a3f


    60

  TCPSOCKET_ERROR, ///<Unknown error





mimil

0:308f83189a3f


    61

  TCPSOCKET_DISCONNECTED ///<Disconnected





mimil

0:308f83189a3f


    62

};





mimil

0:308f83189a3f


    63







mimil

0:308f83189a3f


    64

class NetTcpSocket;





mimil

0:308f83189a3f


    65

enum NetTcpSocketEvent;





mimil

0:308f83189a3f


    66







mimil

0:308f83189a3f


    67

///This is a simple TCP Socket class





mimil

0:308f83189a3f


    68

/**





mimil

0:308f83189a3f


    69

  This class exposes an API to deal with TCP Sockets





mimil

0:308f83189a3f


    70

*/





mimil

0:308f83189a3f


    71

class TCPSocket





mimil

0:308f83189a3f


    72

{





mimil

0:308f83189a3f


    73

public:





mimil

0:308f83189a3f


    74

  ///Creates a new socket





mimil

0:308f83189a3f


    75

  TCPSocket();





mimil

0:308f83189a3f


    76

protected:





mimil

0:308f83189a3f


    77

  TCPSocket(NetTcpSocket* pNetTcpSocket);





mimil

0:308f83189a3f


    78

public:





mimil

0:308f83189a3f


    79

  ///Closes if needed and destroys the socket





mimil

0:308f83189a3f


    80

  ~TCPSocket(); //close()





mimil

0:308f83189a3f


    81

  





mimil

0:308f83189a3f


    82

  ///Binds the socket to (local) host





mimil

0:308f83189a3f


    83

  TCPSocketErr bind(const Host& me);





mimil

0:308f83189a3f


    84

  





mimil

0:308f83189a3f


    85

  ///Starts listening





mimil

0:308f83189a3f


    86

  TCPSocketErr listen();





mimil

0:308f83189a3f


    87

  





mimil

0:308f83189a3f


    88

  ///Connects socket to host





mimil

0:308f83189a3f


    89

  TCPSocketErr connect(const Host& host);





mimil

0:308f83189a3f


    90

  





mimil

0:308f83189a3f


    91

  ///Accepts connection from client and gets connected socket





mimil

0:308f83189a3f


    92

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





mimil

0:308f83189a3f


    93

  





mimil

0:308f83189a3f


    94

  ///Sends data





mimil

0:308f83189a3f


    95

  /*





mimil

0:308f83189a3f


    96

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





mimil

0:308f83189a3f


    97

  */





mimil

0:308f83189a3f


    98

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





mimil

0:308f83189a3f


    99

  





mimil

0:308f83189a3f


   100

  ///Receives data





mimil

0:308f83189a3f


   101

  /*





mimil

0:308f83189a3f


   102

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





mimil

0:308f83189a3f


   103

  */





mimil

0:308f83189a3f


   104

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





mimil

0:308f83189a3f


   105







mimil

0:308f83189a3f


   106

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





mimil

0:308f83189a3f


   107







mimil

0:308f83189a3f


   108

  ///Closes socket





mimil

0:308f83189a3f


   109

  TCPSocketErr close();





mimil

0:308f83189a3f


   110







mimil

0:308f83189a3f


   111

  //Callbacks





mimil

0:308f83189a3f


   112

  ///Setups callback





mimil

0:308f83189a3f


   113

  /**





mimil

0:308f83189a3f


   114

  @param pMethod : callback function





mimil

0:308f83189a3f


   115

  */





mimil

0:308f83189a3f


   116

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





mimil

0:308f83189a3f


   117

  





mimil

0:308f83189a3f


   118

  class CDummy;





mimil

0:308f83189a3f


   119

  ///Setups callback





mimil

0:308f83189a3f


   120

  /**





mimil

0:308f83189a3f


   121

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





mimil

0:308f83189a3f


   122

  @param pMethod : callback method





mimil

0:308f83189a3f


   123

  */





mimil

0:308f83189a3f


   124

  template<class T> 





mimil

0:308f83189a3f


   125

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





mimil

0:308f83189a3f


   126

  {





mimil

0:308f83189a3f


   127

    m_pCbItem = (CDummy*) pItem;





mimil

0:308f83189a3f


   128

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





mimil

0:308f83189a3f


   129

  }





mimil

0:308f83189a3f


   130

  





mimil

0:308f83189a3f


   131

  ///Disables callback





mimil

0:308f83189a3f


   132

  void resetOnEvent(); 





mimil

0:308f83189a3f


   133

  





mimil

0:308f83189a3f


   134

protected:





mimil

0:308f83189a3f


   135

  void onNetTcpSocketEvent(NetTcpSocketEvent e);





mimil

0:308f83189a3f


   136

  TCPSocketErr checkInst();





mimil

0:308f83189a3f


   137







mimil

0:308f83189a3f


   138

private:





mimil

0:308f83189a3f


   139

  NetTcpSocket* m_pNetTcpSocket;





mimil

0:308f83189a3f


   140

  





mimil

0:308f83189a3f


   141

  CDummy* m_pCbItem;





mimil

0:308f83189a3f


   142

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





mimil

0:308f83189a3f


   143

  





mimil

0:308f83189a3f


   144

  void (*m_pCb)(TCPSocketEvent);





mimil

0:308f83189a3f


   145

  





mimil

0:308f83189a3f


   146

};





mimil

0:308f83189a3f


   147







mimil

0:308f83189a3f


   148

#endif