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

GTaskErrorPacket


Data Structures

struct  _GTaskErrorPacket
struct  _GTaskErrorPacketClass
struct  _GTaskErrorPacketPrivate

Defines

#define GTASK_ERROR_PACKET_TYPE   (gtask_error_packet_get_type())
#define GTASK_ERROR_PACKET(obj)
#define GTASK_ERROR_PACKET_CLASS(klass)
#define GTASK_IS_ERROR_PACKET(obj)
#define GTASK_IS_ERROR_PACKET_CLASS(klass)
#define GTASK_ERROR_PACKET_GET_CLASS(obj)

Typedefs

typedef _GTaskErrorPacket GTaskErrorPacket
typedef _GTaskErrorPacketPrivate GTaskErrorPacketPrivate
typedef _GTaskErrorPacketClass GTaskErrorPacketClass

Enumerations

enum  GTaskErrorType { GTASK_ERROR_NONE, GTASK_ERROR_UNDEFINED }

Functions

void gtask_error_packet_class_init (GTaskErrorPacketClass *klass)
void gtask_error_packet_init (GTaskErrorPacket *packet, gpointer g_class)
void gtask_error_packet_finalize (GObject *obj)
gboolean gtask_error_packet_serialize_to (GTaskPacket *packet, GTaskConnection *conn)
 writes out the xml form of the passed in GTaskErrorPacket 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_error_packet_get_type (void)
GTaskErrorPacketgtask_error_packet_new ()
 creates a new GTaskErrorPacket

GTaskErrorType gtask_error_packet_get_error_type (GTaskErrorPacket *packet)
 returns the error type of the passed in GTaskErrorPacket

void gtask_error_packet_set_error_type (GTaskErrorPacket *packet, GTaskErrorType error)
 sets the error type of the passed in GTaskErrorPacket

const char * gtask_error_packet_get_error_message (GTaskErrorPacket *packet)
 returns a readable error message for the type of error

void gtask_error_packet_set_error_message (GTaskErrorPacket *packet, const char *error_msg)
 sets the readable error message for the type of error


Variables

gpointer parent_class

Define Documentation

#define GTASK_ERROR_PACKET obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_CAST( (obj), \
                                            GTASK_ERROR_PACKET_TYPE, \
                                            GTaskErrorPacket ))
casts the passed in object to a GTaskErrorPacket

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

#define GTASK_ERROR_PACKET_CLASS klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_CAST( (klass), \
                                            GTASK_ERROR_PACKET_TYPE, \
                                            GTaskErrorPacketClass ))
casts the passed in object to a GTaskErrorPacketClass

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

#define GTASK_ERROR_PACKET_GET_CLASS obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_CLASS( (obj), \
                                            GTASK_ERROR_PACKET_TYPE, \
                                            GTaskErrorPacketClass ))

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

#define GTASK_ERROR_PACKET_TYPE   (gtask_error_packet_get_type())
 

returns the GType of GTaskErrorPacket

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

#define GTASK_IS_ERROR_PACKET obj   ) 
 

Value:

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

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

#define GTASK_IS_ERROR_PACKET_CLASS klass   ) 
 

Value:

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

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


Typedef Documentation

typedef struct _GTaskErrorPacket GTaskErrorPacket
 

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

typedef struct _GTaskErrorPacketClass GTaskErrorPacketClass
 

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

typedef struct _GTaskErrorPacketPrivate GTaskErrorPacketPrivate
 

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


Enumeration Type Documentation

enum GTaskErrorType
 

Enumeration values:
GTASK_ERROR_NONE 
GTASK_ERROR_UNDEFINED 

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


Function Documentation

void gtask_error_packet_class_init GTaskErrorPacketClass klass  )  [static]
 

Definition at line 48 of file gtask-error-packet.c.

void gtask_error_packet_finalize GObject *  obj  )  [static]
 

Definition at line 70 of file gtask-error-packet.c.

const char * gtask_error_packet_get_error_message GTaskErrorPacket packet  ) 
 

returns a readable error message for the type of error

Author:
Michael Henson
Parameters:
packet a GTaskErrorPacket
Returns:
the error string

Definition at line 199 of file gtask-error-packet.c.

GTaskErrorType gtask_error_packet_get_error_type GTaskErrorPacket packet  ) 
 

returns the error type of the passed in GTaskErrorPacket

Author:
Michael Henson
Parameters:
packet a GTaskErrorPacket
Returns:
the GTaskErrorType of the packet

Definition at line 166 of file gtask-error-packet.c.

GType gtask_error_packet_get_type void   ) 
 

Definition at line 22 of file gtask-error-packet.c.

void gtask_error_packet_init GTaskErrorPacket packet,
gpointer  g_class
[static]
 

Definition at line 60 of file gtask-error-packet.c.

GTaskErrorPacket * gtask_error_packet_new void   ) 
 

creates a new GTaskErrorPacket

Author:
Michael Henson
Returns:
the new GTaskErrorPacket

Definition at line 152 of file gtask-error-packet.c.

gboolean gtask_error_packet_serialize_to GTaskPacket packet,
GTaskConnection conn
[static]
 

writes out the xml form of the passed in GTaskErrorPacket 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 GTaskErrorPacket
conn the connection to serialize to
Returns:
the success/failure of the operation

Definition at line 97 of file gtask-error-packet.c.

void gtask_error_packet_set_error_message GTaskErrorPacket packet,
const char *  error_msg
 

sets the readable error message for the type of error

Author:
Michael Henson
Parameters:
packet a GTaskErrorPacket
error_msg the error message
Todo:
we may want to check to see if at some point and time a stupidly large buffer was allocated and is no longer needed and free up some memory

Definition at line 214 of file gtask-error-packet.c.

void gtask_error_packet_set_error_type GTaskErrorPacket packet,
GTaskErrorType  error
 

sets the error type of the passed in GTaskErrorPacket

Author:
Michael Henson
Parameters:
packet a GTaskErrorPacket
error a GTaskErrorType

Definition at line 181 of file gtask-error-packet.c.


Variable Documentation

gpointer parent_class [static]
 

Definition at line 7 of file gtask-error-packet.c.


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