SSLRxRecord Function

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
SSLRxRecord Function
C
WORD SSLRxRecord(
    TCP_SOCKET hTCP, 
    BYTE sslStubID
);
Description

Reads at most one SSL Record header from the TCP stream and determines what to do with the rest of the data. If not all of the data is available for the record, then the function returns and future call(s) to SSLRxRecord() will process the remaining data until the end of the record is reached. If this call process data from a past record, the next record will not be started until the next call.

Preconditions

The specified SSL stub is initialized and the TCP socket is connected.

Parameters
Parameters 
Description 
hTCP 
The TCP socket from which to read 
id 
The active SSL stub ID 
Returns

WORD indicating the number of data bytes there were decrypted but left in the stream.

Remarks

SSL record headers, MAC footers, and symetric cipher block padding (if any) will be extracted from the TCP stream by this function. Data will be decrypted but left in the stream.

Microchip TCP/IP Stack 5.42.08 - June 15, 2013
Copyright © 2012 Microchip Technology, Inc.  All rights reserved.