Michael Spencer / Mbed 2 deprecated LaOS

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

NetServices/api/TCPSocket.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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