roy roy / EthernetNetIf

a

Fork of EthernetNetIf by Donatien Garnier

LPC1768/api/TCPSocket.h@6:13a3e24ed1a3, 2016-11-27 (annotated)

Committer:
anze777
Date:
Sun Nov 27 14:42:41 2016 +0000
Revision:
6:13a3e24ed1a3
Parent:
5:bc7df6da7589 
2016 11/27

Who changed what in which revision?

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