TCPFindROMArrayEx Function

WORD TCPFindROMArrayEx(
    TCP_SOCKET hTCP, 
    ROM BYTE* cFindArray, 
    WORD wLen, 
    WORD wStart, 
    WORD wSearchLen, 
    BOOL bTextCompare
);

This function finds the first occurrance of an array of bytes in the TCP RX buffer. It can be used by an application to abstract searches out of their own application code. For increased efficiency, the function is capable of limiting the scope of search to a specific range of bytes. It can also perform a case-insensitive search if required. 

For example, if the buffer contains "I love PIC MCUs!" and the search array is "love" with a length of 4, a value of 2 will be returned.

TCP is initialized.

Since this function usually must transfer data from external storage to internal RAM for comparison, its performance degrades significantly when the buffer is full and the array is not found. For better performance, try to search for characters that are expected to exist or limit the scope of the search as much as possible. The HTTP2 module, for example, uses this function to parse headers. However, it searches for newlines, then the separating colon, then reads the header name to RAM for final comparison. This has proven to be significantly faster than searching for full header name strings outright. 

This function is aliased to TCPFindArrayEx on non-PIC18 platforms.