ZG2100NetIfSource - ZG2100 Network interface source

Users » donatien » Code » ZG2100NetIfSource

ZG2100 Network interface source

api/TCPSocket.h@4:e00281c7453d, 2010-08-06 (annotated)

Committer:: donatien
Date:: Fri Aug 06 10:46:03 2010 +0000
Revision:: 4:e00281c7453d
Parent:: 1:3a7c15057192

Who changed what in which revision?

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

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Created:	09 Jul 2010
Imports:	20
Forks:	0
Commits:	5
Dependents:	0
Dependencies:	0
Followers:	3

This repository is Public (Unlisted).

api/TCPSocket.h@4:e00281c7453d, 2010-08-06 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning