proxy_config.h File Reference

#include <winpr/wtypes.h>
#include <winpr/ini.h>
#include <freerdp/api.h>
#include <freerdp/server/proxy/proxy_modules_api.h>

This graph shows which files directly or indirectly include this file:

Data Structures
struct	proxyConfig

Functions
FREERDP_API BOOL	pf_server_config_dump (const char *file)
	pf_server_config_dump Dumps a default INI configuration file More...
FREERDP_API proxyConfig *	server_config_load_ini (wIniFile *ini)
	server_config_load_ini Create a proxyConfig from a already loaded INI file. More...
FREERDP_API proxyConfig *	pf_server_config_load_file (const char *path)
	pf_server_config_load_file Create a proxyConfig from a INI file found at path. More...
FREERDP_API proxyConfig *	pf_server_config_load_buffer (const char *buffer)
	pf_server_config_load_buffer Create a proxyConfig from a memory string buffer in INI file format More...
FREERDP_API void	pf_server_config_print (const proxyConfig *config)
	pf_server_config_print Print the configuration to stdout More...
FREERDP_API void	pf_server_config_free (proxyConfig *config)
	pf_server_config_free Releases all resources associated with proxyConfig More...
FREERDP_API size_t	pf_config_required_plugins_count (const proxyConfig *config)
	pf_config_required_plugins_count More...
FREERDP_API const char *	pf_config_required_plugin (const proxyConfig *config, size_t index)
	pf_config_required_plugin More...
FREERDP_API size_t	pf_config_modules_count (const proxyConfig *config)
	pf_config_modules_count More...
FREERDP_API const char **	pf_config_modules (const proxyConfig *config)
	pf_config_modules More...
FREERDP_API BOOL	pf_config_clone (proxyConfig **dst, const proxyConfig *config)
	pf_config_clone Create a copy of the configuration More...
FREERDP_API BOOL	pf_config_plugin (proxyPluginsManager *plugins_manager, void *userdata)
	pf_config_plugin Register a proxy plugin handling event filtering defined in the configuration. More...
FREERDP_API const char *	pf_config_get (const proxyConfig *config, const char *section, const char *key)
	pf_config_get get a value for a section/key More...

Function Documentation

pf_config_clone()

FREERDP_API BOOL pf_config_clone	(	proxyConfig **	dst,
		const proxyConfig *	config
	)

pf_config_clone Create a copy of the configuration

Parameters

dst	A pointer that receives the newly allocated copy
config	The source configuration to copy

Returns

TRUE for success, FALSE otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

pf_config_get()

FREERDP_API const char* pf_config_get	(	const proxyConfig *	config,
		const char *	section,
		const char *	key
	)

pf_config_get get a value for a section/key

Parameters

config	A pointer to the proxyConfig. Must NOT be NULL.
section	The name of the section the key is in, must not be NULL
key	The name of the key to look for. Must not be NULL

Returns

A pointer to the value for section/key or NULL if not found

Here is the call graph for this function:

Here is the caller graph for this function:

pf_config_modules()

FREERDP_API const char** pf_config_modules

(

const proxyConfig *

config

)

pf_config_modules

Parameters

config

A pointer to the proxyConfig. Must NOT be NULL.

Returns

An array of strings of size pf_config_modules_count with the module names.

Here is the caller graph for this function:

pf_config_modules_count()

FREERDP_API size_t pf_config_modules_count

(

const proxyConfig *

config

)

pf_config_modules_count

Parameters

config

A pointer to the proxyConfig. Must NOT be NULL.

Returns

The number of proxy modules configured.

Here is the caller graph for this function:

pf_config_plugin()

FREERDP_API BOOL pf_config_plugin	(	proxyPluginsManager *	plugins_manager,
		void *	userdata
	)

pf_config_plugin Register a proxy plugin handling event filtering defined in the configuration.

Parameters

plugins_manager	The plugin manager
userdata	A proxyConfig* to use as reference

Returns

TRUE for success, FALSE for failure

Here is the call graph for this function:

Here is the caller graph for this function:

pf_config_required_plugin()

FREERDP_API const char* pf_config_required_plugin	(	const proxyConfig *	config,
		size_t	index
	)

pf_config_required_plugin

Parameters

config	A pointer to the proxyConfig. Must NOT be NULL.
index	The index of the plugin to return

Returns

The name of the plugin or NULL.

Here is the caller graph for this function:

pf_config_required_plugins_count()

FREERDP_API size_t pf_config_required_plugins_count

(

const proxyConfig *

config

)

pf_config_required_plugins_count

Parameters

config

A pointer to the proxyConfig. Must NOT be NULL.

Returns

The number of required plugins configured.

Here is the caller graph for this function:

pf_server_config_dump()

FREERDP_API BOOL pf_server_config_dump

(

const char *

file

)

pf_server_config_dump Dumps a default INI configuration file

Parameters

file	The file to write to. Existing files are truncated.

Returns

TRUE for success, FALSE if the file could not be written.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_config_free()

FREERDP_API void pf_server_config_free

(

proxyConfig *

config

)

pf_server_config_free Releases all resources associated with proxyConfig

Parameters

config

A pointer to the proxyConfig to clean up. Might be NULL.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_config_load_buffer()

FREERDP_API proxyConfig* pf_server_config_load_buffer

(

const char *

buffer

)

pf_server_config_load_buffer Create a proxyConfig from a memory string buffer in INI file format

Parameters

buffer

A pointer to the '\0' terminated INI string.

Returns

A proxyConfig or NULL in case of failure.

Here is the call graph for this function:

pf_server_config_load_file()

FREERDP_API proxyConfig* pf_server_config_load_file

(

const char *

path

)

pf_server_config_load_file Create a proxyConfig from a INI file found at path.

Parameters

path	The path of the INI file

Returns

A proxyConfig or NULL in case of failure.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_config_print()

FREERDP_API void pf_server_config_print

(

const proxyConfig *

config

)

pf_server_config_print Print the configuration to stdout

Parameters

config

A pointer to the configuration to print. Must NOT be NULL.

Here is the call graph for this function:

Here is the caller graph for this function:

server_config_load_ini()

FREERDP_API proxyConfig* server_config_load_ini

(

wIniFile *

ini

)

server_config_load_ini Create a proxyConfig from a already loaded INI file.

Parameters

ini	A pointer to the parsed INI file. Must NOT be NULL.

Returns

A proxyConfig or NULL in case of failure.

Here is the call graph for this function:

Here is the caller graph for this function: