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

GTaskRolePacket


Data Structures

struct  _GTaskRolePacket
struct  _GTaskRolePacketClass
struct  _GTaskRolePacketPrivate

Defines

#define GTASK_ROLE_PACKET_TYPE   (gtask_role_packet_get_type())
#define GTASK_ROLE_PACKET(obj)
#define GTASK_ROLE_PACKET_CLASS(klass)
#define GTASK_IS_ROLE_PACKET(obj)
#define GTASK_IS_ROLE_PACKET_CLASS(klass)
#define GTASK_ROLE_PACKET_GET_CLASS(obj)
#define GTASK_ROLE_TYPE   (gtask_role_get_type())

Typedefs

typedef _GTaskRolePacket GTaskRolePacket
typedef _GTaskRolePacketPrivate GTaskRolePacketPrivate
typedef _GTaskRolePacketClass GTaskRolePacketClass

Enumerations

enum  GTaskRole { GTASK_ROLE_NONE, GTASK_ROLE_PROXY, GTASK_ROLE_REPORTER, GTASK_ROLE_PROVIDER }

Functions

void gtask_role_packet_class_init (GTaskRolePacketClass *klass)
void gtask_role_packet_init (GTaskRolePacket *packet, gpointer g_class)
void gtask_role_packet_finalize (GObject *obj)
gboolean gtask_role_packet_serialize_to (GTaskPacket *packet, GTaskConnection *conn)
 writes out the xml form of the passed in GTaskRolePacket to the passed in GTaskConnection. In general this function should never be called, except from within the library. To serialize any packet call gtask_packet_serialize( GTaskPacket * ) instead.

GType gtask_activity_state_get_type ()
GType gtask_role_packet_get_type (void)
GTaskRolePacket * gtask_role_packet_new (void)
 creates a new GTaskRolePacket with a role set to NO_ROLE

GTaskRolePacket * gtask_role_packet_new_with_role (GTaskRole role)
 creates a new GTaskRolePacket with the passed in role

GTaskRole gtask_role_packet_get_role (GTaskRolePacket *packet)
 returns the role of passed in GTaskRolePacket

void gtask_role_packet_set_role (GTaskRolePacket *packet, GTaskRole role)
 sets the role of the passed in GTaskRolePacket

void gtask_role_packet_set_role_from_name (GTaskRolePacket *packet, const char *name)
 sets the role of the passed in GTaskRolePacket based upon the passed in character string

const char * gtask_role_packet_get_role_name (GTaskRolePacket *packet)
 returns the string representation of the role

GTaskRole gtask_role_from_name (const char *name)
 attempts to determine the role from the passed in string. Unrecognized roles default to NO_ROLE

const char * gtask_role_name (GTaskRole role)
 returns the string representation of the passed in role

GType gtask_role_get_type (void)

Variables

gpointer parent_class = NULL

Define Documentation

#define GTASK_IS_ROLE_PACKET (  obj   ) 
 

Value:

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

Definition at line 32 of file gtask-role-packet.h.

#define GTASK_IS_ROLE_PACKET_CLASS (  klass   ) 
 

Value:

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

Definition at line 39 of file gtask-role-packet.h.

#define GTASK_ROLE_PACKET (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_CAST( (obj), \
                                           GTASK_ROLE_PACKET_TYPE, \
                                           GTaskRolePacket ))
casts the passed in object to a GTaskRolePacket

Definition at line 19 of file gtask-role-packet.h.

#define GTASK_ROLE_PACKET_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_CAST( (klass), \
                                           GTASK_ROLE_PACKET_TYPE, \
                                           GTaskRolePacketClass ))
casts the passed in object to a GTaskRolePacketClass

Definition at line 24 of file gtask-role-packet.h.

#define GTASK_ROLE_PACKET_GET_CLASS (  obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_CLASS( (obj), \
                                           GTASK_ROLE_PACKET_TYPE, \
                                           GTaskRolePacketClass ))

Definition at line 42 of file gtask-role-packet.h.

#define GTASK_ROLE_PACKET_TYPE   (gtask_role_packet_get_type())
 

returns the GType of GTaskRolePacket

Definition at line 16 of file gtask-role-packet.h.

#define GTASK_ROLE_TYPE   (gtask_role_get_type())
 

Definition at line 53 of file gtask-role-packet.h.

Typedef Documentation

typedef struct _GTaskRolePacket GTaskRolePacket
 

Definition at line 10 of file gtask-role-packet.h.

typedef struct _GTaskRolePacketClass GTaskRolePacketClass
 

