Default page

Edit File: howto-gobject-destruction.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Object destruction: GObject Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GObject Reference Manual">
<link rel="up" href="howto-gobject.html" title="How to define and implement a new GObject">
<link rel="prev" href="howto-gobject-construction.html" title="Object construction">
<link rel="next" href="howto-gobject-methods.html" title="Object methods">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="howto-gobject.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="howto-gobject-construction.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="howto-gobject-methods.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="howto-gobject-destruction"></a>Object destruction</h2></div></div></div>

 Again, it is often difficult to figure out which mechanism to use to
 hook into the object's destruction process: when the last
 <code class="function"><a class="link" href="gobject-The-Base-Object-Type.html#g-object-unref" title="g_object_unref ()">g_object_unref</a></code>
 function call is made, a lot of things happen as described in
 <a class="xref" href="gobject-memory.html#gobject-destruction-table" title="Table 5. g_object_unref">Table 5, “g_object_unref”</a>.
 

 The destruction process of your object is in two phases: dispose and
 finalize. This split is necessary to handle
 potential cycles due to the nature of the reference counting mechanism
 used by GObject, as well as dealing with temporary revival of
 instances in case of signal emission during the destruction sequence.
 See <a class="xref" href="gobject-memory.html#gobject-memory-cycles" title="Reference counts and cycles">the section called “Reference counts and cycles”</a> for more information.

<div class="informalexample">
 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 <tbody>
 <tr>
 <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64</pre></td>
 <td class="listing_code"><pre class="programlisting">struct _ViewerFilePrivate
{
 gchar *filename;
 guint zoom_level;

GInputStream *input_stream;
};

G_DEFINE_TYPE_WITH_PRIVATE (ViewerFile, viewer_file, G_TYPE_OBJECT)

static void
viewer_file_dispose (GObject *gobject)
{
 ViewerFilePrivate *priv = viewer_file_get_instance_private (VIEWER_FILE (gobject));

/* In dispose(), you are supposed to free all types referenced from this
 * object which might themselves hold a reference to self. Generally,
 * the most simple solution is to unref all members on which you own a 
 * reference.
 */

/* dispose() might be called multiple times, so we must guard against
 * calling g_object_unref() on an invalid GObject by setting the member
 * NULL; g_clear_object() does this for us.
 */
 g_clear_object (&priv->input_stream);

/* Always chain up to the parent class; there is no need to check if
 * the parent class implements the dispose() virtual function: it is
 * always guaranteed to do so
 */
 G_OBJECT_CLASS (viewer_file_parent_class)->dispose (gobject);
}

static void
viewer_file_finalize (GObject *gobject)
{
 ViewerFilePrivate *priv = viewer_file_get_instance_private (VIEWER_FILE (gobject));

g_free (priv->filename);

/* Always chain up to the parent class; as with dispose(), finalize()
 * is guaranteed to exist on the parent's class virtual function table
 */
 G_OBJECT_CLASS (viewer_file_parent_class)->finalize (gobject);
}

static void
viewer_file_class_init (ViewerFileClass *klass)
{
 GObjectClass *object_class = G_OBJECT_CLASS (klass);

object_class->dispose = viewer_file_dispose;
 object_class->finalize = viewer_file_finalize;
}

static void
viewer_file_init (ViewerFile *self);
{
 ViewerFilePrivate *priv = viewer_file_get_instance_private (self);

priv->input_stream = g_object_new (VIEWER_TYPE_INPUT_STREAM, NULL);
 priv->filename = /* would be set as a property */;
}</pre></td>
 </tr>
 </tbody>
 </table>
</div>

It is possible that object methods might be invoked after dispose is
 run and before finalize runs. GObject does not consider this to be a
 program error: you must gracefully detect this and neither crash nor
 warn the user, by having a disposed instance revert to an inert state.
 
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>