Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/api/TCPSocket.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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