Library functions to manage client

Functions
wcHandle DLLEXPORT	wcClientCreate ()
	Create client. More...
wcRCode DLLEXPORT	wcClientStart (wcHandle client)
	Launch client. More...
wcRCode DLLEXPORT	wcClientAuth (wcHandle client, const char *aLogin, const char *aPwrd)
	Authorize client on the server host. More...
wcRCode DLLEXPORT	wcClientProceed (wcHandle client)
	Call the asynchronous client update stage. More...
wcRCode DLLEXPORT	wcClientTasksProceed (wcHandle client)
	Call the synchronous client update stage. More...
wcRCode DLLEXPORT	wcClientDisconnect (wcHandle client)
	Disconnect client from the server host. More...
wcRCode DLLEXPORT	wcClientDestroy (wcHandle client)
	Destroy client. More...

Detailed Description

Function Documentation

wcClientCreate()

wcHandle DLLEXPORT wcClientCreate

(

)

Create client.

Returns

wcHandle The value of the client handle.

See also

wcClientDestroy

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientStart()

wcRCode DLLEXPORT wcClientStart

(

wcHandle

client

)

Launch client.

The function initializes and starts the client's working thread.

Parameters

client

The client handle.

Returns

wcRCode WC_OK or error code.

See also

wcRCode

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientAuth()

wcRCode DLLEXPORT wcClientAuth	(	wcHandle	client,
		const char *	aLogin,
		const char *	aPwrd
	)

Authorize client on the server host.

See protocol request authorize.json.

Parameters

client	The client handle.
aLogin	The name of the user on the server.
aPwrd	The password of the user on the server.

Returns

wcRCode WC_OK or error code.

See also

wcRCode, wcClientDisconnect

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientProceed()

wcRCode DLLEXPORT wcClientProceed

(

wcHandle

client

)

Call the asynchronous client update stage.

Thread safe. The function can be called from a separate thread.

Parameters

client

The client handle.

Returns

wcRCode WC_OK or error code.

See also

wcRCode

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientTasksProceed()

wcRCode DLLEXPORT wcClientTasksProceed

(

wcHandle

client

)

Call the synchronous client update stage.

Warning

Not thread safe! The function must be called from the main or UI thread.

Parameters

client

The client handle.

Returns

wcRCode WC_OK or error code.

See also

wcRCode, wcSetTaskCallback, wccbkSynchroUpdateTask

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientDisconnect()

wcRCode DLLEXPORT wcClientDisconnect

(

wcHandle

client

)

Disconnect client from the server host.

Parameters

client

The client handle.

Returns

wcRCode WC_OK or error code.

See also

wcClientCreate, wcClientStart, wcClientAuth, wcClientDestroy

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.

wcClientDestroy()

wcRCode DLLEXPORT wcClientDestroy

(

wcHandle

client

)

Destroy client.

Parameters

client

The client handle.

Returns

wcRCode WC_OK or error code.

See also

wcClientCreate

Examples

lib_test/main.cpp, media_test/main.cpp, multithread_test/main.cpp, theora_test/input_strm/main.cpp, and theora_test/output_strm/main.cpp.