Exported Functions

group Proxy_Protocol_Exported_Functions

Functions for handling messages and managing contexts in the proxy protocol.

Functions

bool proxy_cfg_set_filter_type(uint8_t ctx_id, proxy_cfg_filter_type_t filter_type)

Set the type of filter used in proxy configuration.

This function is used to update the filter type of a specified proxy context.

Parameters:

  • ctx_id – [in] The index of the proxy context to update.

  • filter_type – [in] The filter type to be set, either white list or black list.

Return values:

  • true – The filter type was successfully set.

  • false – The operation failed, possibly due to an invalid context ID or resource constraints.

Returns:

Indicates whether the filter type was successfully set.

bool proxy_cfg_add_remove_addr(uint8_t ctx_id, bool add_remove, uint16_t addr[], uint16_t count)

Add or remove addresses from the proxy filter list.

This function allows for dynamic management of the addresses included in the filter list.

Parameters:

  • ctx_id – [in] The index of the proxy context where the operation is applied.

  • add_remove – [in] A Boolean flag indicating whether to add (true) or remove (false) addresses.

  • addr – [in] List of addresses to add or remove from the filter list.

  • count – [in] Number of addresses in the list.

Return values:

  • true – The operation was successful.

  • false – The operation failed, possibly due to an invalid context ID, an empty address list, or resource constraints.

Returns:

Indicates whether the address operation was successful.