TCP Public Members

Microchip TCP/IP Stack

previous page next page

Microchip TCP/IP Stack Help

TCP Public Members

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

Functions

	Name	Description
	TCPAdjustFIFOSize	Adjusts the relative sizes of the RX and TX buffers.
	TCPClose	Disconnects an open socket and destroys the socket handle, including server mode socket handles.
	TCPDiscard	Discards any pending data in the TCP RX FIFO.
	TCPDisconnect	Disconnects an open socket.
	TCPFindArrayEx	Searches for a string in the TCP RX buffer.
	TCPFindEx	Searches for a byte in the TCP RX buffer.
	TCPFindROMArrayEx	Searches for a ROM string in the TCP RX buffer.
	TCPFlush	Immediately transmits all pending TX data.
	TCPGet	Retrieves a single byte to a TCP socket.
	TCPGetArray	Reads an array of data bytes from a TCP socket's receive FIFO. The data is removed from the FIFO in the process.
	TCPGetRemoteInfo	Obtains information about a currently open socket.
	TCPGetRxFIFOFree	Determines how many bytes are free in the RX FIFO.
	TCPGetTxFIFOFull	Determines how many bytes are pending in the TCP TX FIFO.
	TCPIsConnected	Determines if a socket has an established connection.
	TCPIsGetReady	Determines how many bytes can be read from the TCP RX buffer.
	TCPIsPutReady	Determines how much free space is available in the TCP TX buffer.
	TCPOpen	Opens a TCP socket for listening or as a client.
	TCPPeek	Peaks at one byte in the TCP RX FIFO without removing it from the buffer.
	TCPPeekArray	Reads a specified number of data bytes from the TCP RX FIFO without removing them from the buffer.
	TCPPut	Writes a single byte to a TCP socket.
	TCPPutArray	Writes an array from RAM to a TCP socket.
	TCPPutROMArray	Writes an array from ROM to a TCP socket.
	TCPPutROMString	Writes a null-terminated string from ROM to a TCP socket. The null-terminator is not copied to the socket.
	TCPPutString	Writes a null-terminated string from RAM to a TCP socket. The null-terminator is not copied to the socket.
	TCPRAMCopy	Copies data to/from various memory mediums.
	TCPRAMCopyROM	Copies data to/from various memory mediums.
	TCPWasReset	Self-clearing semaphore inidicating socket reset.

Macros

	Name	Description
	INVALID_SOCKET	The socket is invalid or could not be opened
	UNKNOWN_SOCKET	The socket is not known
	TCP_ADJUST_GIVE_REST_TO_RX	Resize flag: extra bytes go to RX
	TCP_ADJUST_GIVE_REST_TO_TX	Resize flag: extra bytes go to TX
	TCP_ADJUST_PRESERVE_RX	Resize flag: attempt to preserve RX buffer
	TCP_ADJUST_PRESERVE_TX	Resize flag: attempt to preserve TX buffer
	TCP_OPEN_IP_ADDRESS	Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_IP_ADDRESS while STACK_CLIENT_MODE feature is not enabled.
	TCP_OPEN_NODE_INFO	Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_NODE_INFO while STACK_CLIENT_MODE feature is not enabled.
	TCP_OPEN_RAM_HOST	Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_RAM_HOST while STACK_CLIENT_MODE feature is not enabled.
	TCP_OPEN_ROM_HOST	Emit an undeclared identifier diagnostic if code tries to use TCP_OPEN_ROM_HOST while STACK_CLIENT_MODE feature is not enabled.
	TCP_OPEN_SERVER	Create a server socket and ignore dwRemoteHost.
	TCPConnect	Alias to TCPOpen as a client.
	TCPFind	Alias to TCPFindEx with no length parameter.
	TCPFindArray	Alias to TCPFindArrayEx with no length parameter.
	TCPFindROMArray	Alias to TCPFindROMArrayEx with no length parameter.
	TCPGetRxFIFOFull	Alias to TCPIsGetReady provided for API completeness
	TCPGetTxFIFOFree	Alias to TCPIsPutReady provided for API completeness
	TCPListen	Alias to TCPOpen as a server.

Module

TCP

Stack API > TCP > Public Members

Contents | Index | Home

previous page start next page