sasa ivkovic / Mbed 2 deprecated LAN

testing of combination of LCS and LAN

Dependencies:   mbed

EthernetNetIf/LPC1768/api/TCPSocket.h@0:a7a6a692162f, 2015-01-14 (annotated)

Committer:
damir
Date:
Wed Jan 14 13:29:55 2015 +0000
Revision:
0:a7a6a692162f
Test of LAN

Who changed what in which revision?

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