Derek Fukumori / Mbed 2 deprecated NetworkAnimator

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

EthernetNetIf/LPC2368/api/TCPSocket.h@0:b6a536e40b5d, 2012-06-20 (annotated)

Committer:
dfukumori
Date:
Wed Jun 20 22:16:31 2012 +0000
Revision:
0:b6a536e40b5d

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


dfukumori

0:b6a536e40b5d


     1







dfukumori

0:b6a536e40b5d


     2

/*





dfukumori

0:b6a536e40b5d


     3

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





dfukumori

0:b6a536e40b5d


     4

 





dfukumori

0:b6a536e40b5d


     5

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





dfukumori

0:b6a536e40b5d


     6

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





dfukumori

0:b6a536e40b5d


     7

in the Software without restriction, including without limitation the rights





dfukumori

0:b6a536e40b5d


     8

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





dfukumori

0:b6a536e40b5d


     9

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





dfukumori

0:b6a536e40b5d


    10

furnished to do so, subject to the following conditions:





dfukumori

0:b6a536e40b5d


    11

 





dfukumori

0:b6a536e40b5d


    12

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





dfukumori

0:b6a536e40b5d


    13

all copies or substantial portions of the Software.





dfukumori

0:b6a536e40b5d


    14

 





dfukumori

0:b6a536e40b5d


    15

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





dfukumori

0:b6a536e40b5d


    16

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





dfukumori

0:b6a536e40b5d


    17

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





dfukumori

0:b6a536e40b5d


    18

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





dfukumori

0:b6a536e40b5d


    19

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





dfukumori

0:b6a536e40b5d


    20

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





dfukumori

0:b6a536e40b5d


    21

THE SOFTWARE.





dfukumori

0:b6a536e40b5d


    22

*/





dfukumori

0:b6a536e40b5d


    23







dfukumori

0:b6a536e40b5d


    24

/** \file





dfukumori

0:b6a536e40b5d


    25

TCP Socket header file





dfukumori

0:b6a536e40b5d


    26

*/





dfukumori

0:b6a536e40b5d


    27







dfukumori

0:b6a536e40b5d


    28

#ifndef TCPSOCKET_H





dfukumori

0:b6a536e40b5d


    29

#define TCPSOCKET_H





dfukumori

0:b6a536e40b5d


    30







dfukumori

0:b6a536e40b5d


    31

#include "core/net.h"





dfukumori

0:b6a536e40b5d


    32

#include "core/host.h"





dfukumori

0:b6a536e40b5d


    33

//Essentially it is a safe interface to NetTcpSocket





dfukumori

0:b6a536e40b5d


    34







dfukumori

0:b6a536e40b5d


    35

///TCP Socket error codes





dfukumori

0:b6a536e40b5d


    36

enum TCPSocketErr





dfukumori

0:b6a536e40b5d


    37

{





dfukumori

0:b6a536e40b5d


    38

  __TCPSOCKET_MIN = -0xFFFF,





dfukumori

0:b6a536e40b5d


    39

  TCPSOCKET_SETUP, ///<TCPSocket not properly configured





dfukumori

0:b6a536e40b5d


    40

  TCPSOCKET_TIMEOUT, ///<Connection timed out





dfukumori

0:b6a536e40b5d


    41

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





dfukumori

0:b6a536e40b5d


    42

  TCPSOCKET_MEM, ///<Not enough mem





dfukumori

0:b6a536e40b5d


    43

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





dfukumori

0:b6a536e40b5d


    44

  TCPSOCKET_EMPTY, ///<Connections queue is empty





dfukumori

0:b6a536e40b5d


    45

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





dfukumori

0:b6a536e40b5d


    46

//...





dfukumori

0:b6a536e40b5d


    47

  TCPSOCKET_OK = 0 ///<Success





dfukumori

0:b6a536e40b5d


    48

};





dfukumori

0:b6a536e40b5d


    49







dfukumori

0:b6a536e40b5d


    50

///TCP Socket Events





dfukumori

0:b6a536e40b5d


    51

enum TCPSocketEvent





dfukumori

0:b6a536e40b5d


    52

{





dfukumori

0:b6a536e40b5d


    53

  TCPSOCKET_CONNECTED, ///<Connected to host





dfukumori

0:b6a536e40b5d


    54

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





dfukumori

0:b6a536e40b5d


    55

  TCPSOCKET_READABLE, ///<Data in buf





dfukumori

0:b6a536e40b5d


    56

  TCPSOCKET_WRITEABLE, ///<Can write data to buf





dfukumori

0:b6a536e40b5d


    57

  TCPSOCKET_CONTIMEOUT, ///<Connection timed out





dfukumori

0:b6a536e40b5d


    58

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





dfukumori

0:b6a536e40b5d


    59

  TCPSOCKET_CONABRT, ///<Connection was aborted





dfukumori

0:b6a536e40b5d


    60

  TCPSOCKET_ERROR, ///<Unknown error





dfukumori

0:b6a536e40b5d


    61

  TCPSOCKET_DISCONNECTED ///<Disconnected





dfukumori

0:b6a536e40b5d


    62

};





dfukumori

0:b6a536e40b5d


    63







dfukumori

0:b6a536e40b5d


    64

class NetTcpSocket;





dfukumori

0:b6a536e40b5d


    65

enum NetTcpSocketEvent;





dfukumori

0:b6a536e40b5d


    66







dfukumori

0:b6a536e40b5d


    67

///This is a simple TCP Socket class





dfukumori

0:b6a536e40b5d


    68

/**





dfukumori

0:b6a536e40b5d


    69

  This class exposes an API to deal with TCP Sockets





dfukumori

0:b6a536e40b5d


    70

*/





dfukumori

0:b6a536e40b5d


    71

class TCPSocket





dfukumori

0:b6a536e40b5d


    72

{





dfukumori

0:b6a536e40b5d


    73

public:





dfukumori

0:b6a536e40b5d


    74

  ///Creates a new socket





dfukumori

0:b6a536e40b5d


    75

  TCPSocket();





dfukumori

0:b6a536e40b5d


    76

protected:





dfukumori

0:b6a536e40b5d


    77

  TCPSocket(NetTcpSocket* pNetTcpSocket);





dfukumori

0:b6a536e40b5d


    78

public:





dfukumori

0:b6a536e40b5d


    79

  ///Closes if needed and destroys the socket





dfukumori

0:b6a536e40b5d


    80

  ~TCPSocket(); //close()





dfukumori

0:b6a536e40b5d


    81

  





dfukumori

0:b6a536e40b5d


    82

  ///Binds the socket to (local) host





dfukumori

0:b6a536e40b5d


    83

  TCPSocketErr bind(const Host& me);





dfukumori

0:b6a536e40b5d


    84

  





dfukumori

0:b6a536e40b5d


    85

  ///Starts listening





dfukumori

0:b6a536e40b5d


    86

  TCPSocketErr listen();





dfukumori

0:b6a536e40b5d


    87

  





dfukumori

0:b6a536e40b5d


    88

  ///Connects socket to host





dfukumori

0:b6a536e40b5d


    89

  TCPSocketErr connect(const Host& host);





dfukumori

0:b6a536e40b5d


    90

  





dfukumori

0:b6a536e40b5d


    91

  ///Accepts connection from client and gets connected socket





dfukumori

0:b6a536e40b5d


    92

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





dfukumori

0:b6a536e40b5d


    93

  





dfukumori

0:b6a536e40b5d


    94

  ///Sends data





dfukumori

0:b6a536e40b5d


    95

  /*





dfukumori

0:b6a536e40b5d


    96

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





dfukumori

0:b6a536e40b5d


    97

  */





dfukumori

0:b6a536e40b5d


    98

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





dfukumori

0:b6a536e40b5d


    99

  





dfukumori

0:b6a536e40b5d


   100

  ///Receives data





dfukumori

0:b6a536e40b5d


   101

  /*





dfukumori

0:b6a536e40b5d


   102

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





dfukumori

0:b6a536e40b5d


   103

  */





dfukumori

0:b6a536e40b5d


   104

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





dfukumori

0:b6a536e40b5d


   105







dfukumori

0:b6a536e40b5d


   106

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





dfukumori

0:b6a536e40b5d


   107







dfukumori

0:b6a536e40b5d


   108

  ///Closes socket





dfukumori

0:b6a536e40b5d


   109

  TCPSocketErr close();





dfukumori

0:b6a536e40b5d


   110







dfukumori

0:b6a536e40b5d


   111

  //Callbacks





dfukumori

0:b6a536e40b5d


   112

  ///Setups callback





dfukumori

0:b6a536e40b5d


   113

  /**





dfukumori

0:b6a536e40b5d


   114

  @param pMethod : callback function





dfukumori

0:b6a536e40b5d


   115

  */





dfukumori

0:b6a536e40b5d


   116

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





dfukumori

0:b6a536e40b5d


   117

  





dfukumori

0:b6a536e40b5d


   118

  class CDummy;





dfukumori

0:b6a536e40b5d


   119

  ///Setups callback





dfukumori

0:b6a536e40b5d


   120

  /**





dfukumori

0:b6a536e40b5d


   121

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





dfukumori

0:b6a536e40b5d


   122

  @param pMethod : callback method





dfukumori

0:b6a536e40b5d


   123

  */





dfukumori

0:b6a536e40b5d


   124

  template<class T> 





dfukumori

0:b6a536e40b5d


   125

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





dfukumori

0:b6a536e40b5d


   126

  {





dfukumori

0:b6a536e40b5d


   127

    m_pCbItem = (CDummy*) pItem;





dfukumori

0:b6a536e40b5d


   128

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





dfukumori

0:b6a536e40b5d


   129

  }





dfukumori

0:b6a536e40b5d


   130

  





dfukumori

0:b6a536e40b5d


   131

  ///Disables callback





dfukumori

0:b6a536e40b5d


   132

  void resetOnEvent(); 





dfukumori

0:b6a536e40b5d


   133

  





dfukumori

0:b6a536e40b5d


   134

protected:





dfukumori

0:b6a536e40b5d


   135

  void onNetTcpSocketEvent(NetTcpSocketEvent e);





dfukumori

0:b6a536e40b5d


   136

  TCPSocketErr checkInst();





dfukumori

0:b6a536e40b5d


   137







dfukumori

0:b6a536e40b5d


   138

private:





dfukumori

0:b6a536e40b5d


   139

  NetTcpSocket* m_pNetTcpSocket;





dfukumori

0:b6a536e40b5d


   140

  





dfukumori

0:b6a536e40b5d


   141

  CDummy* m_pCbItem;





dfukumori

0:b6a536e40b5d


   142

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





dfukumori

0:b6a536e40b5d


   143

  





dfukumori

0:b6a536e40b5d


   144

  void (*m_pCb)(TCPSocketEvent);





dfukumori

0:b6a536e40b5d


   145

  





dfukumori

0:b6a536e40b5d


   146

};





dfukumori

0:b6a536e40b5d


   147







dfukumori

0:b6a536e40b5d


   148

#endif