Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
api/TCPSocket.h@8:93fa3cfc0219, 2010-07-28 (annotated)
- Committer:
- donatien
- Date:
- Wed Jul 28 12:45:32 2010 +0000
- Revision:
- 8:93fa3cfc0219
- Parent:
- 5:dd63a1e02b1b
- Child:
- 9:c79fa4034f5b
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | |
| donatien | 0:632c9925f013 | 2 | /* |
| donatien | 0:632c9925f013 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:632c9925f013 | 4 | |
| donatien | 0:632c9925f013 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:632c9925f013 | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:632c9925f013 | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:632c9925f013 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:632c9925f013 | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:632c9925f013 | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:632c9925f013 | 11 | |
| donatien | 0:632c9925f013 | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:632c9925f013 | 13 | all copies or substantial portions of the Software. |
| donatien | 0:632c9925f013 | 14 | |
| donatien | 0:632c9925f013 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:632c9925f013 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:632c9925f013 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:632c9925f013 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:632c9925f013 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:632c9925f013 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:632c9925f013 | 21 | THE SOFTWARE. |
| donatien | 0:632c9925f013 | 22 | */ |
| donatien | 0:632c9925f013 | 23 | |
| donatien | 8:93fa3cfc0219 | 24 | /** \file |
| donatien | 8:93fa3cfc0219 | 25 | TCP Socket header file |
| donatien | 8:93fa3cfc0219 | 26 | */ |
| donatien | 8:93fa3cfc0219 | 27 | |
| donatien | 0:632c9925f013 | 28 | #ifndef TCPSOCKET_H |
| donatien | 0:632c9925f013 | 29 | #define TCPSOCKET_H |
| donatien | 0:632c9925f013 | 30 | |
| donatien | 0:632c9925f013 | 31 | #include "if/net/net.h" |
| donatien | 0:632c9925f013 | 32 | //Essentially it is a safe interface to NetTcpSocket |
| donatien | 0:632c9925f013 | 33 | |
| donatien | 8:93fa3cfc0219 | 34 | ///TCP Socket error codes |
| donatien | 0:632c9925f013 | 35 | enum TCPSocketErr |
| donatien | 0:632c9925f013 | 36 | { |
| donatien | 0:632c9925f013 | 37 | __TCPSOCKET_MIN = -0xFFFF, |
| donatien | 8:93fa3cfc0219 | 38 | TCPSOCKET_SETUP, ///<TCPSocket not properly configured |
| donatien | 8:93fa3cfc0219 | 39 | TCPSOCKET_TIMEOUT, ///<Connection timed out |
| donatien | 8:93fa3cfc0219 | 40 | TCPSOCKET_IF, ///<Interface has problems, does not exist or is not initialized |
| donatien | 8:93fa3cfc0219 | 41 | TCPSOCKET_MEM, ///<Not enough mem |
| donatien | 8:93fa3cfc0219 | 42 | TCPSOCKET_INUSE, ///<Interface / Port is in use |
| donatien | 8:93fa3cfc0219 | 43 | TCPSOCKET_EMPTY, ///<Connections queue is empty |
| donatien | 8:93fa3cfc0219 | 44 | TCPSOCKET_RST, ///<Connection was reset by remote host |
| donatien | 0:632c9925f013 | 45 | //... |
| donatien | 8:93fa3cfc0219 | 46 | TCPSOCKET_OK = 0 ///<Success |
| donatien | 0:632c9925f013 | 47 | }; |
| donatien | 0:632c9925f013 | 48 | |
| donatien | 5:dd63a1e02b1b | 49 | ///TCP Socket Events |
| donatien | 0:632c9925f013 | 50 | enum TCPSocketEvent |
| donatien | 0:632c9925f013 | 51 | { |
| donatien | 8:93fa3cfc0219 | 52 | TCPSOCKET_CONNECTED, ///<Connected to host |
| donatien | 8:93fa3cfc0219 | 53 | TCPSOCKET_ACCEPT, ///<Client is connected, must call accept() to get a new Socket |
| donatien | 8:93fa3cfc0219 | 54 | TCPSOCKET_READABLE, ///<Data in buf |
| donatien | 8:93fa3cfc0219 | 55 | TCPSOCKET_WRITEABLE, ///<Can write data to buf |
| donatien | 8:93fa3cfc0219 | 56 | TCPSOCKET_CONTIMEOUT, ///<Connection timed out |
| donatien | 8:93fa3cfc0219 | 57 | TCPSOCKET_CONRST, ///<Connection was reset by remote host |
| donatien | 8:93fa3cfc0219 | 58 | TCPSOCKET_CONABRT, ///<Connection was aborted |
| donatien | 8:93fa3cfc0219 | 59 | TCPSOCKET_ERROR, ///<Unknown error |
| donatien | 8:93fa3cfc0219 | 60 | TCPSOCKET_DISCONNECTED ///<Disconnected |
| donatien | 0:632c9925f013 | 61 | }; |
| donatien | 0:632c9925f013 | 62 | |
| donatien | 5:dd63a1e02b1b | 63 | ///This is a simple TCP Socket class |
| donatien | 5:dd63a1e02b1b | 64 | /** |
| donatien | 5:dd63a1e02b1b | 65 | This class exposes an API to deal with TCP Sockets |
| donatien | 5:dd63a1e02b1b | 66 | */ |
| donatien | 0:632c9925f013 | 67 | class TCPSocket |
| donatien | 0:632c9925f013 | 68 | { |
| donatien | 0:632c9925f013 | 69 | public: |
| donatien | 5:dd63a1e02b1b | 70 | ///Creates a new socket |
| donatien | 0:632c9925f013 | 71 | TCPSocket(); |
| donatien | 0:632c9925f013 | 72 | protected: |
| donatien | 0:632c9925f013 | 73 | TCPSocket(NetTcpSocket* pNetTcpSocket); |
| donatien | 0:632c9925f013 | 74 | public: |
| donatien | 5:dd63a1e02b1b | 75 | ///Closes if needed and destroys the socket |
| donatien | 0:632c9925f013 | 76 | ~TCPSocket(); //close() |
| donatien | 0:632c9925f013 | 77 | |
| donatien | 5:dd63a1e02b1b | 78 | ///Binds the socket to (local) host |
| donatien | 0:632c9925f013 | 79 | TCPSocketErr bind(const Host& me); |
| donatien | 5:dd63a1e02b1b | 80 | |
| donatien | 5:dd63a1e02b1b | 81 | ///Starts listening |
| donatien | 0:632c9925f013 | 82 | TCPSocketErr listen(); |
| donatien | 5:dd63a1e02b1b | 83 | |
| donatien | 5:dd63a1e02b1b | 84 | ///Connects socket to host |
| donatien | 0:632c9925f013 | 85 | TCPSocketErr connect(const Host& host); |
| donatien | 5:dd63a1e02b1b | 86 | |
| donatien | 5:dd63a1e02b1b | 87 | ///Accepts connection from client and gets connected socket |
| donatien | 0:632c9925f013 | 88 | TCPSocketErr accept(Host* pClient, TCPSocket** ppNewTcpSocket); |
| donatien | 0:632c9925f013 | 89 | |
| donatien | 5:dd63a1e02b1b | 90 | ///Sends data |
| donatien | 5:dd63a1e02b1b | 91 | /* |
| donatien | 5:dd63a1e02b1b | 92 | @return a negative error code or the number of bytes transmitted |
| donatien | 5:dd63a1e02b1b | 93 | */ |
| donatien | 0:632c9925f013 | 94 | int /*if < 0 : TCPSocketErr*/ send(const char* buf, int len); |
| donatien | 5:dd63a1e02b1b | 95 | |
| donatien | 5:dd63a1e02b1b | 96 | ///Receives data |
| donatien | 5:dd63a1e02b1b | 97 | /* |
| donatien | 5:dd63a1e02b1b | 98 | @return a negative error code or the number of bytes received |
| donatien | 5:dd63a1e02b1b | 99 | */ |
| donatien | 0:632c9925f013 | 100 | int /*if < 0 : TCPSocketErr*/ recv(char* buf, int len); |
| donatien | 0:632c9925f013 | 101 | |
| donatien | 0:632c9925f013 | 102 | /* TODO NTH : printf / scanf helpers that call send/recv */ |
| donatien | 0:632c9925f013 | 103 | |
| donatien | 5:dd63a1e02b1b | 104 | ///Closes socket |
| donatien | 0:632c9925f013 | 105 | TCPSocketErr close(); |
| donatien | 0:632c9925f013 | 106 | |
| donatien | 5:dd63a1e02b1b | 107 | //Callbacks |
| donatien | 5:dd63a1e02b1b | 108 | ///Setups callback |
| donatien | 5:dd63a1e02b1b | 109 | /** |
| donatien | 5:dd63a1e02b1b | 110 | @param pMethod : callback function |
| donatien | 5:dd63a1e02b1b | 111 | */ |
| donatien | 5:dd63a1e02b1b | 112 | void setOnEvent( void (*pMethod)(TCPSocketEvent) ); |
| donatien | 5:dd63a1e02b1b | 113 | |
| donatien | 0:632c9925f013 | 114 | class CDummy; |
| donatien | 5:dd63a1e02b1b | 115 | ///Setups callback |
| donatien | 5:dd63a1e02b1b | 116 | /** |
| donatien | 5:dd63a1e02b1b | 117 | @param pItem : instance of class on which to execute the callback method |
| donatien | 5:dd63a1e02b1b | 118 | @param pMethod : callback method |
| donatien | 5:dd63a1e02b1b | 119 | */ |
| donatien | 0:632c9925f013 | 120 | template<class T> |
| donatien | 0:632c9925f013 | 121 | void setOnEvent( T* pItem, void (T::*pMethod)(TCPSocketEvent) ) |
| donatien | 0:632c9925f013 | 122 | { |
| donatien | 0:632c9925f013 | 123 | m_pCbItem = (CDummy*) pItem; |
| donatien | 0:632c9925f013 | 124 | m_pCbMeth = (void (CDummy::*)(TCPSocketEvent)) pMethod; |
| donatien | 0:632c9925f013 | 125 | } |
| donatien | 0:632c9925f013 | 126 | |
| donatien | 5:dd63a1e02b1b | 127 | ///Disables callback |
| donatien | 5:dd63a1e02b1b | 128 | void resetOnEvent(); |
| donatien | 0:632c9925f013 | 129 | |
| donatien | 0:632c9925f013 | 130 | protected: |
| donatien | 0:632c9925f013 | 131 | void onNetTcpSocketEvent(NetTcpSocketEvent e); |
| donatien | 0:632c9925f013 | 132 | TCPSocketErr checkInst(); |
| donatien | 0:632c9925f013 | 133 | |
| donatien | 0:632c9925f013 | 134 | private: |
| donatien | 0:632c9925f013 | 135 | NetTcpSocket* m_pNetTcpSocket; |
| donatien | 0:632c9925f013 | 136 | |
| donatien | 0:632c9925f013 | 137 | CDummy* m_pCbItem; |
| donatien | 0:632c9925f013 | 138 | void (CDummy::*m_pCbMeth)(TCPSocketEvent); |
| donatien | 0:632c9925f013 | 139 | |
| donatien | 0:632c9925f013 | 140 | void (*m_pCb)(TCPSocketEvent); |
| donatien | 0:632c9925f013 | 141 | |
| donatien | 0:632c9925f013 | 142 | }; |
| donatien | 0:632c9925f013 | 143 | |
| donatien | 0:632c9925f013 | 144 | #endif |