src/stack/tcp6/tcp6.h File Reference

The file contains private definitions for the TCP Module which runs over IPv6. More...

Functions
void	TCP6Drop (TCPPROT *pt, int Error)
void	TCP6Close (TCPPROT *pt)
int	TCP6Output (TCPPROT *pt)
void	TCP6TimeoutAdd (TCPPROT *pt)
void	TCP6TimeoutRemove (TCPPROT *pt)
uint	TCP6ValidateMetrics (TCPPROT *pt, uint rcvmss)
void	TCP6GenPacket (TCPPROT *pt, IP6N IPDst, uint PortDst, IP6N IPSrc, uint PortSrc, UINT32 ack, UINT32 seq, int flags)

---

Detailed Description

The file contains private definitions for the TCP Module which runs over IPv6.

NOTE: (C) Copyright 2008, Texas Instruments, Inc.

---

Function Documentation

void TCP6Close

(

TCPPROT *

pt

)

Description
The function is called to close down the TCP Protocol block.

Parameters:

[in]

pt

Pointer to the TCP Protocol Information block.

Return values:

Not

Applicable.

void TCP6Drop	(	TCPPROT *	pt,
		int	Error
	)

Description
The function drops a TCP side "socket" with ABORT

Parameters:

[in]	pt	Handle to the TCP protocol information
[in]	Error	Error Code.

Return values:

Not

applicable.

void TCP6GenPacket	(	TCPPROT *	pt,
		IP6N	IPDst,
		uint	PortDst,
		IP6N	IPSrc,
		uint	PortSrc,
		UINT32	ack,
		UINT32	seq,
		int	flags
	)

Description
The function is the used to generate and tranmit TCP Control Packets is received over IPv6.

Parameters:

[in]	pt	TCP Protocol Information
[in]	IPDst	Destination IP Address to which the packet will be destined.
[in]	PortDst	Destination Port to which the packet will be sent.
[in]	IPSrc	Source IP Address
[in]	PortSrc	Source Port
[in]	ack	Acknowledgment Number
[in]	seq	Sequence Number
[in]	flags	Control flags to be added to the packet.

Return values:

Not

Applicable.

int TCP6Output

(

TCPPROT *

pt

)

Description
The function is called to transmit the TCP packet over IPv6

Parameters:

[in]

pt

Pointer to the TCP control block

Return values:

Not

Applicable.

void TCP6TimeoutAdd

(

TCPPROT *

pt

)

Description
The function adds the TCP6 Protocol object to the timeout list

Parameters:

[in]

pt

The TCP Protocl object to be added to the timeout list.

Return values:

Not

Applicable.

void TCP6TimeoutRemove

(

TCPPROT *

pt

)

Description
The function removes the TCP6 Protocol object to the timeout list

Parameters:

[in]

pt

The TCP Protocl object to be removed from the timeout list.

Return values:

Not

Applicable.

uint TCP6ValidateMetrics	(	TCPPROT *	pt,
		uint	rcvmss
	)

Description
The function is called to update the TCP Information based on the socket route.

Parameters:

[in]	pt	Handle to the TCP protocol information
[in]	rcvmss	Received MSS.

Return values:

Current

MSS to advertise.

---

Copyright 2009, Texas Instruments Incorporated