Identifiers

Detailed Description

Collaboration diagram for Identifiers:

Functions
int	gxPLGenerateUniqueId (const gxPLApplication *app, char *id, int len)
	Generates a fairly unique identifier. More...
int	gxPLIdCmp (const gxPLId *id1, const gxPLId *id2)
	Compare two identifiers. More...
int	gxPLIdCopy (gxPLId *dst, const gxPLId *src)
	Copy two identifiers. More...
int	gxPLIdDeviceIdSet (gxPLId *id, const char *device_id)
	Sets device identifier. More...
int	gxPLIdFromString (gxPLId *dest, char *src)
	Gets an identifier from a string. More...
int	gxPLIdInstanceIdSet (gxPLId *id, const char *instance_id)
	Sets instance identifier. More...
int	gxPLIdSet (gxPLId *id, const char *vendor_id, const char *device_id, const char *instance_id)
	Sets an identifier. More...
int	gxPLIdVendorIdSet (gxPLId *id, const char *vendor_id)
	Sets vendor identifier. More...

Function Documentation

int gxPLGenerateUniqueId	(	const gxPLApplication *	app,
		char *	id,
		int	len
	)

Generates a fairly unique identifier.

The identifier consists only of valid characters in xPL (0-9,a-z). The algorithm uses the hardware address of the host and the time of day. Two spaced successive calls of less than one millisecond give the same result.

Parameters

app	pointer to a gxPLApplication object
id	the generated id string
len	length of the generated string not including the terminating null character

Returns

length of the generated string, -1 if error occurs

int gxPLIdCmp	(	const gxPLId *	id1,
		const gxPLId *	id2
	)

Compare two identifiers.

Parameters

id1	first id
id2	second id

Returns

It returns an integer less than, equal to, or greater than zero if id1 is found, respectively, to be less than, to match, or be greater than id2.

int gxPLIdCopy	(	gxPLId *	dst,
		const gxPLId *	src
	)

Copy two identifiers.

Parameters

dst	destination
src	source

Returns

0, -1 if an error occurs

int gxPLIdDeviceIdSet	(	gxPLId *	id,
		const char *	device_id
	)

Sets device identifier.

Parameters

id	pointer to the identifier
device_id	device identifier as string

Returns

0, -1 if an error occurs

int gxPLIdFromString	(	gxPLId *	dest,
		char *	src
	)

Gets an identifier from a string.

Parameters

dest	destination
src	source string vendor-device.instance\0, this string is modified by the function and is no longer valid after call.

Returns

0, -1 if an error occurs

Examples:

sender/gxpl-sender.c.

int gxPLIdInstanceIdSet	(	gxPLId *	id,
		const char *	instance_id
	)

Sets instance identifier.

Parameters

id	pointer to the identifier
instance_id	instance identifier as string

Returns

0, -1 if an error occurs

int gxPLIdSet	(	gxPLId *	id,
		const char *	vendor_id,
		const char *	device_id,
		const char *	instance_id
	)

Sets an identifier.

Parameters

id	pointer to the identifier
vendor_id	vendor identifier as string
device_id	device identifier as string
instance_id	instance identifier as string

Returns

0, -1 if an error occurs

int gxPLIdVendorIdSet	(	gxPLId *	id,
		const char *	vendor_id
	)

Sets vendor identifier.

Parameters

id	pointer to the identifier
vendor_id	vendor identifier as string

Returns

0, -1 if an error occurs