Lorcan Smith / Mbed 2 deprecated Enet_SPI

SNMP agent attached to SPI slave

Dependencies:   mbed

api/TCPSocket.h@2:25e12a7fe0aa, 2012-09-06 (annotated)

Committer:
lorcansmith
Date:
Thu Sep 06 12:52:48 2012 +0000
Revision:
2:25e12a7fe0aa
Parent:
0:2a53a4c3238c 
Open source version 1.a

Who changed what in which revision?

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