Alvaro Cassinelli / Mbed 2 deprecated laserUI

Laser Sensing Display for UI interfaces in the real world

Dependencies:   mbed

Fork of skinGames_forktest by Alvaro Cassinelli

EthernetNetIf/LPC1768/api/TCPSocket.h@47:199042980678, 2014-04-17 (annotated)

Committer:
mbedalvaro
Date:
Thu Apr 17 08:04:14 2014 +0000
Revision:
47:199042980678
Parent:
31:5f039cbddee8 
publishing for sharing with Ken Iwasaki

Who changed what in which revision?

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