Definition at line 12 of file gtask-role-packet.h.

typedef struct _GTaskRolePacketPrivate GTaskRolePacketPrivate
 

Definition at line 11 of file gtask-role-packet.h.

Enumeration Type Documentation

enum GTaskRole
 

Enumeration values:
GTASK_ROLE_NONE  no role has been specified
GTASK_ROLE_PROXY  the proxy role -- callbacks, etc are sent back to another gtask server for exectution
GTASK_ROLE_REPORTER  the reporter role -- the ui displaying tasks
GTASK_ROLE_PROVIDER  the provider role -- the program creating tasks

Definition at line 46 of file gtask-role-packet.h.

Function Documentation

GType gtask_activity_state_get_type (  void   ) 
 

Definition at line 37 of file gtask-role-packet.c.

GTaskRole gtask_role_from_name (  const char *  name  ) 
 

attempts to determine the role from the passed in string. Unrecognized roles default to NO_ROLE

Author:
Michael Henson
Parameters:
name the string to look at
Returns:
a GTaskRole

Definition at line 290 of file gtask-role-packet.c.

GType gtask_role_get_type (  void   ) 
 

Definition at line 56 of file gtask-connection.c.

const char * gtask_role_name (  GTaskRole  role  ) 
 

returns the string representation of the passed in role

Author:
Michael Henson
Parameters:
role a GTaskRole
Returns:
the role

Definition at line 314 of file gtask-role-packet.c.

void gtask_role_packet_class_init (  GTaskRolePacketClass *  klass  )  [static]
 

Definition at line 82 of file gtask-role-packet.c.

void gtask_role_packet_finalize (  GObject *  obj  )  [static]
 

Definition at line 105 of file gtask-role-packet.c.

GTaskRole gtask_role_packet_get_role (  GTaskRolePacket *  packet  ) 
 

returns the role of passed in GTaskRolePacket

Author:
Michael Henson
Parameters:
packet a GTaskRolePacket
Returns:
a GTaskRole

Definition at line 220 of file gtask-role-packet.c.

const char * gtask_role_packet_get_role_name (  GTaskRolePacket *  packet  ) 
 

returns the string representation of the role

Author:
Michael Henson
Parameters:
packet a GTaskRolePacket
Returns:
the role

Definition at line 273 of file gtask-role-packet.c.

GType gtask_role_packet_get_type (  void   ) 
 

Definition at line 56 of file gtask-role-packet.c.

void gtask_role_packet_init (  GTaskRolePacket *  packet,
gpointer  g_class
)  [static]
 

Definition at line 98 of file gtask-role-packet.c.

GTaskRolePacket * gtask_role_packet_new (  void   ) 
 

creates a new GTaskRolePacket with a role set to NO_ROLE

Author:
Michael Henson
Returns:
the new GTaskRolePacket

Definition at line 186 of file gtask-role-packet.c.

GTaskRolePacket * gtask_role_packet_new_with_role (  GTaskRole  role  ) 
 

creates a new GTaskRolePacket with the passed in role

Author:
Michael Henson
Parameters:
role a GTaskRole
Returns:
the new GTaskRolePacket

Definition at line 202 of file gtask-role-packet.c.

gboolean gtask_role_packet_serialize_to (  GTaskPacket *  packet,
GTaskConnection *  conn
)  [static]
 

writes out the xml form of the passed in GTaskRolePacket to the passed in GTaskConnection. In general this function should never be called, except from within the library. To serialize any packet call gtask_packet_serialize( GTaskPacket * ) instead.

Author:
Michael Henson
Parameters:
packet a GTaskRolePacket
conn the connection to serialize to
Returns:
the success/failure of the operation

Definition at line 129 of file gtask-role-packet.c.

void gtask_role_packet_set_role (  GTaskRolePacket *  packet,
GTaskRole  role
) 
 

sets the role of the passed in GTaskRolePacket

Author:
Michael Henson
Parameters:
packet a GTaskRolePacket
role a GTaskRole

Definition at line 235 of file gtask-role-packet.c.

void gtask_role_packet_set_role_from_name (  GTaskRolePacket *  packet,
const char *  name
) 
 

sets the role of the passed in GTaskRolePacket based upon the passed in character string

Author:
Michael Henson
Parameters:
packet a GTaskRolePacket
name a string identifier for a role

Todo:
in the future gtask_role_packet_set_role_from_name should skip leading and trailing white spaces

Definition at line 254 of file gtask-role-packet.c.

Variable Documentation

gpointer parent_class = NULL [static]
 

Definition at line 8 of file gtask-role-packet.c.

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