Rik Van Dyck / Mbed 2 deprecated Project_Embedded_C

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed DS1307 Servo TextLCD

NetServices/api/TCPSocket.h@0:e1edd52b1ee2, 2014-12-04 (annotated)

Committer:
rikvandyck
Date:
Thu Dec 04 10:44:07 2014 +0000
Revision:
0:e1edd52b1ee2
test

Who changed what in which revision?

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