Initialization

Library initialization and error handling. More...

Typedefs
typedef void	LIPC

Enumerations
enum	LIPCcode {   LIPC_OK = 0,   LIPC_ERROR_UNKNOWN,   LIPC_ERROR_INTERNAL,   LIPC_ERROR_NO_SUCH_SOURCE,   LIPC_ERROR_OPERATION_NOT_SUPPORTED,   LIPC_ERROR_OUT_OF_MEMORY,   LIPC_ERROR_SUBSCRIPTION_FAILED,   LIPC_ERROR_NO_SUCH_PARAM,   LIPC_ERROR_NO_SUCH_PROPERTY,   LIPC_ERROR_ACCESS_NOT_ALLOWED,   LIPC_ERROR_BUFFER_TOO_SMALL,   LIPC_ERROR_INVALID_HANDLE,   LIPC_ERROR_INVALID_ARG,   LIPC_ERROR_OPERATION_NOT_ALLOWED,   LIPC_ERROR_PARAMS_SIZE_EXCEEDED,   LIPC_ERROR_TIMED_OUT,   LIPC_ERROR_SERVICE_NAME_TOO_LONG,   LIPC_ERROR_DUPLICATE_SERVICE_NAME,   LIPC_ERROR_INIT_DBUS,   LIPC_PROP_ERROR_INVALID_STATE = 0x100,   LIPC_PROP_ERROR_NOT_INITIALIZED = 0x101,   LIPC_PROP_ERROR_INTERNAL = 0x102 }

Functions
LIPC *	LipcOpenNoName (void)
LIPC *	LipcOpen (const char *service)
LIPC *	LipcOpenEx (const char *service, LIPCcode *code)
void	LipcClose (LIPC *lipc)
const char *	LipcGetServiceName (LIPC *lipc)
const char *	LipcGetErrorString (LIPCcode code)

Detailed Description

Library initialization and error handling.

Typedef Documentation

typedef void LIPC

LIPC library handler.

Enumeration Type Documentation

enum LIPCcode

Status codes returned by all sorts of LIPC library functions.

Warning

This list was obtained from the LipcGetErrorString() function and may be not complete - be prepared for other values as well.

Function Documentation

LIPC* LipcOpenNoName

(

void

)

Initialize LIPC library without registering a new service.

Returns

On success the LIPC library handler is returned, which should be closed with the LipcClose(). Upon error this function returns NULL.

LIPC* LipcOpen

(

const char *

service

)

Initialize LIPC library and register a new service.

Parameters

service

The service name which should be registered. The name has to be a fully qualified dot-separated identifier, e.g. "org.MyService".

Returns

On success the LIPC library handler is returned, which should be closed with the LipcClose(). Upon error this function returns NULL.

LIPC* LipcOpenEx	(	const char *	service,
		LIPCcode *	code
	)

Initialize LIPC library and register a new service.

This function is an extended version of the LipcOpen().

Parameters

service	The service name which should be registered. The name has to be a fully qualified dot-separated identifier, e.g. "org.MyService".
code	If not NULL, the status code will be stored in this argument.

Returns

On success the LIPC library handler is returned, which should be closed with the LipcClose(). Upon error this function returns NULL.

void LipcClose

(

LIPC *

lipc

)

Close the LIPC handler and release all associated resources.

Parameters

lipc	LIPC library handler.

const char* LipcGetServiceName

(

LIPC *

lipc

)

Get the service name associated with the LIPC handler.

Parameters

lipc	LIPC library handler.

Returns

The service name which was registered during LIPC opening or NULL if the handler was obtained by the call to the LipcOpenNoName().

const char* LipcGetErrorString

(

LIPCcode

code

)

Get status code in the string format.

Parameters

code	The status code.

Returns

String with the human-readable status.