TCP Public Members

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
TCP Public Members

The following functions and variables are available to the stack application.

Functions
 
Name 
Description 
 
Adjusts the relative sizes of the RX and TX buffers. 
 
Disconnects an open socket and destroys the socket handle, including server mode socket handles. 
 
Discards any pending data in the TCP RX FIFO. 
 
Disconnects an open socket. 
 
Searches for a string in the TCP RX buffer. 
 
Searches for a byte in the TCP RX buffer. 
 
Searches for a ROM string in the TCP RX buffer. 
 
Immediately transmits all pending TX data. 
 
Retrieves a single byte to a TCP socket. 
 
Reads an array of data bytes from a TCP socket's receive FIFO. The data is removed from the FIFO in the process. 
 
Obtains information about a currently open socket. 
 
Determines how many bytes are free in the RX FIFO. 
 
Determines how many bytes are pending in the TCP TX FIFO. 
 
Determines if a socket has an established connection. 
 
Determines how many bytes can be read from the TCP RX buffer. 
 
Determines how much free space is available in the TCP TX buffer. 
 
Opens a TCP socket for listening or as a client. 
 
Peaks at one byte in the TCP RX FIFO without removing it from the buffer. 
 
Reads a specified number of data bytes from the TCP RX FIFO without removing them from the buffer. 
 
Writes a single byte to a TCP socket. 
 
Writes an array from RAM to a TCP socket. 
 
Writes an array from ROM to a TCP socket. 
 
Writes a null-terminated string from ROM to a TCP socket. The null-terminator is not copied to the socket. 
 
Writes a null-terminated string from RAM to a TCP socket. The null-terminator is not copied to the socket. 
 
Copies data to/from various memory mediums. 
 
Copies data to/from various memory mediums. 
 
Self-clearing semaphore inidicating socket reset. 
Macros
 
Name 
Description 
 
The socket is invalid or could not be opened 
 
The socket is not known 
 
Resize flag: extra bytes go to RX 
 
Resize flag: extra bytes go to TX 
 
Resize flag: attempt to preserve RX buffer 
 
Resize flag: attempt to preserve TX buffer 
 
Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_IP_ADDRESS while STACK_CLIENT_MODE feature is not enabled. 
 
Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_NODE_INFO while STACK_CLIENT_MODE feature is not enabled. 
 
Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_RAM_HOST while STACK_CLIENT_MODE feature is not enabled. 
 
Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_ROM_HOST while STACK_CLIENT_MODE feature is not enabled. 
 
Create a server socket and ignore dwRemoteHost. 
 
Alias to TCPOpen as a client. 
 
Alias to TCPFindEx with no length parameter. 
 
Alias to TCPFindArrayEx with no length parameter. 
 
Alias to TCPFindROMArrayEx with no length parameter. 
 
Alias to TCPIsGetReady provided for API completeness 
 
Alias to TCPIsPutReady provided for API completeness 
 
Alias to TCPOpen as a server. 
Module
Microchip TCP/IP Stack 5.42.08 - June 15, 2013
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.