xt_handles.h File Reference

maps integers to data pointers More...

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

Go to the source code of this file.

Typedefs
typedef struct Xt_handle_set_type_ *	Xt_handle_set_type

Functions
int	xt_handle_is_valid (Xt_handle_set_type hset, int handle)
Xt_handle_set_type	xt_handle_set_new (int cap)
void	xt_handle_set_delete (Xt_handle_set_type hset)
int	xt_handle_new (Xt_handle_set_type hset, void *p)
void	xt_handle_delete (Xt_handle_set_type hset, int handle)
void *	xt_handle2pointer (Xt_handle_set_type hset, int handle)

Detailed Description

maps integers to data pointers

contains utility routines for handle sets

Copyright

Copyright (C) 2016 Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Author

Jörg Behrens behre.nosp@m.ns@d.nosp@m.krz.d.nosp@m.e Moritz Hanke hanke.nosp@m.@dkr.nosp@m.z.de Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file xt_handles.h.

Typedef Documentation

Xt_handle_set_type

typedef struct Xt_handle_set_type_* Xt_handle_set_type

Definition at line 61 of file xt_handles.h.

Function Documentation

xt_handle2pointer()

void* xt_handle2pointer	(	Xt_handle_set_type	hset,
		int	handle
	)

inquires about user pointer connected with handle

Parameters

[in]	hset	handle set
[in]	handle	handle

Examples:

test_handles.c.

Definition at line 77 of file xt_handles.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_handle_delete()

void xt_handle_delete	(	Xt_handle_set_type	hset,
		int	handle
	)

unregisters handle

Parameters

[in,out]	hset	handle set
[in]	handle	handle

Examples:

test_handles.c.

Definition at line 151 of file xt_handles.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_handle_is_valid()

int xt_handle_is_valid	(	Xt_handle_set_type	hset,
		int	handle
	)

checks if a given handle is valid within a handle set

Parameters

[in]	hset	handle set
[in]	handle	handle within handle set

Examples:

test_handles.c.

Definition at line 70 of file xt_handles.c.

Here is the caller graph for this function:

xt_handle_new()

int xt_handle_new	(	Xt_handle_set_type	hset,
		void *	p
	)

registers user pointer with a new handle

Parameters

[in,out]	hset	handle set
[in]	p	pointer to user data

Returns

returns integer handle

Examples:

test_handles.c.

Definition at line 130 of file xt_handles.c.

Here is the call graph for this function:

Here is the caller graph for this function:

xt_handle_set_delete()

void xt_handle_set_delete

(

Xt_handle_set_type

hset

)

destructor

Parameters

[in,out]

hset

handle set

Examples:

test_handles.c.

Definition at line 123 of file xt_handles.c.

xt_handle_set_new()

Xt_handle_set_type xt_handle_set_new

(

int

cap

)

constructor for handle sets

Parameters

[in]

cap

start capacity (size of handle space)

Returns

returns an empty handle set of capacity cap

Examples:

test_handles.c.

Definition at line 82 of file xt_handles.c.

Here is the caller graph for this function: