SHOHEI FUJIMOTO / Mbed 2 deprecated LineLedControl

LineLedControl

Dependencies:   LPD8806 mbed

Fork of LPD8806_Test by Jelmer Tiete

EthernetNetIf/LPC1768/api/TCPSocket.h@3:b0a1b4b24d3c, 2013-08-19 (annotated)

Committer:
sfjmt
Date:
Mon Aug 19 12:14:37 2013 +0000
Revision:
3:b0a1b4b24d3c
LPD8806 control

Who changed what in which revision?

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