hiroshi matsumoto / EthernetNetIf

lpc1768

api/TCPSocket.h@0:f35dada1dac1, 2015-01-27 (annotated)

Committer:
jh1cdv00
Date:
Tue Jan 27 01:38:19 2015 +0000
Revision:
0:f35dada1dac1
lpc1768

Who changed what in which revision?

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