File content as of revision 0:4085cc9441f3:

/*
@file	
	socket_internal.h

@brief	
*/
#ifndef __SOCKET_INTERNAL_H__
#define __SOCKET_INTERNAL_H__


#ifdef  __cplusplus
extern "C" {
#endif

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
INCLUDES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

#include "socket_nmc.h"


/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
MACROS
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/


#define SOCKET_CMD_INVALID				0x00
/*< Invlaid Socket command value.
*/
#define SOCKET_CMD_BIND					0x41
/*< Socket Binding command value.
*/
#define SOCKET_CMD_LISTEN				0x42
/*< Socket Listening command value.
*/
#define SOCKET_CMD_ACCEPT				0x43
/*< Socket Accepting command value.
*/
#define SOCKET_CMD_CONNECT				0x44
/*< Socket Connecting command value.
*/
#define SOCKET_CMD_SEND					0x45
/*< Socket send command value.
*/
#define SOCKET_CMD_RECV					0x46
/*< Socket Recieve command value.
*/
#define SOCKET_CMD_SENDTO				0x47
/*< Socket sendTo command value.
*/
#define SOCKET_CMD_RECVFROM				0x48
/*< Socket RecieveFrom command value.
*/
#define SOCKET_CMD_CLOSE				0x49
/*< Socket Close command value.
*/
#define SOCKET_CMD_DNS_RESOLVE			0x4A
/*< Socket DNS Resolve command value.
*/
#define SOCKET_CMD_SSL_CONNECT			0x4B
/*< SSL-Socket Connect command value.
*/
#define SOCKET_CMD_SSL_SEND				0x4C	
/*< SSL-Socket Send command value.
*/	
#define SOCKET_CMD_SSL_RECV				0x4D
/*< SSL-Socket Recieve command value.
*/
#define SOCKET_CMD_SSL_CLOSE			0x4E
/*< SSL-Socket Close command value.
*/
#define SOCKET_CMD_DHCP_CLIENT			0x4F
/*< DHCP Client command value.
*/
#define SOCKET_CMD_TCP_ERROR            0x50
/*!< TCP Error command value.
*/


/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
DATA TYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/


/*
*  @brief	
*/
typedef struct{	
	uint16		u16Family;
	uint16		u16Port;
	uint32		u32IPAddr;
}tstrSockAddr;



/*
@struct	\
	tstrDnsReply
	
@brief
	DNS Reply, contains hostName and HostIP.
*/
typedef struct{
	char	acHostName[HOSTNAME_MAX_SIZE];
	uint32	u32HostIP;
}tstrDnsReply;


/*
@struct	\
	tstrDhcpClientReply

@brief
	DHCP Client Reply, contains OfferIP.
*/
typedef struct{
	uint32	u32OfferIP;
	uint32	u32GatewayIP;
}tstrDhcpClientReply;

/*
@struct	\
	tstrConnectReply
	
@brief
	Connect Reply, contains sock number and error value
*/
typedef struct{
	SOCKET		sock;
	sint8		s8Error;
	uint16		u16Void;
}tstrConnectReply;


/*
@struct \
    tstrTCPErrorReply
 
@brief
    Connect Reply, contains sock number and error value
*/
typedef struct{
    SOCKET      sock;
    sint8       s8Error;
    uint16      u16Void;
}tstrTCPErrorReply;
 
/*
*  @brief
*/
typedef struct{
	tstrSockAddr	strAddr;
	SOCKET			sListenSock;
	SOCKET			sConnectedSock;
	uint16			u16Void;
}tstrAcceptReply;


/*
@brief
*/
typedef struct{
	SOCKET		sock;
	sint8		s8Status;
	uint16		u16Void;
}tstrBindReply;


/*
@struct	\
	tstrSocketRecvMsg
	
@brief	Socket recv status. 

	It is passed to the APPSocketEventHandler with SOCKET_MSG_RECV or SOCKET_MSG_RECVFROM message type 
	in a response to a user call to the recv or recvfrom.
	If the received data from the remote peer is larger than the USER Buffer size (given at recv call), the data is 
	delivered to the user in a number of consecutive chunks according to the USER Buffer size.
*/
typedef struct{
	SOCKET		sock;
	sint8		s8Status;
	uint16		u16Void;
}tstrListenReply;


/*
@struct	\
	tstrSendReply
	
@brief
	Send Reply, contains socket number and number of sent bytes.
*/
typedef struct{
	SOCKET		sock;
	uint8		u8Void;
	sint16		s16SentBytes;
}tstrSendReply;


/*
@struct
@brief
*/
typedef struct{
	tstrSockAddr	strRemoteAddr;
	sint16			s16RecvStatus;
	uint16			u16DataOffset;
	SOCKET			sock;
	uint8			u8Void;
	uint16			u16Void;
}tstrRecvReply;

/*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
FUNCTION PROTOTYPES
*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*/

NMI_API void Socket_ReadSocketData(SOCKET sock, tstrSocketRecvMsg *pstrRecv,uint8 u8SocketMsg,
								  uint32 u32StartAddress,uint16 u16ReadCount, uint8 u8Skip);

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __SOCKET_H__ */