HTTPServer -

Users » slowness » Code » HTTPServer

bruno LARNAUDIE / Mbed 2 deprecated HTTPServer

EthernetNetIf/LPC1768/api/TCPSocket.h@0:58c3d014a4e7, 2011-09-06 (annotated)

Committer:: slowness
Date:: Tue Sep 06 18:05:46 2011 +0000
Revision:: 0:58c3d014a4e7

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	06 Sep 2011
Imports:	112
Forks:	0
Commits:	1
Dependents:	1
Dependencies:	1
Followers:	2

EthernetNetIf/LPC1768/api/TCPSocket.h@0:58c3d014a4e7, 2011-09-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning