Properties of FB_HttpClient

Consideration for Online Monitoring

The properties provided by FB_HttpClient can be used also in online monitoring. However, you must consider the value displayed corresponds to value from the last call in application program.

Overview

Name	Data type	Access	Description
ContentLength	UDINT	Read	Indicates the length of the received content which is stored in the response buffer.
ContentStartIndex	UDINT	Read	Indicates the index of the first byte of the received content which is stored in the response buffer.
ErrorResult	ET_Result	Read	Indicates the cause of the state Error.
HeaderLength	UDINT	Read	Indicates the length of the header which is stored in the response buffer. The header starts as of the first byte of the response buffer.
IsConnected	BOOL	Read	Indicates if the TCP connection to the HTTP server is active.
IsContentChunked	BOOL	Read	Indicates if the encoding of the received content is chunked.
IsDeleteActive	BOOL	Read	Indicates if a Delete request is active or the response is not yet acknowledged.
IsGetActive	BOOL	Read	Indicates if a Get request is active or the response is not yet acknowledged.
IsHeadActive	BOOL	Read	Indicates if a Head request is active or the response is not yet acknowledged.
IsPostActive	BOOL	Read	Indicates if a Post request is active or the response is not yet acknowledged.
IsPutActive	BOOL	Read	Indicates if a Put request is active or the response is not yet acknowledged.
ResponseLength	UDINT	Read	Indicates the length of the received response which is stored in the response buffer.
State	ET_State	Read	Indicates the state of the HTTP client, monitors the connection, and processes initiated commands (for example connect, requests, or disconnect). Therefore, the property must be called cyclically in your program. NOTE: The returned value can be used as state variable inside your own state machine. Refer to the Code Example for more details.
StatusClass	ET_StatusClass	Read	Indicates the HTTP status class of the received response.
StatusCode	UINT	Read	Indicates the HTTP status code of the received response.
IsTlsUsed	BOOL	Read	Indicates if the connection to the server is secured via TLS (Transport Layer Security).
OAuthCredentials	IF_OAuthCredentials	Set	If the interface providing the credentials is set, the OAuth protocol is used with the next HTTP command to retrieve the access token required to access protected resources.