Unix/Linux Go Back    

OpenSolaris 2009.06 - man page for libggz (opensolaris section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

libggz(3)			       C Library Functions				libggz(3)

       libggz - The GGZ Gaming Zone base library

       libggz  is  used by GGZ Gaming Zone server, the ggzcore library and other components. This
       library handles networking, configuration files, structure management functions and  wrap-
       pers around glibc functions.

       The libggz library contains different groups of functions:

       Memory handling

	   These  functions  provide an alternative to the normal C library functions for dynami-
	   cally allocating memory. They keep track of memory allocated by storing  the  name  of
	   the	function  and file in which they were called similar to glibc but are more conve-
	   nient to use. For instance, ggz_strdup(NULL) returns NULL  instead  of  crashing,  and
	   ggz_malloc() includes a reference counter to be used for debugging in combination with
	   ggz_free(). With enabled MEMORY  debugging  the  function  ggz_memory_check()  may  be
	   called to make sure all allocated memory has been freed.

       Configuration file management

	   This  group	of  functions  is  used  for XML configuration file routines to store and
	   retrieve values. For example, the ggz_conf_parse() function can be used to open a con-
	   fig	file. To create such file automatically the GGZ_CONF_CREATE must be specified. If
	   exactly the same configuration pathname is being opened more than one time, the origi-
	   nal handle is being returned and only one copy is retained within memory.

	   Configuration  values  are  stored  using a system of sections and keys. A key must be
	   unique within a section and cannot be both an integer and a	string	within	the  same
	   key.  Section and key names may contain any characters except an equal sign.  Although
	   keys may not have leading or trailing whitespace, section names may have them.  It  is
	   suggested  that  any  whitespace (other than possibly internal spaces) be avoided when
	   specifying section and key names.

	   For writing the values to the physical file, the ggz_conf_commit()  function  must  be
	   called, otherwise all values are in the memory only, which makes writing multiple val-
	   ues in rapid succession more efficient, as the entire  file	must  be  regenerated  in
	   order to be written to the flat-file format of the configuration file.

	   The string and list reading functions return dynamically allocated memory to the call-
	   er.	The user is responsible for calling ggz_free() on this memory when they no longer
	   need the returned values.

	   All	memory	used  internally  by  the  configuration  functions will be released when
	   ggz_conf_cleanup() is called.  Note that this does not commit any changes made to  the
	   configuration files, so the ggz_conf_commit() have to be called to do such commit. The
	   ggz_conf_cleanup() is expected to call this at program  termination,  but  it  may  be
	   called at any time earlier than termination and new files may be subsequently opened.

       Debug functions

	   The functions allow switching on and off debug messages for a certain tag.

       Network functions

	   Those  functions,  historically known as the easysock library, permits the creation of
	   server or client sockets, compatible with IPv6, as well as reading and  writing  basic
	   datatypes such as integers or strings.

       Security functions

	   This  group of functions are for both cryptographic hash creation and comparison using
	   the gcrypt library, and for TLS encryption for network channels using OpenSSL.

       The following files are used by this library:

       /usr/lib/libggz.so	       The base GGZ Gaming Zone shared library

       See attributes(5) for descriptions of the following attributes:

       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       |Availability		     |SUNWgnome-games		   |
       |Interface stability	     |Volatile			   |

       ggz_h(3), ggzcore_h(3), ggzmod_h(3), libggzcore(3), libggzmod(3), attributes(5),  ggz.mod-
       ules(5), gnome-interfaces(5), ggz(6), ggz-config(6), ggz(7)

       GGZ Gaming Zone:


       Written by Michal Pryc, Sun Microsystems Inc., 2008.

SunOS 5.11				   29 May 2008					libggz(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 01:27 AM.