FBI FRATER / Mbed 2 deprecated InetTest

Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

NetServices/api/TCPSocket.h@0:4edb816d21e1, 2015-10-16 (annotated)

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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