NXP fan (in Japan) / Mbed 2 deprecated TwitterExample_Japanese

japanese tweeting sample with newer version libraries

Dependencies:   TextLCD mbed

EthernetNetIf/LPC2368/api/TCPSocket.h@1:57304b082776, 2012-08-31 (annotated)

Committer:
nxpfan
Date:
Fri Aug 31 08:29:07 2012 +0000
Revision:
1:57304b082776
Parent:
0:66c7c9c4f765 
mbed-lib has been updated also

Who changed what in which revision?

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