Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

api/TCPSocket.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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