TCPSSLPutRecordHeader Function

Microchip TCP/IP Stack

Microchip TCP/IP Stack Help
TCPSSLPutRecordHeader Function
C
void TCPSSLPutRecordHeader(
    TCP_SOCKET hTCP, 
    BYTE* hdr, 
    BOOL recDone
);
Description

This function writes an SSL record header to the pending TCP SSL data, then indicates that the data is ready to be sent by moving the txHead pointer. 

If the record is complete, set recDone to TRUE. The sslTxHead pointer will be moved forward 5 bytes to leave space for a future record header. If the record is only partially sent, use FALSE and to leave the pointer where it is so that more data can be added to the record. Partial records can only be used for the SERVER_CERTIFICATE handshake message.

Preconditions

TCP is initialized, and hTCP is connected with an active SSL session.

Parameters
Parameters 
Description 
hTCP 
TCP connection to write the header and transmit with 
hdr 
Record header (5 bytes) to send or NULL to just move the pointerctx 
recDone 
TRUE if the record is done, FALSE otherwise 
Returns

None

Remarks

This function should never be called by an application. It is used only by the SSL module itself.

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