proxy_server.h File Reference

#include <freerdp/api.h>
#include <freerdp/server/proxy/proxy_config.h>
#include <freerdp/server/proxy/proxy_modules_api.h>

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

Functions
FREERDP_API void	pf_server_free (proxyServer *server)
	pf_server_free Cleans up a (stopped) proxy server instance. More...
FREERDP_API proxyServer *	pf_server_new (const proxyConfig *config)
	pf_server_new Creates a new proxy server instance More...
FREERDP_API BOOL	pf_server_add_module (proxyServer *server, proxyModuleEntryPoint ep, void *userdata)
	pf_server_add_module Allows registering proxy modules that are build-in instead of shipped as separate module loaded at runtime. More...
FREERDP_API BOOL	pf_server_start (proxyServer *server)
	pf_server_start Starts the proxy, binding the configured port. More...
FREERDP_API BOOL	pf_server_start_from_socket (proxyServer *server, int socket)
	pf_server_start_from_socket Starts the proxy using an existing bound socket More...
FREERDP_API BOOL	pf_server_start_with_peer_socket (proxyServer *server, int socket)
	pf_server_start_with_peer_socket Use existing peer socket More...
FREERDP_API void	pf_server_stop (proxyServer *server)
	pf_server_stop Stops a server instance asynchronously. Can be called from any thread to stop a running server instance. More...
FREERDP_API BOOL	pf_server_run (proxyServer *server)
	pf_server_run This (blocking) function runs the main loop of the proxy. More...

Function Documentation

pf_server_add_module()

FREERDP_API BOOL pf_server_add_module	(	proxyServer *	server,
		proxyModuleEntryPoint	ep,
		void *	userdata
	)

pf_server_add_module Allows registering proxy modules that are build-in instead of shipped as separate module loaded at runtime.

Parameters

server	A proxy instance to add the module to. Must NOT be NULL
ep	The proxy entry function to add. Must NOT be NULL
userdata	Custom data for the module. May be NULL

Returns

TRUE for success, FALSE otherwise.

Here is the call graph for this function:

pf_server_free()

FREERDP_API void pf_server_free

(

proxyServer *

server

)

pf_server_free Cleans up a (stopped) proxy server instance.

Parameters

server

The proxy server to clean up. Might be NULL.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_new()

FREERDP_API proxyServer* pf_server_new

(

const proxyConfig *

config

)

pf_server_new Creates a new proxy server instance

Parameters

config

The proxy server configuration to use. Must NOT be NULL.

Returns

A new proxy server instance or NULL on failure.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_run()

FREERDP_API BOOL pf_server_run

(

proxyServer *

server

)

pf_server_run This (blocking) function runs the main loop of the proxy.

Parameters

server

The server instance. Must NOT be NULL.

Returns

TRUE for successful termination, FALSE otherwise.

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_start()

FREERDP_API BOOL pf_server_start

(

proxyServer *

server

)

pf_server_start Starts the proxy, binding the configured port.

Parameters

server

The server instance. Must NOT be NULL.

Returns

TRUE for success, FALSE on error

Here is the call graph for this function:

Here is the caller graph for this function:

pf_server_start_from_socket()

FREERDP_API BOOL pf_server_start_from_socket	(	proxyServer *	server,
		int	socket
	)

pf_server_start_from_socket Starts the proxy using an existing bound socket

Parameters

server	The server instance. Must NOT be NULL.
socket	The bound socket to wait for events on.

Returns

TRUE for success, FALSE on error

Here is the call graph for this function:

pf_server_start_with_peer_socket()

FREERDP_API BOOL pf_server_start_with_peer_socket	(	proxyServer *	server,
		int	socket
	)

pf_server_start_with_peer_socket Use existing peer socket

Parameters

server	The server instance. Must NOT be NULL.
socket	Ready to use peer socket

Returns

TRUE for success, FALSE on error

Here is the call graph for this function:

pf_server_stop()

FREERDP_API void pf_server_stop

(

proxyServer *

server

)

pf_server_stop Stops a server instance asynchronously. Can be called from any thread to stop a running server instance.

Parameters

server

A pointer to the server instance to stop. May be NULL.

Here is the call graph for this function:

Here is the caller graph for this function: