Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

GTaskConnectionGroup


Data Structures

struct  _GTaskConnectionGroup
struct  _GTaskConnectionGroupClass
struct  _GTaskConnectionGroupPrivate

Defines

#define GTASK_CONNECTION_GROUP_TYPE   (gtask_connection_group_get_type())
#define GTASK_CONNECTION_GROUP(obj)
#define GTASK_CONNECTION_GROUP_CLASS(klass)
#define GTASK_IS_CONNECTION_GROUP(obj)
#define GTASK_IS_CONNECTION_GROUP_CLASS(klass)
#define GTASK_CONNECTION_GROUP_GET_CLASS(obj)

Typedefs

typedef _GTaskConnectionGroup GTaskConnectionGroup
typedef _GTaskConnectionGroupPrivate GTaskConnectionGroupPrivate
typedef _GTaskConnectionGroupClass GTaskConnectionGroupClass

Functions

void gtask_connection_group_class_init (GTaskConnectionGroupClass *klass)
void gtask_connection_group_init (GTaskConnectionGroup *group, gpointer g_class)
 initializes a GTaskConnectionGroup

void gtask_connection_group_dispose (GObject *obj)
void gtask_connection_group_finalize (GObject *obj)
GType gtask_connection_group_get_type (void)
 registers the GTaskConnectionGroup object with the GObject system if that has yet to be done and then returns the GType for GTaskConnectionGroup

GTaskConnectionGroup * gtask_connection_group_new (void)
 creates a new GTaskConnectionGroup

void gtask_connection_group_add_connection (GTaskConnectionGroup *group, GTaskConnection *conn)
 Adds in the passed in GTaskConnection to the GTaskConnectionGroup.

void gtask_connection_group_clear (GTaskConnectionGroup *group)
 Removes all GTaskConnections from the passed in GTaskConnectionGroup.

GSList * gtask_connection_group_get_list (GTaskConnectionGroup *group)
 Returns the internal GSList that holds all of the GTaskConnections.

GTaskConnection * gtask_connection_group_get_connection_by_name (GTaskConnectionGroup *group, const gchar *conn_name)
 Searches through the GTaskConnectionGroup's internal list and returns the GTaskConnection whose name matches the passed in name.


Variables

gpointer parent_class = NULL

Define Documentation

#define GTASK_CONNECTION_GROUP (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_CAST( (obj), \
                                                GTASK_CONNECTION_GROUP_TYPE, \
                                                GTaskConnectionGroup ))
casts the passed in object to a GTaskConnectionGroup

Definition at line 21 of file gtask-connection-group.h.

#define GTASK_CONNECTION_GROUP_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_CAST( (klass), \
                                                GTASK_CONNECTION_GROUP_TYPE, \
                                                GTaskConnectionGroupClass ))
casts the passed in object to a GTaskConnectionGroupClass

Definition at line 26 of file gtask-connection-group.h.

#define GTASK_CONNECTION_GROUP_GET_CLASS (  obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_CLASS( (obj), \
                                                GTASK_CONNECTION_GROUP_TYPE, \
                                                GTaskConnectionGroupClass ))

Definition at line 44 of file gtask-connection-group.h.

#define GTASK_CONNECTION_GROUP_TYPE   (gtask_connection_group_get_type())
 

returns the GType of GTaskConnectionGroup

Definition at line 18 of file gtask-connection-group.h.

#define GTASK_IS_CONNECTION_GROUP (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_TYPE( (obj), \
                                                GTASK_CONNECTION_GROUP_TYPE ))
returns TRUE if the passed in object is a GTaskConnectionGroup, FALSE otherwise

Definition at line 34 of file gtask-connection-group.h.

#define GTASK_IS_CONNECTION_GROUP_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_TYPE( (klass), \
                                                GTASK_CONNECTION_GROUP_TYPE ))
returns TRUE if the passed in object is a GTaskConnectionGroupClass, FALSE otherwise

Definition at line 41 of file gtask-connection-group.h.

Typedef Documentation

typedef struct _GTaskConnectionGroup GTaskConnectionGroup
 

Definition at line 13 of file gtask-connection-group.h.

typedef struct _GTaskConnectionGroupClass GTaskConnectionGroupClass
 

Definition at line 15 of file gtask-connection-group.h.

typedef struct _GTaskConnectionGroupPrivate GTaskConnectionGroupPrivate
 

Definition at line 14 of file gtask-connection-group.h.

Function Documentation

void gtask_connection_group_add_connection (  GTaskConnectionGroup *  group,
GTaskConnection *  conn
) 
 

Adds in the passed in GTaskConnection to the GTaskConnectionGroup.

Attention:
The passed in GTaskConnection will have its reference count increased by one.
Author:
Michael Henson
Parameters:
group a GTaskConnectionGroup
conn a GTaskConnection to add to the group

Todo:
should check and see if the passed in connection is already in the group

Definition at line 140 of file gtask-connection-group.c.

void gtask_connection_group_class_init (  GTaskConnectionGroupClass *  klass  )  [static]
 

Definition at line 58 of file gtask-connection-group.c.

void gtask_connection_group_clear (  GTaskConnectionGroup *  group  ) 
 

Removes all GTaskConnections from the passed in GTaskConnectionGroup.

Author:
Michael Henson
Parameters:
group a GTaskConnectionGroup

Definition at line 164 of file gtask-connection-group.c.

void gtask_connection_group_dispose (  GObject *  obj  )  [static]
 

Definition at line 85 of file gtask-connection-group.c.

void gtask_connection_group_finalize (  GObject *  obj  )  [static]
 

Definition at line 102 of file gtask-connection-group.c.

GTaskConnection * gtask_connection_group_get_connection_by_name (  GTaskConnectionGroup *  group,
const gchar *  conn_name
) 
 

Searches through the GTaskConnectionGroup's internal list and returns the GTaskConnection whose name matches the passed in name.

Parameters:
group A GTaskConnectionGroup
conn_name the name of the connection to return
Returns:
the GTaskConnection or NULL of no such connection with the passed in name was found.

Definition at line 209 of file gtask-connection-group.c.

GSList * gtask_connection_group_get_list (  GTaskConnectionGroup *  group  ) 
 

Returns the internal GSList that holds all of the GTaskConnections.

Author:
Michael Henson
Parameters:
group a GTaskConnectionGroup
Returns:
a GSList if there are connections in the group, NULL otherwise. The returned list should be considered read only in nature.

Definition at line 192 of file gtask-connection-group.c.

GType gtask_connection_group_get_type (  void   ) 
 

registers the GTaskConnectionGroup object with the GObject system if that has yet to be done and then returns the GType for GTaskConnectionGroup

Author:
Michael Henson
Returns:
the GType object for GTaskConnectionGroup

Definition at line 32 of file gtask-connection-group.c.

void gtask_connection_group_init (  GTaskConnectionGroup *  group,
gpointer  g_class
)  [static]
 

initializes a GTaskConnectionGroup

Author:
Michael Henson

Definition at line 73 of file gtask-connection-group.c.

GTaskConnectionGroup * gtask_connection_group_new (  void   ) 
 

creates a new GTaskConnectionGroup

Author:
Michael Henson
Returns:
the new GTaskConnectionGroup

Definition at line 121 of file gtask-connection-group.c.

Variable Documentation

gpointer parent_class = NULL [static]
 

Definition at line 9 of file gtask-connection-group.c.

Generated on Mon Feb 2 21:26:17 2004 for libgtask by doxygen 1.3.4