SHOHEI FUJIMOTO / Mbed 2 deprecated SimpleOscTester

simple tester example >>> osc destination & receive

Dependencies:   mbed

Fork of myOSC_test by Alvaro Cassinelli

EthernetNetIf/LPC1768/api/TCPSocket.h@2:44f1e5803762, 2013-08-06 (annotated)

Committer:
sfjmt
Date:
Tue Aug 06 10:12:56 2013 +0000
Revision:
2:44f1e5803762
Parent:
0:f76708a93fb3 
revision_01

Who changed what in which revision?

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