Midgard Connection

Data Structures
struct	MidgardConnection
Functions
GType	midgard_connection_get_type (void)
MidgardConnection *	midgard_connection_new (void)
gboolean	midgard_connection_open (MidgardConnection *mgd, const char *name, GError *error)
gboolean	midgard_connection_open_config (MidgardConnection *mgd, MidgardConfig *config, GError *error)
void	midgard_connection_close (MidgardConnection *mgd)
gboolean	midgard_connection_set_sitegroup (MidgardConnection *mgd, const gchar *guid)
const gchar *	midgard_connection_get_sitegroup (MidgardConnection *mgd)
gboolean	midgard_connection_set_lang (MidgardConnection *mgd, const char *language)
const gchar *	midgard_connection_get_lang (MidgardConnection *mgd)
void	midgard_connection_set_loglevel (MidgardConnection *mgd, const gchar *level)
guint	midgard_connection_get_loglevel (MidgardConnection *mgd)
void	midgard_connection_set_loghandler (MidgardConnection *mgd, guint loghandler)
guint	midgard_connection_get_loghandler (MidgardConnection *mgd)

---

Detailed Description

The MidgardConnectionClass class structure .

---

Function Documentation

void midgard_connection_close (  MidgardConnection *  mgd  )

Closes database connection. Parameters: [in]  mgd  MidgardConnection object This function closes database connection , destroys MidgardConnection object and frees its memory. It may be replaced by g_object_unref, with one exception. When MidgardConnection object is initialized with midgard_connection_open function then MidgardConfig object is also destroyed and its memory is freed. Caller is responsible to free MidgardConfig object when is used with MidgardConnection and connection object was initialized with midgard_connection_open_config function. Definition at line 238 of file midgard_connection.c. References MidgardConnection::mgd.

const gchar* midgard_connection_get_lang (  MidgardConnection *  mgd  )

Returns language of the given MidgardConnection. Parameters: [in]  mgd  MidgardConnection for which language is returned. Returns: language's code string or NULL if no language is set for MidgardConnection Returned language value is the two-letter language code. Definition at line 287 of file midgard_connection.c. References _MidgardConnectionPrivate::lang, and MidgardConnection::private.

guint midgard_connection_get_loghandler (  MidgardConnection *  mgd  )

Get loghandler associated with MidgardConnection. Parameters: [in]  mgd  MidgardConnection object Returns: unsigned integer Returned unsigned integer value is associated with G_LOG_DOMAIN and MidgardConnection's loglevel currently used by application. Definition at line 364 of file midgard_connection.c. References _MidgardConnectionPrivate::loghandler, and MidgardConnection::private.

guint midgard_connection_get_loglevel (  MidgardConnection *  mgd  )

Get loglevel's value. Parameters: [in]  MidgardConnection  object Returns: unsigned integer Returned value is an unsigned integer flag specified by GLogLevelFlags. Definition at line 344 of file midgard_connection.c. References _MidgardConnectionPrivate::loglevel, and MidgardConnection::private.

const gchar* midgard_connection_get_sitegroup (  MidgardConnection *  mgd  )

Return the sitegroup of the given MidgardConnection. Returned string is a guid of a sitegroup which is used for a connection. Parameters: [in]  mgd  MidgardConnection for which sitegroup is returned Returns: sitegroup's guid string Midgard sitegroups concept: http://www.midgard-project.org/documentation/concepts-sitegroups Definition at line 264 of file midgard_connection.c. References MidgardConnection::private, and _MidgardConnectionPrivate::sitegroup.

GType midgard_connection_get_type (  void   )

Returns the MidgardConnection value type. Registers the type as a fundamental GType unless already registered. Definition at line 86 of file midgard_connection.c.

MidgardConnection* midgard_connection_new (  void   )

Creates new MidgardConnection object instance. Returns: pointer to MidgardConnection object or NULL on failure. Initializes new instance of MidgardConnection object type. NULL is returned when object can not be initialized. MidgardConnectionClass has no properties registered as class members. Every internal data of MidgardConnection object is accessible with API functions, and is not settable or gettable as property's value. Particular methods should be implemented for language bindings. MidgardConnection objects holds runtime ( or request ) non persistent data like language, sitegroup, authentication type. Persistent data like database name, blobs directory are associated with MidgardConfig object. Definition at line 109 of file midgard_connection.c.

gboolean midgard_connection_open (  MidgardConnection *  mgd, const char *  name, GError *  error )

Opens a connection to the named Midgard database. The configuration file for the named database is read from the standard configuration directories and used as the configuration for the created connection. If the named database configuration can not be read or the connection fails, then NULL is returned and an error message is written to the optional error argument. Parameters: [in]  mgd  newly initialized MidgardConnection object [in]  name  name of the Midgard database configuration [out]  error  placeholder for an error message, or NULL Returns: Midgard connection, or NULL Additionally this function creates new MidgardConfig object instance, which is accessible with midgard_connection_config_get function. Definition at line 192 of file midgard_connection.c. References _MidgardConnectionPrivate::config, MGD_ERR_USER_DATA, midgard_config_new(), midgard_config_read_file(), midgard_set_error(), and MidgardConnection::private. Here is the call graph for this function:

gboolean midgard_connection_open_config (  MidgardConnection *  mgd, MidgardConfig *  config, GError *  error )

Opens a Midgard connection with the given configuration. If the connection fails, then NULL is returned and an error message is written to the optional error argument. Parameters: [in]  mgd  newly initialized MidgardConnection object [in]  config  Midgard configuration object [out]  error  placeholder for an error message, or NULL Returns: Midgard connection, or NULL Definition at line 222 of file midgard_connection.c. References _MidgardConnectionPrivate::config, and MidgardConnection::private.

gboolean midgard_connection_set_lang (  MidgardConnection *  mgd, const char *  language )

Sets the language of the given Midgard connection. The connection language affects all MultiLang database accesses as described in the Midgard MultiLang documentation. The given language parameter is the two-letter language code stored in the language table in the Midgard database. This method returns FALSE if the given language is not found. Parameters: connection  the Midgard connection whose language is changed [in]  language  the new language code Returns: TRUE if the connection language was changed, FALSE otherwise See also: http://www.midgard-project.org/documentation/midgard-and-multilingual-content/ Definition at line 274 of file midgard_connection.c. References _MidgardConnectionPrivate::lang, and MidgardConnection::private.

void midgard_connection_set_loghandler (  MidgardConnection *  mgd, guint  loghandler )

Sets loghandler of the given MidgardConnection. Parameters: [in]  MidgardConnection  object [in]  loghandler  id Sets internal loghandler id associated with G_LOG_DOMAIN and loglevel. Caller is responsible to remove loghandler using g_log_remove_handler when new loglevel for G_LOG_DOMAIN is set. Definition at line 352 of file midgard_connection.c. References _MidgardConnectionPrivate::loghandler, and MidgardConnection::private.

void midgard_connection_set_loglevel (  MidgardConnection *  mgd, const gchar *  level )

Sets log level of the given MidgardConnection. Parameters: mgd  MidgardConnection object [in]  level  Loglevel string Overwrites internal MidgardConnection's log level defined in configuration file. By default MidgardConnection holds loglevel which is associated with and duplicated from MidgardConfig. MidgardConfig object's log level isn't changed by this function Definition at line 295 of file midgard_connection.c. References MidgardConnection::err, _MidgardConnectionPrivate::loglevel, MGD_ERR_INTERNAL, midgard_set_error(), and MidgardConnection::private. Here is the call graph for this function:

gboolean midgard_connection_set_sitegroup (  MidgardConnection *  mgd, const gchar *  guid )

Sets sitegroup's value for the given MidgardConnection. Parameters: mgd  MidgardConnection. [in]  guid,value  with sitegroup identifier Returns: TRUE when connection's sitegroup was set, FALSE otherwise. Given sitegroup's guid must be the value of exisiting in database sitegroup's record. When there is no sitegroup with such guid or sitegroup is private , then connection's sitegroup is unchanged and method return FALSE. Definition at line 251 of file midgard_connection.c. References MidgardConnection::private, and _MidgardConnectionPrivate::sitegroup.

---